all: gofmt

Gofmt to update doc comments to the new formatting.

For golang/go#51082.

Change-Id: Ie063c2fd890641b551c0f304fee5fa19121f1b38
Reviewed-on: https://go-review.googlesource.com/c/build/+/399555
Run-TryBot: Russ Cox <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>
Auto-Submit: Russ Cox <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Dmitri Shuralyov <[email protected]>
Reviewed-by: Ian Lance Taylor <[email protected]>

Author: rsc

cmd/buildlet/buildlet.go

@@ -67,20 +67,21 @@ var (
 // package's client API (via the Status method).
 //
 // Notable versions:
-//    3: switched to revdial protocol
-//    5: reverse dialing uses timeouts+tcp keepalives, pargzip fix
-//    7: version bumps while debugging revdial hang (Issue 12816)
-//    8: mac screensaver disabled
-//   11: move from self-signed cert to LetsEncrypt (Issue 16442)
-//   15: ssh support
-//   16: make macstadium builders always haltEntireOS
-//   17: make macstadium halts use sudo
-//   18: set TMPDIR and GOCACHE
-//   21: GO_BUILDER_SET_GOPROXY=coordinator support
-//   22: TrimSpace the reverse buildlet's gobuildkey contents
-//   23: revdial v2
-//   24: removeAllIncludingReadonly
-//   25: use removeAllIncludingReadonly for all work area cleanup
+//
+//	 3: switched to revdial protocol
+//	 5: reverse dialing uses timeouts+tcp keepalives, pargzip fix
+//	 7: version bumps while debugging revdial hang (Issue 12816)
+//	 8: mac screensaver disabled
+//	11: move from self-signed cert to LetsEncrypt (Issue 16442)
+//	15: ssh support
+//	16: make macstadium builders always haltEntireOS
+//	17: make macstadium halts use sudo
+//	18: set TMPDIR and GOCACHE
+//	21: GO_BUILDER_SET_GOPROXY=coordinator support
+//	22: TrimSpace the reverse buildlet's gobuildkey contents
+//	23: revdial v2
+//	24: removeAllIncludingReadonly
+//	25: use removeAllIncludingReadonly for all work area cleanup
 const buildletVersion = 25
 
 func defaultListenAddr() string {

cmd/cl/cl.go

@@ -34,13 +34,13 @@ By default, CL omits closed CLs, those with an R=close reply
 and no subsequent upload of a new patch set.
 If the -closed flag is specified, CL adds closed CLs to the output.
 
-By default, CL omits CLs containing ``DO NOT REVIEW'' in the
+By default, CL omits CLs containing “DO NOT REVIEW” in the
 latest patch's commit message.
 If the -dnr flag is specified, CL includes those CLs in its output.
 
 If the -r flag is specified, CL shows only CLs that need review,
 not those waiting for the author. In this mode, the
-redundant ``waiting for reviewer'' asterisk is elided.
+redundant “waiting for reviewer” asterisk is elided.
 
 If the -url flag is specified, CL replaces "CL 1234" at the beginning
 of each output line with a full URL, "https://golang.org/cl/1234".

cmd/coordinator/buildstatus.go

@@ -1169,9 +1169,8 @@ func (st *buildStatus) runSubrepoTests() (remoteErr, err error) {
 // The logic of the go tool for ignoring directories is documented at
 // https://golang.org/cmd/go/#hdr-Package_lists_and_patterns:
 //
-// 	Directory and file names that begin with "." or "_" are ignored
-// 	by the go tool, as are directories named "testdata".
-//
+//	Directory and file names that begin with "." or "_" are ignored
+//	by the go tool, as are directories named "testdata".
 func ignoredByGoTool(importPath string) bool {
 	for _, el := range strings.Split(importPath, "/") {
 		if strings.HasPrefix(el, ".") || strings.HasPrefix(el, "_") || el == "testdata" {

cmd/coordinator/coordinator.go

@@ -150,8 +150,8 @@ var testFiles = map[string]string{
 
 // httpRouter is the coordinator's handler, routing traffic to one of
 // two locations:
-//   1) a buildlet, from gomote clients (if X-Buildlet-Proxy is set)
-//   2) traffic to the coordinator itself (the default)
+//  1. a buildlet, from gomote clients (if X-Buildlet-Proxy is set)
+//  2. traffic to the coordinator itself (the default)
 func httpRouter(next http.Handler) http.Handler {
 	return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if r.Header.Get("X-Buildlet-Proxy") != "" {
@@ -2025,9 +2025,10 @@ func randHex(n int) string {
 // import path, it always has forward slashes and no trailing slash.
 //
 // For example:
-//   "net"    -> "golang.org/x/net"
-//   "crypto" -> "golang.org/x/crypto"
-//   "dl"     -> "golang.org/dl"
+//
+//	"net"    -> "golang.org/x/net"
+//	"crypto" -> "golang.org/x/crypto"
+//	"dl"     -> "golang.org/dl"
 func importPathOfRepo(repo string) string {
 	r := repos.ByGerritProject[repo]
 	if r == nil {

cmd/coordinator/internal/legacydash/ui.go

@@ -441,7 +441,8 @@ func cleanTitle(title, viewBranch string) string {
 
 // failuresView renders https://build.golang.org/?mode=failures, where it outputs
 // one line per failure on the front page, in the form:
-//    hash builder failure-url
+//
+//	hash builder failure-url
 type failuresView struct{}
 
 func (failuresView) ShowsActiveBuilds() bool { return false }

cmd/coordinator/remote.go

@@ -774,13 +774,13 @@ func setWinsize(f *os.File, w, h int) {
 //
 // The instance name is of two forms. The normal form is:
 //
-//     user-bradfitz-linux-amd64-0
+//	user-bradfitz-linux-amd64-0
 //
 // The overloaded form to convey that the user accepts responsibility
 // for changes to the underlying host is to prefix the same instance
 // name with the string "mutable-", such as:
 //
-//     mutable-user-bradfitz-darwin-amd64-10_8-0
+//	mutable-user-bradfitz-darwin-amd64-10_8-0
 //
 // The mutable part is ignored by this function.
 func userFromGomoteInstanceName(name string) string {

cmd/coordinator/status.go

@@ -534,7 +534,6 @@ func reverseHostChecker(hosts []string) func(cw *checkWriter) {
 // and reports when the hourly quota has been exceeded.
 //
 // It also records metrics to track remaining rate limit over time.
-//
 func newGitHubAPIChecker(ctx context.Context, sc *secret.Client) *healthChecker {
 	// githubRate is the status of the GitHub API v3 client.
 	// It's of type *github.Rate; no value means no result yet,

cmd/debugnewvm/debugnewvm.go

@@ -225,7 +225,9 @@ func main() {
 }
 
 // watchSerial streams the named VM's serial port to log.Printf. It's roughly:
-//   gcloud compute connect-to-serial-port --zone=xxx $NAME
+//
+//	gcloud compute connect-to-serial-port --zone=xxx $NAME
+//
 // but in Go and works. For some reason, gcloud doesn't work as a
 // child process and has weird errors.
 // TODO(golang.org/issue/39485) - investigate if this is possible for EC2 instances

cmd/fetchlogs/fetchlogs.go

@@ -12,7 +12,7 @@
 // to be the SHA-1 of their contents). The rev/ directory contains
 // symlinks back to these logs named
 //
-//    rev/<ISO 8601 commit date>-<git revision>/<builder>
+//	rev/<ISO 8601 commit date>-<git revision>/<builder>
 //
 // Fetchlogs will reuse existing log files and revision symlinks, so
 // it only has to download logs that are new since the last time it
@@ -22,7 +22,7 @@
 // example, to list the revisions and builders with a particular
 // failure, use:
 //
-//    grep -lR <regexp> rev | sort
+//	grep -lR <regexp> rev | sort
 package main
 
 import (

cmd/gomote/gomote.go

@@ -10,68 +10,68 @@ See https://golang.org/wiki/Gomote
 
 Usage:
 
-  gomote [global-flags] cmd [cmd-flags]
+	gomote [global-flags] cmd [cmd-flags]
 
-  For example,
-  $ gomote create openbsd-amd64-60
-  user-username-openbsd-amd64-60-0
-  $ gomote push user-username-openbsd-amd64-60-0
-  $ gomote run user-username-openbsd-amd64-60-0 go/src/make.bash
-  $ gomote run user-username-openbsd-amd64-60-0 go/bin/go test -v -short os
+	For example,
+	$ gomote create openbsd-amd64-60
+	user-username-openbsd-amd64-60-0
+	$ gomote push user-username-openbsd-amd64-60-0
+	$ gomote run user-username-openbsd-amd64-60-0 go/src/make.bash
+	$ gomote run user-username-openbsd-amd64-60-0 go/bin/go test -v -short os
 
 To list the subcommands, run "gomote" without arguments:
 
-  Commands:
-
-    create     create a buildlet; with no args, list types of buildlets
-    destroy    destroy a buildlet
-    gettar     extract a tar.gz from a buildlet
-    list       list active buildlets
-    ls         list the contents of a directory on a buildlet
-    ping       test whether a buildlet is alive and reachable
-    push       sync your GOROOT directory to the buildlet
-    put        put files on a buildlet
-    put14      put Go 1.4 in place
-    puttar     extract a tar.gz to a buildlet
-    rm         delete files or directories
-    rdp        RDP (Remote Desktop Protocol) to a Windows buildlet
-    run        run a command on a buildlet
-    ssh        ssh to a buildlet
+	Commands:
+
+	  create     create a buildlet; with no args, list types of buildlets
+	  destroy    destroy a buildlet
+	  gettar     extract a tar.gz from a buildlet
+	  list       list active buildlets
+	  ls         list the contents of a directory on a buildlet
+	  ping       test whether a buildlet is alive and reachable
+	  push       sync your GOROOT directory to the buildlet
+	  put        put files on a buildlet
+	  put14      put Go 1.4 in place
+	  puttar     extract a tar.gz to a buildlet
+	  rm         delete files or directories
+	  rdp        RDP (Remote Desktop Protocol) to a Windows buildlet
+	  run        run a command on a buildlet
+	  ssh        ssh to a buildlet
 
 To list all the builder types available, run "create" with no arguments:
 
-  $ gomote create
-  (list tons of buildlet types)
+	$ gomote create
+	(list tons of buildlet types)
 
 The "gomote run" command has many of its own flags:
 
-  $ gomote run -h
-  run usage: gomote run [run-opts] <instance> <cmd> [args...]
-    -builderenv string
-          Optional alternate builder to act like. Must share the same
-          underlying buildlet host type, or it's an error. For
-          instance, linux-amd64-race is compatible
-          with linux-amd64, but openbsd-amd64 and openbsd-386 are
-          different hosts.
-    -debug
-          write debug info about the command's execution before it begins
-    -dir string
-          Directory to run from. Defaults to the directory of the
-          command, or the work directory if -system is true.
-    -e value
-          Environment variable KEY=value. The -e flag may be repeated
-          multiple times to add multiple things to the environment.
-    -path string
-          Comma-separated list of ExecOpts.Path elements. The special
-          string 'EMPTY' means to run without any $PATH. The empty
-          string (default) does not modify the $PATH. Otherwise, the
-          following expansions apply: the string '$PATH' expands to
-          the current PATH element(s), the substring '$WORKDIR'
-          expands to the buildlet's temp workdir.
-    -system
-          run inside the system, and not inside the workdir; this is implicit if cmd starts with '/'
-
-Debugging buildlets directly
+	$ gomote run -h
+	run usage: gomote run [run-opts] <instance> <cmd> [args...]
+	  -builderenv string
+	        Optional alternate builder to act like. Must share the same
+	        underlying buildlet host type, or it's an error. For
+	        instance, linux-amd64-race is compatible
+	        with linux-amd64, but openbsd-amd64 and openbsd-386 are
+	        different hosts.
+	  -debug
+	        write debug info about the command's execution before it begins
+	  -dir string
+	        Directory to run from. Defaults to the directory of the
+	        command, or the work directory if -system is true.
+	  -e value
+	        Environment variable KEY=value. The -e flag may be repeated
+	        multiple times to add multiple things to the environment.
+	  -path string
+	        Comma-separated list of ExecOpts.Path elements. The special
+	        string 'EMPTY' means to run without any $PATH. The empty
+	        string (default) does not modify the $PATH. Otherwise, the
+	        following expansions apply: the string '$PATH' expands to
+	        the current PATH element(s), the substring '$WORKDIR'
+	        expands to the buildlet's temp workdir.
+	  -system
+	        run inside the system, and not inside the workdir; this is implicit if cmd starts with '/'
+
+# Debugging buildlets directly
 
 Using "gomote create" contacts the build coordinator
 (farmer.golang.org) and requests that it create the buildlet on your
@@ -80,7 +80,6 @@ then proxy your request via the coordinator.  To access a buildlet
 directly (for example, when working on the buildlet code), you can
 skip the "gomote create" step and use the special builder name
 "<build-config-name>@ip[:port>", such as "[email protected]".
-
 */
 package main