Skip to content

Commit b59422c

Browse files
Merge #6556: [v22.1.x] backport: 22.1 final backports
e62b4eb Merge #6555: backport: Merge bitcoin#24263: doc: Fix gen-manpages, rewrite in Python (pasta) 53d0ff1 Merge #6552: docs: update supported versions in SECURITY.md (pasta) 4571d89 Merge #6554: docs: update man pages for 22.1 (pasta) bc91a83 Merge #6553: chore: bump assume valid / checkpoints for v22.1 (pasta) Pull request description: ## Issue being fixed or feature implemented Backports from develop to 22.1 ## What was done? ## How Has This Been Tested? ## Breaking Changes ## Checklist: _Go over all the following points, and put an `x` in all the boxes that apply._ - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added or updated relevant unit/integration/functional/e2e tests - [ ] I have made corresponding changes to the documentation - [x] I have assigned this pull request to a milestone _(for repository code-owners and collaborators only)_ ACKs for top commit: UdjinM6: utACK e62b4eb Tree-SHA512: 9f88c1a77ec1adc453b023b764f91760e13064c86d109c29bb7856f2588c6450e518c9479f8c3e245f7eeaf5ef6d28aa85f00b4b5e94ef5a4d80cb5b3d7fdff2
2 parents 3cd1aca + e62b4eb commit b59422c

11 files changed

+189
-251
lines changed

SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
| Version | Supported |
66
| ------- | ------------------ |
7-
| 22 | :white_check_mark: |
7+
| 22.x | :white_check_mark: |
88
| < 22 | :x: |
99

1010
## Reporting a Vulnerability

contrib/devtools/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ year rather than two hyphenated years.
7676
If the file already has a copyright for `The Dash Core developers`, the
7777
script will exit.
7878

79-
gen-manpages.sh
79+
gen-manpages.py
8080
===============
8181

8282
A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option.
@@ -87,7 +87,7 @@ repository. To use this tool with out-of-tree builds set `BUILDDIR`. For
8787
example:
8888

8989
```bash
90-
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh
90+
BUILDDIR=$PWD/build contrib/devtools/gen-manpages.py
9191
```
9292

9393
github-merge.py

contrib/devtools/gen-manpages.py

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
#!/usr/bin/env python3
2+
# Copyright (c) 2022 The Bitcoin Core developers
3+
# Distributed under the MIT software license, see the accompanying
4+
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5+
import os
6+
import subprocess
7+
import sys
8+
import tempfile
9+
10+
BINARIES = [
11+
'src/dashd',
12+
'src/dash-cli',
13+
'src/dash-tx',
14+
'src/dash-wallet',
15+
#'src/dash-util',
16+
'src/qt/dash-qt',
17+
]
18+
19+
# Paths to external utilities.
20+
git = os.getenv('GIT', 'git')
21+
help2man = os.getenv('HELP2MAN', 'help2man')
22+
23+
# If not otherwise specified, get top directory from git.
24+
topdir = os.getenv('TOPDIR')
25+
if not topdir:
26+
r = subprocess.run([git, 'rev-parse', '--show-toplevel'], stdout=subprocess.PIPE, check=True, universal_newlines=True)
27+
topdir = r.stdout.rstrip()
28+
29+
# Get input and output directories.
30+
builddir = os.getenv('BUILDDIR', topdir)
31+
mandir = os.getenv('MANDIR', os.path.join(topdir, 'doc/man'))
32+
33+
# Verify that all the required binaries are usable, and extract copyright
34+
# message in a first pass.
35+
copyright = None
36+
versions = []
37+
for relpath in BINARIES:
38+
abspath = os.path.join(builddir, relpath)
39+
try:
40+
r = subprocess.run([abspath, '--version'], stdout=subprocess.PIPE, universal_newlines=True)
41+
except IOError:
42+
print(f'{abspath} not found or not an executable', file=sys.stderr)
43+
sys.exit(1)
44+
# take first line (which must contain version)
45+
verstr = r.stdout.split('\n')[0]
46+
# last word of line is the actual version e.g. v22.99.0-5c6b3d5b3508
47+
verstr = verstr.split()[-1]
48+
assert verstr.startswith('v')
49+
50+
# Only dash-qt prints the copyright message on --version, so store it specifically.
51+
if relpath == 'src/qt/dash-qt':
52+
copyright = r.stdout.split('\n')[1:]
53+
54+
versions.append((abspath, verstr))
55+
56+
if any(verstr.endswith('-dirty') for (_, verstr) in versions):
57+
print("WARNING: Binaries were built from a dirty tree.")
58+
print('man pages generated from dirty binaries should NOT be committed.')
59+
print('To properly generate man pages, please commit your changes (or discard them), rebuild, then run this script again.')
60+
print()
61+
62+
with tempfile.NamedTemporaryFile('w', suffix='.h2m') as footer:
63+
# Create copyright footer, and write it to a temporary include file.
64+
assert copyright
65+
footer.write('[COPYRIGHT]\n')
66+
footer.write('\n'.join(copyright).strip())
67+
footer.flush()
68+
69+
# Call the binaries through help2man to produce a manual page for each of them.
70+
for (abspath, verstr) in versions:
71+
outname = os.path.join(mandir, os.path.basename(abspath) + '.1')
72+
print(f'Generating {outname}…')
73+
subprocess.run([help2man, '-N', '--version-string=' + verstr, '--include=' + footer.name, '-o', outname, abspath], check=True)

