diff options
| author | Michael Matloob <matloob@golang.org> | 2024-08-22 12:00:10 -0400 |
|---|---|---|
| committer | Michael Matloob <matloob@golang.org> | 2024-08-22 17:40:30 +0000 |
| commit | d2879efd0227df32d6aeee1be58c325b477f22d4 (patch) | |
| tree | 03ec908f43fcde0915d6bc72186bed212c26abda /src | |
| parent | 422f4705ca5487184c232cc5709e543ce5f37cd6 (diff) | |
| download | go-d2879efd0227df32d6aeee1be58c325b477f22d4.tar.xz | |
cmd/go: document unsettable GOTELEMETRY and GOTELEMETRYDIR go env vars
This change adds documentation to "go help telemetry" and "go help
environment" for the unsettable GOTELEMETRY and GOTELEMETRYDIR go env
variables.
For #68928
Change-Id: I8c139bd8585ffb0c45b9dd722ef6e7a9a33df192
Reviewed-on: https://go-review.googlesource.com/c/go/+/607855
Reviewed-by: Robert Findley <rfindley@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/cmd/go/alldocs.go | 10 | ||||
| -rw-r--r-- | src/cmd/go/internal/help/helpdoc.go | 5 | ||||
| -rw-r--r-- | src/cmd/go/internal/telemetrycmd/telemetry.go | 5 |
3 files changed, 20 insertions, 0 deletions
diff --git a/src/cmd/go/alldocs.go b/src/cmd/go/alldocs.go index e28f9c30b4..7993420a8f 100644 --- a/src/cmd/go/alldocs.go +++ b/src/cmd/go/alldocs.go @@ -1797,6 +1797,11 @@ // To enable both collection and uploading, run “go telemetry on”. // To disable both collection and uploading, run "go telemetry off". // +// The current telemetry mode is also available as the value of the +// non-settable "GOTELEMETRY" go env variable. The directory in the +// local file system that telemetry data is written to is available +// as the value of the non-settable "GOTELEMETRYDIR" go env variable. +// // See https://go.dev/doc/telemetry for more information on telemetry. // // # Test packages @@ -2450,6 +2455,11 @@ // If module-aware mode is enabled, but there is no go.mod, GOMOD will be // os.DevNull ("/dev/null" on Unix-like systems, "NUL" on Windows). // If module-aware mode is disabled, GOMOD will be the empty string. +// GOTELEMETRY +// The current Go telemetry mode ("off", "local", or "on"). +// See "go help telemetry" for more information. +// GOTELEMETRYDIR +// The directory Go telemetry data is written is written to. // GOTOOLDIR // The directory where the go tools (compile, cover, doc, etc...) are installed. // GOVERSION diff --git a/src/cmd/go/internal/help/helpdoc.go b/src/cmd/go/internal/help/helpdoc.go index 29c0a56321..b1f3563280 100644 --- a/src/cmd/go/internal/help/helpdoc.go +++ b/src/cmd/go/internal/help/helpdoc.go @@ -678,6 +678,11 @@ Additional information available from 'go env' but not read from the environment If module-aware mode is enabled, but there is no go.mod, GOMOD will be os.DevNull ("/dev/null" on Unix-like systems, "NUL" on Windows). If module-aware mode is disabled, GOMOD will be the empty string. + GOTELEMETRY + The current Go telemetry mode ("off", "local", or "on"). + See "go help telemetry" for more information. + GOTELEMETRYDIR + The directory Go telemetry data is written is written to. GOTOOLDIR The directory where the go tools (compile, cover, doc, etc...) are installed. GOVERSION diff --git a/src/cmd/go/internal/telemetrycmd/telemetry.go b/src/cmd/go/internal/telemetrycmd/telemetry.go index 5542a02162..404ef638b1 100644 --- a/src/cmd/go/internal/telemetrycmd/telemetry.go +++ b/src/cmd/go/internal/telemetrycmd/telemetry.go @@ -41,6 +41,11 @@ To disable telemetry uploading, but keep local data collection, run To enable both collection and uploading, run “go telemetry on”. To disable both collection and uploading, run "go telemetry off". +The current telemetry mode is also available as the value of the +non-settable "GOTELEMETRY" go env variable. The directory in the +local file system that telemetry data is written to is available +as the value of the non-settable "GOTELEMETRYDIR" go env variable. + See https://go.dev/doc/telemetry for more information on telemetry. `, Run: runTelemetry, |