cmd/gomote: add help text to create explaining the builder name
Also, throw in some details about the environment the user will be
dropped into.
Change-Id: I58f0f6b188d2bffd615b87c001496592d6a82d75
Reviewed-on: https://go-review.googlesource.com/c/build/+/615957
Auto-Submit: Michael Knyszek <mknyszek@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Austin Clements <austin@google.com>
diff --git a/cmd/gomote/create.go b/cmd/gomote/create.go
index bc56883..7adf377 100644
--- a/cmd/gomote/create.go
+++ b/cmd/gomote/create.go
@@ -96,16 +96,35 @@
fs.Usage = func() {
log := usageLogger
log.Print("create usage: gomote create [create-opts] <type>")
- fmt.Fprintln(os.Stderr)
+ log.Print()
log.Print("If there's a valid group specified, new instances are")
log.Print("automatically added to the group. If the group in")
log.Print("$GOMOTE_GROUP doesn't exist, and there's no other group")
log.Print("specified, it will be created and new instances will be")
log.Print("added to that group.")
- fmt.Fprintln(os.Stderr)
+ log.Print()
log.Print("Run 'gomote create -list' to see a list of valid builder")
log.Print("types.")
- fmt.Fprintln(os.Stderr)
+ log.Print()
+ log.Print("Builder types are structured according to the following")
+ log.Print("format, where the bracketed parts are optional:")
+ log.Print()
+ log.Print(" [<subrepo>-]<go branch>-<goos>-<goarch>[_<host>][-<mods>*]")
+ log.Print()
+ log.Print("Subrepo names always start with 'x_'. Go branch names are")
+ log.Print("either 'gotip' or 'go<version>' like 'go1.23'. goos and goarch")
+ log.Print("are the same as the values you'd use in build tags and all")
+ log.Print("lower-case. The host suffix is optional and you likely do not")
+ log.Print("need to specify it, but see the full list for what's available.")
+ log.Print("It's usually just an indicator of the OS version, like '13' to")
+ log.Print("indicate macOS 13 for darwin/amd64 builders. Mods are specifiers")
+ log.Print("like 'race' and 'longtest'.")
+ log.Print()
+ log.Print("gomotes are set up with the same code used to set up the")
+ log.Print("environment on the builder except without a Go toolchain.")
+ log.Print("Subrepo gomotes set up a copy of the subrepo in the workdir,")
+ log.Print("a full git checkout sync'd to tip-of-tree.")
+ log.Print()
log.Print("Flags:")
fs.PrintDefaults()
if luciDisabled() {
