Skip to content

Commit d30e0ef

Browse files
committed
chore(template-build): trim narrating comments
1 parent ec711da commit d30e0ef

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

packages/orchestrator/cmd/create-build/main.go

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ func main() {
101101
log.Fatalf("network config: %v", err)
102102
}
103103

104-
// Detect if --free-page-reporting was explicitly set; if not, pass nil so
105-
// doBuild can default based on the Firecracker version.
104+
// nil = no explicit --free-page-reporting flag; doBuild then defaults
105+
// based on the Firecracker version.
106106
var fprOverride *bool
107107
flag.Visit(func(f *flag.Flag) {
108108
if f.Name == "free-page-reporting" {
@@ -341,18 +341,16 @@ func doBuild(
341341

342342
force := true
343343

344-
// Build steps list for setup commands
345344
var steps []*templatemanager.TemplateStep
346345
if setupCmd != "" {
347346
fmt.Printf("Setup command (as root): %s\n", setupCmd)
348-
// Add a RUN step that executes as root
349347
steps = append(steps, &templatemanager.TemplateStep{
350348
Type: "RUN",
351-
Args: []string{setupCmd, "root"}, // command, user
349+
Args: []string{setupCmd, "root"},
352350
})
353351
}
354352

355-
// Default FPR to enabled when the FC version supports it (v1.14+); explicit flag overrides.
353+
// Default FPR on for FC v1.14+; explicit --free-page-reporting overrides.
356354
var fprEnabled bool
357355
if freePageReporting != nil {
358356
fprEnabled = *freePageReporting

packages/orchestrator/pkg/template/build/config/config.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ type TemplateConfig struct {
4141
// HugePages sets whether the VM use huge pages.
4242
HugePages bool
4343

44-
// FreePageReporting enables the corresponding feature in Firecracker
44+
// FreePageReporting enables Firecracker's balloon free-page-reporting,
45+
// which madvise(MADV_DONTNEED)s freed guest pages back to the host.
4546
FreePageReporting bool
4647

4748
// Command to run to check if the template is ready.

0 commit comments

Comments
 (0)