search

cue-lang / cue

The home of the CUE language! Validate and define text-based and dynamic configuration
https://cuelang.org
Apache License 2.0
4.94k stars 279 forks source link

cmd/cue: environment doesn't mention CUE_DEBUG_TOOLS_FLOW #3052

Open jpluscplusm opened 3 months ago

jpluscplusm commented 3 months ago

What version of CUE are you using (cue version)?

$ cue version
cue version v0.8.1

go version go1.22.1
      -buildmode exe
       -compiler gc
       -trimpath true
     CGO_ENABLED 0
          GOARCH amd64
            GOOS linux
         GOAMD64 v1

Does this issue reproduce with the latest stable release?

Yes, 0.8.1

What did you do?

exec cue environment
stdout CUE_DEBUG_TOOLS_FLOW

What did you expect to see?

Mention of the environment variable introduced in https://cue-lang.org/cl/546541

What did you see instead?

No mention of this extremely useful environment variable.

myitcv commented 3 months ago

I would not expect this to be listed under cue help environment - it's a debug flag. However a specific place for debug information might well be useful.

mvdan commented 2 months ago

Note that we are moving all debug flags under CUE_DEBUG, and those already started getting documented under cue help environment. This flag should effectively get moved there as well, and not be documented separately.

Marcel is currently refactoring the evaluator's debug flags to move them under CUE_DEBUG as well. Once all of that is done, we can do a pass over the documentation to make sure it's up to date.