Skip to content

scripted-diff: Use LogInfo over LogPrintf#29641

Merged
fanquake merged 2 commits intobitcoin:masterfrom
maflcko:2403-log-
Dec 6, 2025
Merged

scripted-diff: Use LogInfo over LogPrintf#29641
fanquake merged 2 commits intobitcoin:masterfrom
maflcko:2403-log-

Conversation

@maflcko
Copy link
Member

@maflcko maflcko commented Mar 12, 2024 •
edited
Loading

LogPrintf has many issues:

  • It does not mention the log severity (info).
  • It is a deprecated alias for LogInfo, according to the dev notes.
  • It wastes review cycles, because reviewers sometimes point out that it is deprecated.
  • It makes the code inconsistent, when both versions of the alias are used.

Fix all issues by removing the deprecated alias.

@DrahtBot
Copy link
Contributor

DrahtBot commented Mar 12, 2024 •
edited
Loading

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

Code Coverage & Benchmarks

For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/29641.

Reviews

See the guideline for information on the review process.

Type Reviewers
ACK stickies-v, ajtowns, rkrux
Concept ACK sedited, l0rinc
Stale ACK kevkevinpal, fanquake

If your review is incorrectly listed, please copy-paste <!--meta-tag:bot-skip--> into the comment that the bot should ignore.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #34018 (log: exempt all category-specific logs from ratelimiting when running with debug by stickies-v)
  • #34008 (log: don't rate-limit "new peer" with -debug=net by 0xB10C)
  • #33966 (refactor: disentangle miner startup defaults from runtime options by Sjors)
  • #33819 (mining: getCoinbase() returns struct instead of raw tx by Sjors)
  • #30343 (wallet, logging: Replace WalletLogPrintf() with LogInfo() by ryanofsky)
  • #29256 (log, refactor: Allow log macros to accept context arguments by ryanofsky)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

@kevkevinpal
Copy link
Contributor

kevkevinpal commented Mar 13, 2024

concept ACK fae5751

@kevkevinpal
Copy link
Contributor

kevkevinpal commented Mar 13, 2024

I noticed that there are helper functions such as the following using the LogPrintf naming scheme

  • WalletLogPrintf in src/wallet/wallet.h
  • LogPrintfCategoryWithThreadNames, LogPrintfCategory, LogPrintfCategoryWithoutThreadNames, LogPrintfWithoutThreadNames, LogPrintfWithThreadNames in ./src/bench/logging.cpp

Using this grep grep -nri "\<LogPrintLevel\>" ./src --binary-files=without-match
I also noticed that we are using LogPrintLevel when we could be using LogInfo, LogWarning, LogError, LogDebug and LogTrace

these might want to be addressed in a separate PR though

This was referenced Mar 13, 2024
Draft
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Closed
Closed
Closed
Open
Merged
Merged
Closed
Closed
Closed
@DrahtBot DrahtBot mentioned this pull request Mar 13, 2024
Merged
This was referenced Mar 13, 2024
Merged
Merged
@DrahtBot DrahtBot mentioned this pull request Aug 1, 2025
Merged
This was referenced Aug 21, 2025
Merged
Draft
@pablomartin4btc pablomartin4btc mentioned this pull request Sep 6, 2025
Merged
This was referenced Sep 14, 2025
Merged
Open
This was referenced Oct 7, 2025
Merged
Merged
This was referenced Oct 15, 2025
Merged
Open
This was referenced Oct 22, 2025
Merged
Merged
@DrahtBot DrahtBot mentioned this pull request Nov 8, 2025
Closed
This was referenced Nov 18, 2025
Merged
Merged
fanquake
fanquake approved these changes Nov 25, 2025
View reviewed changes
Copy link
Member

@fanquake fanquake left a comment

Choose a reason for hiding this comment

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

ACK 317b71bcd2e552f93ac2131b16a8acab414567dd - I think the conflicts here are small, and a number are themselves draft / WIP.

@l0rinc
Copy link
Contributor

l0rinc commented Nov 25, 2025

Is this ready for review now?

@DrahtBot DrahtBot mentioned this pull request Nov 25, 2025
Merged
@maflcko
Copy link
Member Author

maflcko commented Nov 27, 2025

Is this ready for review now?

No. Someone would have to pick up #29231, because most of the logs are alerts, and not info logs.

So i went ahead and did that in #33960

This was referenced Nov 27, 2025
Merged
Draft
MarcoFalke added 2 commits December 4, 2025 19:52
scripted-diff: LogPrintf -> LogInfo
fa05181 
This refactor does not change behavior.

-BEGIN VERIFY SCRIPT-

 sed --in-place 's/\<LogPrintf\>/LogInfo/g' \
   $( git grep -l '\<LogPrintf\>' -- ./contrib/ ./src/ ./test/ ':(exclude)src/logging.h' )

-END VERIFY SCRIPT-
refactor: Remove unused LogPrintf
fa4395d
This was referenced Dec 4, 2025
Merged
Merged
stickies-v
stickies-v approved these changes Dec 5, 2025
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 fa4395d

nit: would be nice to update the scripted-diff to also remove trailing newlines if that's not a huge pita

@DrahtBot DrahtBot mentioned this pull request Dec 5, 2025
Closed
@ajtowns
Copy link
Contributor

ajtowns commented Dec 5, 2025

ACK fa4395d

rkrux
rkrux approved these changes Dec 6, 2025
View reviewed changes
Copy link
Contributor

@rkrux rkrux left a comment

Choose a reason for hiding this comment

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

lgtm ACK fa4395d

Thanks for the cleanup, best to remove the deprecated LogPrintf alias.

It wastes review cycles, because reviewers sometimes point out that it is deprecated.

I reviewed #34008 where exactly this^ happened: #34008 (comment)

@maflcko
Copy link
Member Author

maflcko commented Dec 6, 2025

nit: would be nice to update the scripted-diff to also remove trailing newlines if that's not a huge pita

Thx, I can take a look, if I have to re-touch.

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

Reviewers

@l0rinc l0rinc Awaiting requested review from l0rinc

@sedited sedited Awaiting requested review from sedited

@fanquake fanquake Awaiting requested review from fanquake

3 more reviewers

@rkrux rkrux rkrux approved these changes

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

@Theschorpioen Theschorpioen Theschorpioen approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Refactoring

Projects

None yet

Milestone

31.0

Development

Successfully merging this pull request may close these issues.