doc: fix `-logips` description to clarify that non-debug logs can also contain IP addresses
What the developer wrote
Authored by Lőrinc
doc: fix `-logips` description to clarify that non-debug logs can also contain IP addresses
IP addresses controlled by `-logips` are also logged in non-debug outputs:
* LogInfo "outbound peer headers chain has insufficient work" -> src/net_processing.cpp:2909
* LogInfo "Outbound peer has old chain" -> src/net_processing.cpp:5301
* LogInfo "Peer is stalling block download" -> src/net_processing.cpp:6057
* LogInfo "Timeout downloading block" -> src/net_processing.cpp:6076
* LogInfo "Timeout downloading headers" -> src/net_processing.cpp:6092
* LogInfo "Timeout downloading headers from noban peer, not …" -> src/net_processing.cpp:6096
* LogError "Cannot load block from disk" -> src/net_processing.cpp:2386 and src/net_processing.cpp:2399
Co-authored-by: Vasil Dimov <vd@freebsd.org>
What changed, and why it matters
This commit only changes a user-facing help string. It corrects the description of the -logips option from saying it controls IP addresses in 'debug output' to saying it controls IP addresses in 'log output' generally. No code behavior changes, no security fix, no vulnerability.
No security action needed. Treat as a normal documentation-only commit.
Security signals we found
No strong security signals were identified.
Evidence from the diff
A one-word documentation fix in src/init/common.cpp: the -logips argument description is updated from ‘Include IP addresses in debug output’ to ‘Include IP addresses in log output’ to reflect that IP addresses are also included in non-debug LogInfo/LogError messages. The functional behavior of -logips and the logging code is unchanged.
Changed components
src/init/common.cpp-logips command-line help textInspect captured patch +1 / −1
diff --git a/src/init/common.cpp b/src/init/common.cpp
index 5436cba5..c0695e52 100644
--- a/src/init/common.cpp
+++ b/src/init/common.cpp
@@ -31,7 +31,7 @@ void AddLoggingArgs(ArgsManager& argsman)
"If <category> is not supplied or if <category> is 1 or \"all\", output all debug logging. If <category> is 0 or \"none\", any other categories are ignored. Other valid values for <category> are: " + LogInstance().LogCategoriesString() + ". This option can be specified multiple times to output multiple categories.",
ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
argsman.AddArg("-debugexclude=<category>", "Exclude debug and trace logging for a category. Can be used in conjunction with -debug=1 to output debug and trace logging for all categories except the specified category. This option can be specified multiple times to exclude multiple categories. This takes priority over \"-debug\"", ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
- argsman.AddArg("-logips", strprintf("Include IP addresses in debug output (default: %u)", DEFAULT_LOGIPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
+ argsman.AddArg("-logips", strprintf("Include IP addresses in log output (default: %u)", DEFAULT_LOGIPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
argsman.AddArg("-loglevel=<level>|<category>:<level>", strprintf("Set the global or per-category severity level for logging categories enabled with the -debug configuration option or the logging RPC. Possible values are %s (default=%s). The following levels are always logged: error, warning, info. If <category>:<level> is supplied, the setting will override the global one and may be specified multiple times to set multiple category-specific levels. <category> can be: %s.", LogInstance().LogLevelsString(), LogInstance().LogLevelToStr(BCLog::DEFAULT_LOG_LEVEL), LogInstance().LogCategoriesString()), ArgsManager::DISALLOW_NEGATION | ArgsManager::DISALLOW_ELISION | ArgsManager::DEBUG_ONLY, OptionsCategory::DEBUG_TEST);
argsman.AddArg("-logtimestamps", strprintf("Prepend debug output with timestamp (default: %u)", DEFAULT_LOGTIMESTAMPS), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
argsman.AddArg("-logthreadnames", strprintf("Prepend debug output with name of the originating thread (default: %u)", DEFAULT_LOGTHREADNAMES), ArgsManager::ALLOW_ANY, OptionsCategory::DEBUG_TEST);
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.