Skip to content

Commit

Permalink
cmd/cue: mention CUE_DEBUG in cue help environment
Browse files Browse the repository at this point in the history
The `CUE_DEBUG` environment variable has recently been added but there
was no documentation for it. This adds some information about it to `cue
help environment`.

Also sort all the `cue help environment` entries in alphabetic order for
consistency.

Also clarify that CUE_EXPERIMENT does not support disabling experiments,
as one disables an experiment by omitting the experiment name entirely.

Signed-off-by: Roger Peppe <rogpeppe@gmail.com>
Change-Id: I9a16952adde7f8bfb3a82ba05fff0630af5bdec0
Reviewed-on: https://review.gerrithub.io/c/cue-lang/cue/+/1178223
TryBot-Result: CUEcueckoo <cueckoo@gmail.com>
Unity-Result: CUE porcuepine <cue.porcuepine@gmail.com>
Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
  • Loading branch information
rogpeppe committed Mar 14, 2024
1 parent fa65317 commit d5ecd6c
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions cmd/cue/cmd/help.go
Expand Up @@ -161,15 +161,6 @@ var environmentHelp = &cobra.Command{
If an environment variable is unset or empty, it uses a sensible default
setting.
CUE_CONFIG_DIR
The directory where the cue command keeps configuration and
state files. This defaults to a directory for user-specific
configuration data, such as:
"$XDG_CONFIG_HOME/cue" or "$HOME/.config/cue" on Linux
"$HOME/Library/Application Support/cue" on MacOS
"%AppData%/cue" on Windows
CUE_CACHE_DIR
The directory where the cue command keeps a cache of files to be
reused. This defaults to a directory for user-specific temporary
Expand All @@ -179,21 +170,38 @@ setting.
"$HOME/Library/Caches/cue" on MacOS
"%LocalAppData%/cue" on Windows
CUE_REGISTRY
CUE_CONFIG_DIR
The directory where the cue command keeps configuration and
state files. This defaults to a directory for user-specific
configuration data, such as:
This variable specifies which registry or registries to use for
downloading and publishing modules. See "cue help registryconfig"
for details.
"$XDG_CONFIG_HOME/cue" or "$HOME/.config/cue" on Linux
"$HOME/Library/Application Support/cue" on MacOS
"%AppData%/cue" on Windows
CUE_DEBUG
Comma-separated list of debug flags to enable. Current possible
values are:
http
Print log messages in JSON format, one per line showing
HTTP requests and responses made when interacting with
module registries.
CUE_EXPERIMENT
Comma-separated list of experiments to enable or disable. The
Comma-separated list of experiments to enable. The
list of available experiments may change arbitrarily over time.
See exp.go in package cuelang.org/go/internal/cueexperiment for
currently valid values.
Warning: This variable is provided for the development and
testing of the cue commands itself. Use beyond that purpose is
unsupported.
CUE_REGISTRY
This variable specifies which registry or registries to use for
downloading and publishing modules. See "cue help registryconfig"
for details.
`,
}

Expand Down

0 comments on commit d5ecd6c

Please sign in to comment.