Skip to content

Correct docs to reflect new log_level names in post-tracing Rocket - #3007

Open
mcclure wants to merge 1 commit into
rwf2:masterfrom
mcclure:tracing-log-level-docs
Open

Correct docs to reflect new log_level names in post-tracing Rocket#3007
mcclure wants to merge 1 commit into
rwf2:masterfrom
mcclure:tracing-log-level-docs

Conversation

@mcclure

@mcclure mcclure commented Aug 14, 2026

Copy link
Copy Markdown

In 0.5.1, the log levels are "off", "normal", "debug", and "critical". In current master, due to adoption of the tracing crate, they are "off", "error", "warn", "info", "debug", "trace", or 0-5. This is not currently reflected in the documentation. (Which is bad, because if you check out master and follow the documentation currently in the docs/ folder, you will set your log_level to "normal" or "critical", and the program will fail to boot.) Patch addresses this.

Quirks of patch:

  • After switching to tracing, it appears the numbers 0-5 are also allowed as values for log_level. I don't know what strings these correspond to, so I didn't try to document them. I will fix this if you ask.
  • I changed one line to fix an ambiguity caused by the fact info and debug are now separate log levels.

Specifically, off/critical/normal/debug are now off/error/warn/info/debug/trace, and the defaults are now info/error instead of normal/critical.
@martynp

martynp commented Aug 15, 2026

Copy link
Copy Markdown

Thank you for the patch - I had already addressed most of these issues on my fork (rustfoo/rkt@a6aaece - went in a while ago, but my git foo is bad this morning I re-wrote the history fixing a typo)

But you have highlighted a few areas that I missed. Your patch is not directly applicable to my fork as I have moved a lot of things around - also the banner blocks have changed significantly - I have created a new PR incorporating those fixes here rustfoo/rkt#20.

@mcclure

mcclure commented Aug 15, 2026

Copy link
Copy Markdown
Author

All right— in case we are eventually able to get hold of the original Rocket maintainer, are there additional documentation fixes from your fork I should try to port back into this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants