Skip to content

doc: update -loglevel help to add info to the always logged levels#29230

Merged
fanquake merged 1 commit intobitcoin:masterfrom
jonatack:2024-01-fix-loglevel-help
Jan 16, 2024
Merged

doc: update -loglevel help to add info to the always logged levels#29230
fanquake merged 1 commit intobitcoin:masterfrom
jonatack:2024-01-fix-loglevel-help

Conversation

@jonatack
Copy link
Member

@jonatack jonatack commented Jan 11, 2024 •
edited
Loading

Commit ab34dc6 of #28318 was an incomplete version of 118c756 (#25203) from the Severity-based logging parent PR.

Add the missing text to update the -loglevel help doc.

While here, make the help text a little easier to understand.

Can be tested by running:

./src/bitcoind -regtest -help-debug | grep -A12 loglevel=

before

  -loglevel=<level>|<category>:<level>
       Set the global or per-category severity level for logging categories
       enabled with the -debug configuration option or the logging RPC:
       info, debug, trace (default=debug); warning and error levels are
       always logged.

after

  -loglevel=<level>|<category>:<level>
       Set the global or per-category severity level for logging categories
       enabled with the -debug configuration option or the logging RPC.
       Possible values are info, debug, trace (default=debug). The
       following levels are always logged: error, warning, info.

@DrahtBot
Copy link
Contributor

DrahtBot commented Jan 11, 2024 •
edited
Loading

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Code Coverage

For detailed information about the code coverage, see the test coverage report.

Reviews

See the guideline for information on the review process.

Type Reviewers
ACK stickies-v

If your review is incorrectly listed, please react with 👎 to this comment and the bot will ignore it on the next update.

@DrahtBot DrahtBot added the Docs label Jan 11, 2024
@jonatack jonatack force-pushed the 2024-01-fix-loglevel-help branch from 5175196 to 607869d Compare January 11, 2024 16:09
@jonatack jonatack mentioned this pull request Jan 11, 2024
Merged
stickies-v
stickies-v reviewed Jan 11, 2024
View reviewed changes
@jonatack
doc: add unconditional info loglevel following merge of PR 28318
ec779a2 
The `info` loglevel is now logged unconditionally following that merge.

While here, make the help text easier to understand.
@jonatack jonatack force-pushed the 2024-01-fix-loglevel-help branch from 607869d to ec779a2 Compare January 11, 2024 17:03
@jonatack
Copy link
Member Author

jonatack commented Jan 11, 2024

Re-pushed to provide the accepted log levels and the always-logged ones in the same order of severity (descending).

stickies-v
stickies-v approved these changes Jan 11, 2024
View reviewed changes
Copy link
Contributor

@stickies-v stickies-v left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK ec779a2

@jonatack jonatack changed the title doc: update -loglevel help following merge of PR 28318 doc: update -loglevel help to add info to the always logged levels Jan 11, 2024
@fanquake fanquake merged commit 9fa8eda into bitcoin:master Jan 16, 2024
@jonatack jonatack deleted the 2024-01-fix-loglevel-help branch January 16, 2024 18:48
@bitcoin bitcoin locked and limited conversation to collaborators Jan 15, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@stickies-v stickies-v stickies-v approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

CI failed Docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@jonatack @DrahtBot @stickies-v @fanquake