Skip to content

Commit 28ccc70

Browse files
committed
Merge bitcoin/bitcoin#29241: doc: Add missing backtick in developer notes logging section
c003562 doc: Add missing backtick in developer notes logging section (Fabian Jahr) Pull request description: Newly added logging section from bitcoin/bitcoin#28318 is missing a single backtick. Also fixes some minor punctuation errors in that section. ACKs for top commit: jonatack: ACK c003562 alfonsoromanz: ACK c003562 Tree-SHA512: 2f75f9472d212ce7c7ebf3e7404f86b3bd8c695f63e2a7447d7a55bb54dcdb5e3bfd15e8eac5b92efbdcf1216c4e8d699cae0250d021f72b9d1c32a7db91989d
2 parents fe1eccd + c003562 commit 28ccc70

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/developer-notes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -739,25 +739,25 @@ logging messages. They should be used as follows:
739739
Note that `LogPrint(BCLog::CATEGORY, fmt, params...)` is a deprecated
740740
alias for `LogDebug`.
741741

742-
- `LogInfo(fmt, params...)` should only be used rarely, eg for startup
742+
- `LogInfo(fmt, params...)` should only be used rarely, e.g. for startup
743743
messages or for infrequent and important events such as a new block tip
744744
being found or a new outbound connection being made. These log messages
745-
are unconditional so care must be taken that they can't be used by an
745+
are unconditional, so care must be taken that they can't be used by an
746746
attacker to fill up storage. Note that `LogPrintf(fmt, params...)` is
747747
a deprecated alias for `LogInfo`.
748748

749749
- `LogError(fmt, params...)` should be used in place of `LogInfo` for
750750
severe problems that require the node (or a subsystem) to shut down
751-
entirely (eg, insufficient storage space).
751+
entirely (e.g., insufficient storage space).
752752

753753
- `LogWarning(fmt, params...)` should be used in place of `LogInfo` for
754754
severe problems that the node admin should address, but are not
755-
severe enough to warrant shutting down the node (eg, system time
755+
severe enough to warrant shutting down the node (e.g., system time
756756
appears to be wrong, unknown soft fork appears to have activated).
757757

758-
- `LogTrace(BCLog::CATEGORY, fmt, params...) should be used in place of
758+
- `LogTrace(BCLog::CATEGORY, fmt, params...)` should be used in place of
759759
`LogDebug` for log messages that would be unusable on a production
760-
system, eg due to being too noisy in normal use, or too resource
760+
system, e.g. due to being too noisy in normal use, or too resource
761761
intensive to process. These will be logged if the startup
762762
options `-debug=category -loglevel=category:trace` or `-debug=1
763763
-loglevel=trace` are selected.

0 commit comments

Comments
 (0)