add comment for the use of flags

sreya · sreya · commit 7235bfb54e55 · 2024-11-20T22:19:59.000Z
diff --git a/agent/agentexec/exec.go b/agent/agentexec/exec.go
@@ -69,15 +69,18 @@ func envValInt(key string) (int, bool) {
 	return i, true
 }
 
+// The following are flags used by the agent-exec command. We use flags instead of
+// environment variables to avoid having to deal with a caller overriding the
+// environment variables.
 const (
-	niceArg = "coder-nice"
-	oomArg  = "coder-oom"
+	niceFlag = "coder-nice"
+	oomFlag  = "coder-oom"
 )
 
 func niceScoreArg(score int) string {
-	return fmt.Sprintf("--%s=%d", niceArg, score)
+	return fmt.Sprintf("--%s=%d", niceFlag, score)
 }
 
 func oomScoreArg(score int) string {
-	return fmt.Sprintf("--%s=%d", oomArg, score)
+	return fmt.Sprintf("--%s=%d", oomFlag, score)
 }

Original file line number	Diff line number	Diff line change
`@@ -69,15 +69,18 @@ func envValInt(key string) (int, bool) {`
`69`	`69`	`return i, true`
`70`	`70`	`}`
`71`	`71`
	`72`	`+// The following are flags used by the agent-exec command. We use flags instead of`
	`73`	`+// environment variables to avoid having to deal with a caller overriding the`
	`74`	`+// environment variables.`
`72`	`75`	`const (`
`73`		`- niceArg = "coder-nice"`
`74`		`- oomArg = "coder-oom"`
	`76`	`+ niceFlag = "coder-nice"`
	`77`	`+ oomFlag = "coder-oom"`
`75`	`78`	`)`
`76`	`79`
`77`	`80`	`func niceScoreArg(score int) string {`
`78`		`- return fmt.Sprintf("--%s=%d", niceArg, score)`
	`81`	`+ return fmt.Sprintf("--%s=%d", niceFlag, score)`
`79`	`82`	`}`
`80`	`83`
`81`	`84`	`func oomScoreArg(score int) string {`
`82`		`- return fmt.Sprintf("--%s=%d", oomArg, score)`
	`85`	`+ return fmt.Sprintf("--%s=%d", oomFlag, score)`
`83`	`86`	`}`