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

Document all debug flags #229

Closed
jaredpalmer opened this issue Dec 13, 2021 · 3 comments
Closed

Document all debug flags #229

jaredpalmer opened this issue Dec 13, 2021 · 3 comments
Labels
area: docs Improvements or additions to documentation good first issue Good for newcomers

Comments

@jaredpalmer
Copy link
Contributor

jaredpalmer commented Dec 13, 2021

Describe the feature you'd like to request

Document all remaining hidden, internal flags

Describe the solution you'd like

Add the following to the CLI Reference docs

  • --trace
  • --heap
  • --cpuprofile
  • -v, -vv, -vvv

References:

https://github.com/vercel/turborepo/blob/main/cli/cmd/turbo/main.go#L27-L37

https://github.com/vercel/turborepo/blob/main/cli/internal/config/config.go#L126-L137

Describe alternatives you've considered

On might argue that --trace, --heap, and --cpuprofile should only go in Contributing.md (#214). However, given our commitment to observability, it seems like there shouldn't be any undocumented APIs

@jaredpalmer jaredpalmer added area: docs Improvements or additions to documentation good first issue Good for newcomers labels Dec 13, 2021
@VarunSAthreya
Copy link
Contributor

Hey, I would like to work on this issue.

@weyert
Copy link
Contributor

weyert commented Dec 15, 2021

@VarunSAthreya are you picking up this issue?

@VarunSAthreya
Copy link
Contributor

@weyert Yes

jaredpalmer added a commit that referenced this issue Dec 16, 2021
Co-authored-by: Jared Palmer <[email protected]>
sokra pushed a commit that referenced this issue Oct 25, 2022
Some of these were addressable using clippy's suggestion, but in others (specifically when dereferencing a vc) the deref seems to be required. In those cases I extracted the dereferenced value into a variable, which often was enough to prevent the automatic deref check. In others, I suppressed it (a `let` or block is required to suppress clippy).

Test Plan: `cargo nextest run`
sokra pushed a commit that referenced this issue Oct 25, 2022
We use "rust-powered" and "rust-based" inconsistently, this makes it
consistent, standardizing on "rust-powered"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants