From c838ce514fe5a264b68e25b988988382302c6dfc Mon Sep 17 00:00:00 2001 From: Vasil Dimov Date: Tue, 23 Jul 2024 12:21:41 +0200 Subject: [PATCH 1/4] doc: use proper doxygen formatting for CTxMemPool::cs Having `@par title` followed by an empty line renders improperly in Doxygen - it results in a paragraph with a title but without a body. https://www.doxygen.nl/manual/commands.html#cmdpar This also results in a compiler warning (or error) with Clang 19: ``` ./txmempool.h:368:34: error: empty paragraph passed to '@par' command [-Werror,-Wdocumentation] 368 | * @par Consistency guarantees | ~~~~~~~~~~~~~~~~~~~~~~~~~~^ 1 error generated. ``` Github-Pull: #30504 Rebased-From: 6a5e9e40e1dd3d397020703feb9aa0b6f4577c98 --- src/txmempool.h | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/txmempool.h b/src/txmempool.h index b98355c65f1..804d4807a1c 100644 --- a/src/txmempool.h +++ b/src/txmempool.h @@ -363,9 +363,7 @@ public: * that are guarded by it. * * @par Consistency guarantees - * * By design, it is guaranteed that: - * * 1. Locking both `cs_main` and `mempool.cs` will give a view of mempool * that is consistent with current chain tip (`ActiveChain()` and * `CoinsTip()`) and is fully populated. Fully populated means that if the @@ -373,7 +371,6 @@ public: * previously active chain, all the missing transactions will have been * re-added to the mempool and should be present if they meet size and * consistency constraints. - * * 2. Locking `mempool.cs` without `cs_main` will give a view of a mempool * consistent with some chain that was active since `cs_main` was last * locked, and that is fully populated as described above. It is ok for From 6c09325757b65191f7c3a44a039b65016dac9079 Mon Sep 17 00:00:00 2001 From: fanquake Date: Fri, 25 Oct 2024 16:04:32 +0100 Subject: [PATCH 2/4] doc: finalise release notes for 27.2 --- doc/release-notes.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/doc/release-notes.md b/doc/release-notes.md index 8897da5f7f1..85bf57c5009 100644 --- a/doc/release-notes.md +++ b/doc/release-notes.md @@ -1,9 +1,9 @@ -27.2rc1 Release Notes +27.2 Release Notes ===================== -Bitcoin Core version 27.2rc1 is now available from: +Bitcoin Core version 27.2 is now available from: - + This release includes various bug fixes and performance improvements, as well as updated translations. @@ -60,6 +60,10 @@ Notable changes - #30552 test: fix constructor of msg_tx +### Doc + +- #30504 doc: use proper doxygen formatting for CTxMemPool::cs + ### Build - #30283 upnp: fix build with miniupnpc 2.2.8 @@ -81,6 +85,7 @@ Thanks to everyone who directly contributed to this release: - Matt Whitlock - Max Edwards - Sebastian Falbesoner +- Vasil Dimov - willcl-ark As well as to everyone that helped with translations on From f42fcf6ad7a95b750a9cdc742b801e14a476f823 Mon Sep 17 00:00:00 2001 From: fanquake Date: Wed, 30 Oct 2024 11:54:12 +0000 Subject: [PATCH 3/4] build: bump version to v27.2 final --- configure.ac | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/configure.ac b/configure.ac index 0989fc9d234..f3f5fa3bf86 100644 --- a/configure.ac +++ b/configure.ac @@ -2,7 +2,7 @@ AC_PREREQ([2.69]) define(_CLIENT_VERSION_MAJOR, 27) define(_CLIENT_VERSION_MINOR, 2) define(_CLIENT_VERSION_BUILD, 0) -define(_CLIENT_VERSION_RC, 1) +define(_CLIENT_VERSION_RC, 0) define(_CLIENT_VERSION_IS_RELEASE, true) define(_COPYRIGHT_YEAR, 2024) define(_COPYRIGHT_HOLDERS,[The %s developers]) From dd1bf8bc4ef75ef43c33bbf755c3e0d2c6c3c5f7 Mon Sep 17 00:00:00 2001 From: fanquake Date: Wed, 30 Oct 2024 11:59:36 +0000 Subject: [PATCH 4/4] doc: update manual pages for 27.2 --- doc/man/bitcoin-cli.1 | 6 +++--- doc/man/bitcoin-qt.1 | 6 +++--- doc/man/bitcoin-tx.1 | 6 +++--- doc/man/bitcoin-util.1 | 6 +++--- doc/man/bitcoin-wallet.1 | 6 +++--- doc/man/bitcoind.1 | 6 +++--- 6 files changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/man/bitcoin-cli.1 b/doc/man/bitcoin-cli.1 index 0ed16c23217..986416c2f10 100644 --- a/doc/man/bitcoin-cli.1 +++ b/doc/man/bitcoin-cli.1 @@ -1,7 +1,7 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-CLI "1" "October 2024" "bitcoin-cli v27.2.0rc1" "User Commands" +.TH BITCOIN-CLI "1" "October 2024" "bitcoin-cli v27.2.0" "User Commands" .SH NAME -bitcoin-cli \- manual page for bitcoin-cli v27.2.0rc1 +bitcoin-cli \- manual page for bitcoin-cli v27.2.0 .SH SYNOPSIS .B bitcoin-cli [\fI\,options\/\fR] \fI\, \/\fR[\fI\,params\/\fR] \fI\,Send command to Bitcoin Core\/\fR @@ -15,7 +15,7 @@ bitcoin-cli \- manual page for bitcoin-cli v27.2.0rc1 .B bitcoin-cli [\fI\,options\/\fR] \fI\,help Get help for a command\/\fR .SH DESCRIPTION -Bitcoin Core RPC client version v27.2.0rc1 +Bitcoin Core RPC client version v27.2.0 .SH OPTIONS .HP \-? diff --git a/doc/man/bitcoin-qt.1 b/doc/man/bitcoin-qt.1 index 60a51bae37b..d4c4d6be04b 100644 --- a/doc/man/bitcoin-qt.1 +++ b/doc/man/bitcoin-qt.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-QT "1" "October 2024" "bitcoin-qt v27.2.0rc1" "User Commands" +.TH BITCOIN-QT "1" "October 2024" "bitcoin-qt v27.2.0" "User Commands" .SH NAME -bitcoin-qt \- manual page for bitcoin-qt v27.2.0rc1 +bitcoin-qt \- manual page for bitcoin-qt v27.2.0 .SH SYNOPSIS .B bitcoin-qt [\fI\,command-line options\/\fR] [\fI\,URI\/\fR] .SH DESCRIPTION -Bitcoin Core version v27.2.0rc1 +Bitcoin Core version v27.2.0 .PP Optional URI is a Bitcoin address in BIP21 URI format. .SH OPTIONS diff --git a/doc/man/bitcoin-tx.1 b/doc/man/bitcoin-tx.1 index 470d65d8318..47f54ff4acf 100644 --- a/doc/man/bitcoin-tx.1 +++ b/doc/man/bitcoin-tx.1 @@ -1,7 +1,7 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-TX "1" "October 2024" "bitcoin-tx v27.2.0rc1" "User Commands" +.TH BITCOIN-TX "1" "October 2024" "bitcoin-tx v27.2.0" "User Commands" .SH NAME -bitcoin-tx \- manual page for bitcoin-tx v27.2.0rc1 +bitcoin-tx \- manual page for bitcoin-tx v27.2.0 .SH SYNOPSIS .B bitcoin-tx [\fI\,options\/\fR] \fI\, \/\fR[\fI\,commands\/\fR] \fI\,Update hex-encoded bitcoin transaction\/\fR @@ -9,7 +9,7 @@ bitcoin-tx \- manual page for bitcoin-tx v27.2.0rc1 .B bitcoin-tx [\fI\,options\/\fR] \fI\,-create \/\fR[\fI\,commands\/\fR] \fI\,Create hex-encoded bitcoin transaction\/\fR .SH DESCRIPTION -Bitcoin Core bitcoin\-tx utility version v27.2.0rc1 +Bitcoin Core bitcoin\-tx utility version v27.2.0 .SH OPTIONS .HP \-? diff --git a/doc/man/bitcoin-util.1 b/doc/man/bitcoin-util.1 index c8dc19ab281..eea53828275 100644 --- a/doc/man/bitcoin-util.1 +++ b/doc/man/bitcoin-util.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-UTIL "1" "October 2024" "bitcoin-util v27.2.0rc1" "User Commands" +.TH BITCOIN-UTIL "1" "October 2024" "bitcoin-util v27.2.0" "User Commands" .SH NAME -bitcoin-util \- manual page for bitcoin-util v27.2.0rc1 +bitcoin-util \- manual page for bitcoin-util v27.2.0 .SH SYNOPSIS .B bitcoin-util [\fI\,options\/\fR] [\fI\,commands\/\fR] \fI\,Do stuff\/\fR .SH DESCRIPTION -Bitcoin Core bitcoin\-util utility version v27.2.0rc1 +Bitcoin Core bitcoin\-util utility version v27.2.0 .SH OPTIONS .HP \-? diff --git a/doc/man/bitcoin-wallet.1 b/doc/man/bitcoin-wallet.1 index a9ceeba47d0..f3cd1a5d728 100644 --- a/doc/man/bitcoin-wallet.1 +++ b/doc/man/bitcoin-wallet.1 @@ -1,9 +1,9 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIN-WALLET "1" "October 2024" "bitcoin-wallet v27.2.0rc1" "User Commands" +.TH BITCOIN-WALLET "1" "October 2024" "bitcoin-wallet v27.2.0" "User Commands" .SH NAME -bitcoin-wallet \- manual page for bitcoin-wallet v27.2.0rc1 +bitcoin-wallet \- manual page for bitcoin-wallet v27.2.0 .SH DESCRIPTION -Bitcoin Core bitcoin\-wallet version v27.2.0rc1 +Bitcoin Core bitcoin\-wallet version v27.2.0 .PP bitcoin\-wallet is an offline tool for creating and interacting with Bitcoin Core wallet files. By default bitcoin\-wallet will act on wallets in the default mainnet wallet directory in the datadir. diff --git a/doc/man/bitcoind.1 b/doc/man/bitcoind.1 index 15c7876bcdb..d63e5111cd3 100644 --- a/doc/man/bitcoind.1 +++ b/doc/man/bitcoind.1 @@ -1,12 +1,12 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH BITCOIND "1" "October 2024" "bitcoind v27.2.0rc1" "User Commands" +.TH BITCOIND "1" "October 2024" "bitcoind v27.2.0" "User Commands" .SH NAME -bitcoind \- manual page for bitcoind v27.2.0rc1 +bitcoind \- manual page for bitcoind v27.2.0 .SH SYNOPSIS .B bitcoind [\fI\,options\/\fR] \fI\,Start Bitcoin Core\/\fR .SH DESCRIPTION -Bitcoin Core version v27.2.0rc1 +Bitcoin Core version v27.2.0 .SH OPTIONS .HP \-?