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.

Sign up for GitHub

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

Update env var documentation in rerun --help #8133

Merged
merged 2 commits into from
Nov 14, 2024
Merged

Update env var documentation in rerun --help #8133

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca12f48
Update env var documentation in `rerun --help`
abey79 Nov 12, 2024
63af26f
lint + typo
abey79 Nov 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions crates/top/rerun/src/commands/entrypoint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,22 @@
"#;

// Place the important help _last_, to make it most visible in the terminal.
const EXAMPLES: &str = r#"
const ENVIRONMENT_VARIABLES_AND_EXAMPLES: &str = r#"
Environment variables:
RERUN_CHUNK_MAX_BYTES Maximum chunk size thershold for the compactor.

Check warning on line 33 in crates/top/rerun/src/commands/entrypoint.rs

View workflow job for this annotation

GitHub Actions / Checks / Spell Check 

"thershold" should be "threshold".
RERUN_CHUNK_MAX_ROWS Maximum chunk row count threshold for the compactor (sorted chunks).
RERUN_CHUNK_MAX_ROWS_IF_UNSORTED
Maximum chunk row count threshold for the compactor (unsorted chunks).
RERUN_SHADER_PATH The search path for shader/shader-imports. Only available in developer builds.
RERUN_TRACK_ALLOCATIONS Track memory allocations to diagnose memory leaks in the viewer. WARNING: slows down the viewer by a lot!
RERUN_TRACK_ALLOCATIONS Track memory allocations to diagnose memory leaks in the viewer.
WARNING: slows down the viewer by a lot!
RERUN_MAPBOX_ACCESS_TOKEN The Mapbox access token to use the Mapbox-provided backgrounds in the map view.
RUST_LOG Change the log level of the viewer, e.g. `RUST_LOG=debug`.
WGPU_BACKEND Overwrites the graphics backend used, must be one of `vulkan`, `metal` or `gl`.
Default is `vulkan` everywhere except on Mac where we use `metal`. What is supported depends on your OS.
WGPU_POWER_PREF Overwrites the power setting used for choosing a graphics adapter, must be `high` or `low`. (Default is `high`)
Default is `vulkan` everywhere except on Mac where we use `metal`. What is
supported depends on your OS.
WGPU_POWER_PREF Overwrites the power setting used for choosing a graphics adapter, must be `high`
or `low`. (Default is `high`)


Examples:
Expand Down Expand Up @@ -65,7 +73,7 @@
#[clap(
long_about = LONG_ABOUT,
// Place most of the help last, as that is most visible in the terminal.
after_long_help = EXAMPLES
after_long_help = ENVIRONMENT_VARIABLES_AND_EXAMPLES
)]
struct Args {
// Note: arguments are sorted lexicographically for nicer `--help` message.
Expand Down
Loading