Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

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 •
edited
Loading

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

@VarunSAthreya VarunSAthreya mentioned this issue Dec 16, 2021
Merged
jaredpalmer added a commit that referenced this issue Dec 16, 2021
@VarunSAthreya @jaredpalmer
Docs debug flags #229 (#319)
9163f25 
Co-authored-by: Jared Palmer <jared@jaredpalmer.com>
sokra pushed a commit that referenced this issue Oct 25, 2022
@wbinnssmith
Fix auto deref clippy warnings (#229)
d89270c 
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
@nathanhammond
Switch to rust-powered from rust-based. (#229)
5a4332a 
We use "rust-powered" and "rust-based" inconsistently, this makes it
consistent, standardizing on "rust-powered"
@renovate renovate bot mentioned this issue Nov 6, 2022
Merged
1 task
@gitworkflows gitworkflows mentioned this issue Jan 18, 2024
Open
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
area: docs Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@weyert @jaredpalmer @VarunSAthreya