contrib/devtools/gen-manpages.sh

-52
This file was deleted.

doc/man/dash-cli.1

+17-52
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2-
.TH DASH-CLI "1" "December 2024" "dash-cli v22.0.0" "User Commands"
2+
.TH DASH-CLI "1" "February 2025" "dash-cli v22.1.0" "User Commands"
33
.SH NAME
4-
dash-cli \- manual page for dash-cli v22.0.0
4+
dash-cli \- manual page for dash-cli v22.1.0
55
.SH SYNOPSIS
66
.B dash-cli
77
[\fI\,options\/\fR] \fI\,<command> \/\fR[\fI\,params\/\fR] \fI\,Send command to Dash Core\/\fR
@@ -15,7 +15,7 @@ dash-cli \- manual page for dash-cli v22.0.0
1515
.B dash-cli
1616
[\fI\,options\/\fR] \fI\,help <command> Get help for a command\/\fR
1717
.SH DESCRIPTION
18-
Dash Core RPC client version v22.0.0
18+
Dash Core RPC client version v22.1.0
1919
.SH OPTIONS
2020
.HP
2121
\-?
@@ -24,7 +24,9 @@ Print this help message and exit
2424
.HP
2525
\fB\-addrinfo\fR
2626
.IP
27-
Get the number of addresses known to the node, per network and total.
27+
Get the number of addresses known to the node, per network and total,
28+
after filtering for quality and recency. The total number of
29+
addresses known to the node may be higher.
2830
.HP
2931
\fB\-color=\fR<when>
3032
.IP
@@ -136,8 +138,6 @@ for the wallet passphrase.
136138
.IP
137139
Print version and exit
138140
.PP
139-
Debugging/Testing options:
140-
.PP
141141
Chain selection options:
142142
.HP
143143
\fB\-chain=\fR<chain>
@@ -149,52 +149,17 @@ regtest
149149
.IP
150150
Use devnet chain with provided name
151151
.HP
152-
\fB\-highsubsidyblocks=\fR<n>
153-
.IP
154-
The number of blocks with a higher than normal subsidy to mine at the
155-
start of a chain. Block after that height will have fixed subsidy
156-
base. (default: 0, devnet\-only)
157-
.HP
158-
\fB\-highsubsidyfactor=\fR<n>
159-
.IP
160-
The factor to multiply the normal block subsidy by while in the
161-
highsubsidyblocks window of a chain (default: 1, devnet\-only)
162-
.HP
163-
\fB\-llmqchainlocks=\fR<quorum name>
164-
.IP
165-
Override the default LLMQ type used for ChainLocks. Allows using
166-
ChainLocks with smaller LLMQs. (default: llmq_devnet,
167-
devnet\-only)
168-
.HP
169-
\fB\-llmqdevnetparams=\fR<size>:<threshold>
170-
.IP
171-
Override the default LLMQ size for the LLMQ_DEVNET quorum (devnet\-only)
172-
.HP
173-
\fB\-llmqinstantsenddip0024=\fR<quorum name>
174-
.IP
175-
Override the default LLMQ type used for InstantSendDIP0024. (default:
176-
llmq_devnet_dip0024, devnet\-only)
177-
.HP
178-
\fB\-llmqmnhf=\fR<quorum name>
179-
.IP
180-
Override the default LLMQ type used for EHF. (default: llmq_devnet,
181-
devnet\-only)
182-
.HP
183-
\fB\-llmqplatform=\fR<quorum name>
184-
.IP
185-
Override the default LLMQ type used for Platform. (default:
186-
llmq_devnet_platform, devnet\-only)
187-
.HP
188-
\fB\-minimumdifficultyblocks=\fR<n>
189-
.IP
190-
The number of blocks that can be mined with the minimum difficulty at
191-
the start of a chain (default: 0, devnet\-only)
192-
.HP
193-
\fB\-powtargetspacing=\fR<n>
194-
.IP
195-
Override the default PowTargetSpacing value in seconds (default: 2.5
196-
minutes, devnet\-only)
197-
.HP
198152
\fB\-testnet\fR
199153
.IP
200154
Use the test chain. Equivalent to \fB\-chain\fR=\fI\,test\/\fR
155+
.SH COPYRIGHT
156+
Copyright (C) 2014-2025 The Dash Core developers
157+
Copyright (C) 2009-2025 The Bitcoin Core developers
158+
159+
Please contribute if you find Dash Core useful. Visit <https://dash.org/> for
160+
further information about the software.
161+
The source code is available from <https://github.com/dashpay/dash>.
162+
163+
This is experimental software.
164+
Distributed under the MIT software license, see the accompanying file COPYING
165+
or <https://opensource.org/licenses/MIT>

