Merge pull request #2313 from buildkite/pdp-1496-update-agent-help-with-feedback-from-docs-for-v3510

Author: triarius

clicommand/agent_start.go

@@ -599,7 +599,7 @@ var AgentStartCommand = cli.Command{
 		},
 		cli.StringFlag{
 			Name:   "job-signing-algorithm",
-			Usage:  "The algorithm to use when signing pipelines. Must be a valid RF7518 JWA algorithm. Required when using a JWKS, and the given key doesn't have an alg parameter",
+			Usage:  "The algorithm to use when signing pipelines. Must be an algorithm specified in RFC 7518: JWA. Required when using a JWKS, and the given key doesn't have an alg parameter",
 			EnvVar: "BUILDKITE_PIPELINE_UPLOAD_SIGNING_ALGORITHM",
 		},
 		cli.StringFlag{

clicommand/cancel_signal.go

@@ -29,7 +29,7 @@ var (
 	signalGracePeriodSecondsFlag = cli.IntFlag{
 		Name: "signal-grace-period-seconds",
 		Usage: "The number of seconds given to a subprocess to handle being sent ′cancel-signal′. " +
-			"After this period has elaspsed, SIGKILL will be sent.",
+			"After this period has elapsed, SIGKILL will be sent.",
 		EnvVar: "BUILDKITE_SIGNAL_GRACE_PERIOD_SECONDS",
 		Value:  defaultSignalGracePeriod,
 	}

clicommand/env_unset.go

@@ -26,7 +26,7 @@ Description:
 
 Examples:
 
-   Unsetting the variables ′LLAMA′ and ′ALPACA′)
+   Unsetting the variables ′LLAMA′ and ′ALPACA′:
 
    $ buildkite-agent env unset LLAMA ALPACA
    Unset:

clicommand/lock_acquire.go

@@ -54,7 +54,7 @@ func lockAcquireFlags() []cli.Flag {
 		[]cli.Flag{
 			cli.DurationFlag{
 				Name:   "lock-wait-timeout",
-				Usage:  "If specified, sets a maximum duration to wait for a lock before giving up",
+				Usage:  "Sets a maximum duration to wait for a lock before giving up",
 				EnvVar: "BUILDKITE_LOCK_WAIT_TIMEOUT",
 			},
 		},

clicommand/lock_do.go

@@ -33,12 +33,10 @@ Description:
 Examples:
 
    #!/bin/bash
-   if [ $(buildkite-agent lock do llama) = 'do' ] ; then
-      setup_code()
-      buildkite-agent lock done llama
-   fi
-
-`
+   if [[ $(buildkite-agent lock do llama) == 'do' ]]; then
+     # your critical section here...
+     buildkite-agent lock done llama
+   fi`
 
 type LockDoConfig struct {
 	// Common config options

clicommand/lock_done.go

@@ -11,7 +11,7 @@ import (
 
 const lockDoneHelpDescription = `Usage:
 
-   buildkite-agent lock release [key]
+   buildkite-agent lock done [key]
 
 Description:
    Completes a do-once lock. This should only be used by the process performing
@@ -23,12 +23,10 @@ Description:
 Examples:
 
    #!/bin/bash
-   if [ $(buildkite-agent lock do llama) = 'do' ] ; then
-	  setup_code()
-	  buildkite-agent lock done llama
-   fi
-
-`
+   if [[ $(buildkite-agent lock do llama) == 'do' ]]; then
+     # your critical section here...
+     buildkite-agent lock done llama
+   fi`
 
 type LockDoneConfig struct {
 	// Common config options

clicommand/lock_get.go

@@ -27,9 +27,7 @@ Description:
 Examples:
 
    $ buildkite-agent lock get llama
-   Kuzco
-
-`
+   Kuzco`
 
 type LockGetConfig struct {
 	// Common config options

clicommand/lock_release.go

@@ -24,11 +24,10 @@ Description:
 
 Examples:
 
-   $ token=$(buildkite-agent lock acquire llama)
-   $ critical_section()
-   $ buildkite-agent lock release llama "${token}"
-
-`
+   #!/bin/bash
+   token=$(buildkite-agent lock acquire llama)
+   # your critical section here...
+   buildkite-agent lock release llama "${token}"`
 
 type LockReleaseConfig struct {
 	// Common config options