Skip to content

Commit 45eb90f

Browse files
authored
Clarify CLI options (#4698)
1 parent c8dc009 commit 45eb90f

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

internal/flag/flag.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,7 @@ func Yes() Bool {
351351
return Bool{
352352
Name: flagnames.Yes,
353353
Shorthand: "y",
354-
Description: "Accept all confirmations",
354+
Description: "Accept all confirmations (also --auto-confirm)",
355355
Aliases: []string{"auto-confirm"},
356356
}
357357
}
@@ -444,7 +444,7 @@ const httpsFailover = "https-failover"
444444
func HttpsFailover() Bool {
445445
return Bool{
446446
Name: httpsFailover,
447-
Description: "Determines whether to failover to plain internet(https) communication with remote builders if wireguard fails",
447+
Description: "Determines whether to failover to plain internet(https) communication with remote builders if wireguard fails (also --http-failover)",
448448
Aliases: []string{"http-failover"},
449449
Default: true,
450450
}
@@ -644,7 +644,7 @@ func JSONOutput() Bool {
644644

645645
func ProcessGroup(desc string) String {
646646
if desc == "" {
647-
desc = "The target process group"
647+
desc = "The target process group (also --group)"
648648
}
649649

650650
return String{

internal/flag/machines.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,17 +121,17 @@ var VMSizeFlags = Set{
121121
},
122122
Int{
123123
Name: "vm-cpus",
124-
Description: "Number of CPUs",
124+
Description: "Number of CPUs (also --cpus)",
125125
Aliases: []string{"cpus"},
126126
},
127127
String{
128128
Name: "vm-cpu-kind",
129-
Description: "The kind of CPU to use ('shared' or 'performance')",
129+
Description: "The kind of CPU to use ('shared' or 'performance') (also --vm-cpukind)",
130130
Aliases: []string{"vm-cpukind"},
131131
},
132132
String{
133133
Name: "vm-memory",
134-
Description: "Memory (in megabytes) to attribute to the VM",
134+
Description: "Memory (in megabytes) to attribute to the VM (also --memory)",
135135
Aliases: []string{"memory"},
136136
},
137137
String{
@@ -145,7 +145,7 @@ var VMSizeFlags = Set{
145145
},
146146
String{
147147
Name: "vm-gpu-kind",
148-
Description: fmt.Sprintf("If set, the GPU model to attach (%v)", strings.Join(validGPUKinds, ", ")),
148+
Description: fmt.Sprintf("If set, the GPU model to attach (%v) (also --vm-gpukind)", strings.Join(validGPUKinds, ", ")),
149149
Aliases: []string{"vm-gpukind"},
150150
},
151151
String{

0 commit comments

Comments
 (0)