doc/man/dash-qt.1

+29-18
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3.
2-
.TH DASH-QT "1" "December 2024" "dash-qt v22.0.0" "User Commands"
2+
.TH DASH-QT "1" "February 2025" "dash-qt v22.1.0" "User Commands"
33
.SH NAME
4-
dash-qt \- manual page for dash-qt v22.0.0
4+
dash-qt \- manual page for dash-qt v22.1.0
55
.SH SYNOPSIS
66
.B dash-qt
77
[\fI\,command-line options\/\fR]
88
.SH DESCRIPTION
9-
Dash Core version v22.0.0
9+
Dash Core version v22.1.0
1010
.SH OPTIONS
1111
.HP
1212
\-?
@@ -282,8 +282,8 @@ Maximum per\-connection memory usage for the send buffer, <n>*1000 bytes
282282
\fB\-maxtimeadjustment\fR
283283
.IP
284284
Maximum allowed median peer time offset adjustment. Local perspective of
285-
time may be influenced by peers forward or backward by this
286-
amount. (default: 4200 seconds)
285+
time may be influenced by outbound peers forward or backward by
286+
this amount (default: 4200 seconds).
287287
.HP
288288
\fB\-maxuploadtarget=\fR<n>
289289
.IP
@@ -383,7 +383,7 @@ Use UPnP to map the listening port (default: 1 when listening and no
383383
.HP
384384
\fB\-v2transport\fR
385385
.IP
386-
Support v2 transport (default: 0)
386+
Support v2 transport (default: 1)
387387
.HP
388388
\fB\-whitebind=\fR<[permissions@]addr>
389389
.IP
@@ -856,23 +856,23 @@ Debugging/Testing options:
856856
.HP
857857
\fB\-debug=\fR<category>
858858
.IP
859-
Output debugging information (default: \fB\-nodebug\fR, supplying <category> is
860-
optional). If <category> is not supplied or if <category> = 1,
861-
output all debugging information. <category> can be: addrman,
862-
bench, chainlocks, cmpctblock, coindb, coinjoin, creditpool, ehf,
863-
estimatefee, gobject, http, i2p, instantsend, ipc, leveldb,
864-
libevent, llmq, llmq\-dkg, llmq\-sigs, lock, mempool, mempoolrej,
865-
mnpayments, mnsync, net, netconn, proxy, prune, qt, rand,
866-
reindex, rpc, selectcoins, spork, tor, txreconciliation,
859+
Output debug and trace logging (default: \fB\-nodebug\fR, supplying <category>
860+
is optional). If <category> is not supplied or if <category> = 1,
861+
output all debug and trace logging. <category> can be: addrman,
862+
bench, blockstorage, chainlocks, cmpctblock, coindb, coinjoin,
863+
creditpool, ehf, estimatefee, gobject, http, i2p, instantsend,
864+
ipc, leveldb, libevent, llmq, llmq\-dkg, llmq\-sigs, lock, mempool,
865+
mempoolrej, mnpayments, mnsync, net, netconn, proxy, prune, qt,
866+
rand, reindex, rpc, selectcoins, spork, tor, txreconciliation,
867867
validation, walletdb, zmq. This option can be specified multiple
868868
times to output multiple categories.
869869
.HP
870870
\fB\-debugexclude=\fR<category>
871871
.IP
872-
Exclude debugging information for a category. Can be used in conjunction
873-
with \fB\-debug\fR=\fI\,1\/\fR to output debug logs for all categories except the
874-
specified category. This option can be specified multiple times
875-
to exclude multiple categories.
872+
Exclude debug and trace logging for a category. Can be used in
873+
conjunction with \fB\-debug\fR=\fI\,1\/\fR to output debug and trace logging for
874+
all categories except the specified category. This option can be
875+
specified multiple times to exclude multiple categories.
876876
.HP
877877
\fB\-disablegovernance\fR
878878
.IP
@@ -1164,3 +1164,14 @@ Show splash screen on startup (default: 1)
11641164
\fB\-windowtitle=\fR<name>
11651165
.IP
11661166
Sets a window title which is appended to "Dash Core \- "
1167+
.SH COPYRIGHT
1168+
Copyright (C) 2014-2025 The Dash Core developers
1169+
Copyright (C) 2009-2025 The Bitcoin Core developers
1170+
1171+
Please contribute if you find Dash Core useful. Visit <https://dash.org/> for
1172+
further information about the software.
1173+
The source code is available from <https://github.com/dashpay/dash>.
1174+
1175+
This is experimental software.
1176+
Distributed under the MIT software license, see the accompanying file COPYING
1177+
or <https://opensource.org/licenses/MIT>

0 commit comments

Comments
 (0)