aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authoremilylange <git@emilylange.de>2024-02-12 17:51:01 +0100
committeremilylange <git@emilylange.de>2024-02-12 18:00:51 +0100
commitc86ac264cb6789fdc4c83378f275b76d57d88132 (patch)
treecfc97644226658e6d7dd377a03f894317d88deaa /doc
parent198188017cc7b956885e4b51c979cb3554276e4f (diff)
downloadgarage-c86ac264cb6789fdc4c83378f275b76d57d88132.tar.gz
garage-c86ac264cb6789fdc4c83378f275b76d57d88132.zip
doc: mention `warn` and `error` as available log levels
For some users, this might be their first time being interacting with the `env_logger` crate. As such, they might not be aware that less verbose log levels exist. Some might not want to log every incoming request, for example. This commit also adds syntax hints to the code-fence for bash for better syntax highlighting of that section, and repeats itself multiple times, that `info` is, in fact, the default. No changes to the recommendation of log levels were made.
Diffstat (limited to 'doc')
-rw-r--r--doc/book/quick-start/_index.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/book/quick-start/_index.md b/doc/book/quick-start/_index.md
index 1b129f36..cf6eabde 100644
--- a/doc/book/quick-start/_index.md
+++ b/doc/book/quick-start/_index.md
@@ -110,10 +110,11 @@ garage -c path/to/garage.toml server
If you have placed the `garage.toml` file in `/etc` (its default location), you can simply run `garage server`.
-You can tune Garage's verbosity as follows (from less verbose to more verbose):
+You can tune Garage's verbosity by setting the `RUST_LOG=` environment variable. \
+Available log levels are (from less verbose to more verbose): `error`, `warn`, `info` *(default)*, `debug` and `trace`.
-```
-RUST_LOG=garage=info garage server
+```bash
+RUST_LOG=garage=info garage server # default
RUST_LOG=garage=debug garage server
RUST_LOG=garage=trace garage server
```