Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cmd/cue: help environment docs do not mention CUE_STATS_FILE #2832

Open
jpluscplusm opened this issue Feb 15, 2024 · 3 comments
Open

cmd/cue: help environment docs do not mention CUE_STATS_FILE #2832

jpluscplusm opened this issue Feb 15, 2024 · 3 comments

Comments

@jpluscplusm
Copy link
Collaborator

jpluscplusm commented Feb 15, 2024

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

$ cue version
cue version v0.8.0-alpha.1

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

Does this issue reproduce with the latest stable release?

No; cue help environment does not exist in 0.7.0.

What did you do?

exec cue help environment
grep CUE_STATS_FILE

What did you expect to see?

A passing testscript, indicating that the envvar is explained to some degree.

What did you see instead?

A failing testscript.

@jpluscplusm jpluscplusm added NeedsInvestigation Triage Requires triage/attention labels Feb 15, 2024
@mvdan
Copy link
Member

mvdan commented Feb 15, 2024

This is sort of intentional. End users should not be using or relying on CUE_STATS_FILE, at least not while we are heavily refactoring the evaluator which is bound to change the format and contents of the stats output.

Why are you interested in this environment variable and file?

@jpluscplusm
Copy link
Collaborator Author

Why are you interested in this environment variable and file?

Because I'm working on cue-lang/docs-and-content#9!

I got as far as explaining some values the envvar can take (https://review.gerrithub.io/c/cue-lang/cuelang.org/+/1176904/1/content/docs/howto/log-statistics-from-the-cue-evaluator/en.md), but I left a TODO in that doc because I don't know definitively what the stats actually mean!

However, that doc doesn't /need/ to explain them, IMHO, so I'm perfectly happy for this to be closed or parked :-)

@mvdan mvdan added Documentation and removed NeedsInvestigation Triage Requires triage/attention labels Feb 15, 2024
@mvdan
Copy link
Member

mvdan commented Feb 15, 2024

Gotcha, that makes sense. I think it's fine to write a tutorial mentioning it today - we can start documenting it more properly, including its format, in cue help environment once the new evaluator has stabilized a bit. We can leave this issue open as a reminder.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants