Skip to content

Commit

Permalink
docs: document JJ_LOG and --debug
Browse files Browse the repository at this point in the history
  • Loading branch information
mrnossiom committed Dec 17, 2024
1 parent f3a9b6d commit acaf7af
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,16 @@ you can submit a PR based on the `gh-pages` bookmark of
The `.rs` files generated from `.proto` files are included in the repository,
and there is a GitHub CI check that will complain if they do not match.

## Logging

You can print internal jj logs using `JJ_LOG`. It acts like the `RUST_LOG`
environment variable, frequent in Rust codebases, and accepts one or more
[directives]. You can also use the `--debug` global option that sets
`debug` log level for all targets by default. `JJ_LOG` is still respected when
using `--debug`.

[directives]: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/filter/struct.EnvFilter.html#directives

## Profiling

One easy-to-use sampling profiler
Expand Down

0 comments on commit acaf7af

Please sign in to comment.