cryptogera/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2026-02-13 08:58:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
bitcoin/src
History
Ava Chow f842d0801e
Merge bitcoin/bitcoin#29686: Update manpage descriptions 
47f50c7af5572520fd986b313a63a44a76d3c859 doc: add bitcoin-qt man description (willcl-ark)
40b82e3ab0a1889ddb816ca66f80512bdba93ef6 doc: add bitcoin-util man description (willcl-ark)
a7bf80f3a2db17ca6cbbaf45c49fbd6011633fa5 doc: add bitcoin-tx man description (willcl-ark)
3f9a5168323070a18b6c8b7bffeafe1d2965f50b doc: add bitcoin-wallet man description (willcl-ark)
d8c0bb23ef83f207394a3f714f4498ab8abf88c1 doc: add bitcoin-cli man description (willcl-ark)
09abccfa7729b53d057c9c0a7836367d6cc0233d doc: add bitcoind man description (willcl-ark)

Pull request description:

  Closes #29552

  Add better descriptions to help string for all binaries. Use format which is correctly detected by help2man when generating manpages.

  Examples:

  Before:

  ![image](https://github.com/bitcoin/bitcoin/assets/6606587/9f6a5dbd-b18b-416b-827b-1c260d7a1274)

  After:
  ![image](https://github.com/bitcoin/bitcoin/assets/6606587/179082a1-1082-4204-bad7-56260d0fdefc)

  Demonstration using `bitcoin-cli` also highlights removal of inline usage explanations which were being incorrectly formatted by `help2man`. This results in the following changed format to `bitcoin-cli --help`:

  ![image](https://github.com/bitcoin/bitcoin/assets/6606587/dbebb99f-e419-40cd-a82d-e87f33351fea)

ACKs for top commit:
  achow101:
    ACK 47f50c7af5572520fd986b313a63a44a76d3c859
  tdb3:
    re ACK 47f50c7af5572520fd986b313a63a44a76d3c859
  rkrux:
    tACK 47f50c7af5572520fd986b313a63a44a76d3c859
  maflcko:
    ACK 47f50c7af5572520fd986b313a63a44a76d3c859 📠

Tree-SHA512: 124a8877077b7d47758ea970949d472b2444e3ba65d2bfeb47ebbdb1f5f8d3bf0abe2c88714bb6c92ba0e36583f0b36aa6f016ea88b65f011c610096ea872182
2024-11-08 13:34:59 -05:00
..
bench
bench: add coverage for wallet migration process
2024-10-21 08:29:22 -03:00
common
Merge bitcoin/bitcoin#31156: test: Don't enforce BIP94 on regtest unless specified by arg
2024-10-30 17:00:14 -04:00
compat
netbase: refactor CreateSock() to accept sa_family_t
2024-03-01 13:13:07 -05:00
config
…
consensus
Move BlockMerkleBranch back to merkle.{h,cpp}
2024-09-26 09:48:31 +02:00
crc32c
Update crc32c subtree to latest upstream master
2024-02-27 18:28:19 +00:00
crypto
scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h
2024-10-10 12:22:12 +02:00
index
refactor: Split up NodeContext shutdown_signal and shutdown_request
2024-10-01 09:10:54 +02:00
init
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
interfaces
interfaces: remove now unused 'use_upnp' arg from 'mapPort'
2024-10-24 18:23:30 +02:00
ipc
Add submitSolution to BlockTemplate interface
2024-09-26 10:04:45 +02:00
kernel
test: Don't enforce BIP94 on regtest unless specified by arg
2024-10-28 11:38:38 -04:00
leveldb
Update leveldb-subtree subtree to latest upstream
2024-06-13 13:17:57 +01:00
logging
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
minisketch
Update minisketch subtree to latest master
2024-06-12 14:38:39 +01:00
node
[doc] comment fixups from n30110
2024-10-30 21:13:01 -04:00
policy
fees: Log non-fatal errors as [warning], instead of info-level
2024-10-23 18:43:32 +02:00
primitives
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
qt
Merge bitcoin/bitcoin#29686: Update manpage descriptions
2024-11-08 13:34:59 -05:00
rpc
Merge bitcoin/bitcoin#31043: rpc: getorphantxs follow-up
2024-10-29 14:49:19 -04:00
script
Fix unsigned integer overflows in interpreter
2024-10-01 10:45:44 +02:00
secp256k1
Update secp256k1 subtree to v0.6.0
2024-11-04 14:59:46 -05:00
support
cleanse: Use SecureZeroMemory for mingw-w64 (release) builds
2024-07-24 09:57:49 +01:00
test
Merge bitcoin/bitcoin#31190: TxDownloadManager followups
2024-11-07 17:30:00 +00:00
univalue
build: Remove Autotools-based build system
2024-08-30 21:31:39 +01:00
util
Make G_FUZZING constexpr, require -DBUILD_FOR_FUZZING=ON to execute a fuzz target
2024-10-31 13:51:37 +01:00
wallet
fuzz: Limit wallet_notifications iterations
2024-11-06 21:30:32 +01:00
zmq
cmake: Add FindZeroMQ module
2024-10-25 18:09:36 +01:00
.clang-format
refactor: Print verbose serialize compiler error messages
2023-12-15 15:20:54 +01:00
.clang-tidy
tidy: add clang-tidy modernize-use-starts-ends-with check
2024-09-14 20:33:32 +03:00
addrdb.cpp
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
addrdb.h
…
addresstype.cpp
policy: Add OP_1 <0x4e73> as a standard output type
2024-07-30 14:06:58 -04:00
addresstype.h
policy: Add OP_1 <0x4e73> as a standard output type
2024-07-30 14:06:58 -04:00
addrman_impl.h
Merge bitcoin/bitcoin#30568: addrman: change internal id counting to int64_t
2024-09-20 12:55:22 -04:00
addrman.cpp
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
addrman.h
addrman: change Select to support multiple networks
2024-09-10 12:58:54 -03:00
arith_uint256.cpp
refactor: Remove unused and fragile string interface from arith_uint256
2023-11-21 17:37:25 +01:00
arith_uint256.h
doc + test: Correct uint256 hex string endianness
2024-08-03 21:59:54 +02:00
attributes.h
…
banman.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
banman.h
net_processing: remove Misbehavior score and increments
2024-05-30 08:35:18 -04:00
base58.cpp
util: Move util/string.h functions to util namespace
2024-05-16 10:16:08 -05:00
base58.h
…
bech32.cpp
fuzz: replace hardcoded numbers for bech32 limits
2024-08-06 11:03:31 +02:00
bech32.h
fuzz: replace hardcoded numbers for bech32 limits
2024-08-06 11:03:31 +02:00
bip324.cpp
…
bip324.h
…
bitcoin-chainstate.cpp
kernel: Move background load thread to node context
2024-09-13 16:10:31 +02:00
bitcoin-cli-res.rc
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
bitcoin-cli.cpp
Merge bitcoin/bitcoin#29686: Update manpage descriptions
2024-11-08 13:34:59 -05:00
bitcoin-tx-res.rc
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
bitcoin-tx.cpp
doc: add bitcoin-tx man description
2024-10-30 10:18:40 +00:00
bitcoin-util-res.rc
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
bitcoin-util.cpp
doc: add bitcoin-util man description
2024-10-30 10:18:41 +00:00
bitcoin-wallet-res.rc
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
bitcoin-wallet.cpp
doc: add bitcoin-wallet man description
2024-10-30 10:18:39 +00:00
bitcoind-res.rc
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
bitcoind.cpp
doc: add bitcoind man description
2024-10-30 10:18:36 +00:00
blockencodings.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
blockencodings.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
blockfilter.cpp
util: Move util/string.h functions to util namespace
2024-05-16 10:16:08 -05:00
blockfilter.h
…
chain.cpp
…
chain.h
doc: update NeedsRedownload() comment
2024-09-17 09:54:18 +02:00
chainparams.cpp
test: Don't enforce BIP94 on regtest unless specified by arg
2024-10-28 11:38:38 -04:00
chainparams.h
…
chainparamsbase.cpp
Deduplicate list of chain strings in RPC help texts
2024-08-13 14:00:33 -03:00
chainparamsbase.h
Deduplicate list of chain strings in RPC help texts
2024-08-13 14:00:33 -03:00
chainparamsseeds.h
seeds: Regenerate mainnet seeds
2024-08-27 07:00:27 +02:00
checkqueue.h
…
clientversion.cpp
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
clientversion.h
scripted-diff: Clarify "user agent" variable name
2024-10-28 12:35:49 +00:00
cluster_linearize.h
clusterlin: remove Cluster type
2024-10-07 13:49:36 -04:00
CMakeLists.txt
build: Disable secp256k1 musig module
2024-11-05 15:08:49 -05:00
coins.cpp
refactor: Rely on returned value of GetCoin instead of parameter
2024-09-18 20:03:47 +02:00
coins.h
refactor: Rely on returned value of GetCoin instead of parameter
2024-09-18 20:03:47 +02:00
compressor.cpp
…
compressor.h
refactor: Rename CTransaction::nVersion to version
2024-06-07 13:55:23 -04:00
core_io.h
refactor: Replace ParseHashStr with FromHex
2024-07-24 17:40:18 +02:00
core_memusage.h
…
core_read.cpp
refactor: Replace ParseHashStr with FromHex
2024-07-24 17:40:18 +02:00
core_write.cpp
refactor: Rename CTransaction::nVersion to version
2024-06-07 13:55:23 -04:00
cuckoocache.h
validation: Don't error if maxsigcachesize exceeds uint32::max
2024-07-04 22:35:29 +02:00
dbwrapper.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
dbwrapper.h
…
deploymentinfo.cpp
…
deploymentinfo.h
…
deploymentstatus.cpp
…
deploymentstatus.h
…
dummywallet.cpp
wallet, test: Be able to always swap BDB endianness
2024-05-16 15:03:13 -04:00
external_signer.cpp
refactor: Remove Span operator==, Use std::ranges::equal
2024-08-13 07:44:31 +02:00
external_signer.h
…
flatfile.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
flatfile.h
refactor: Add FlatFileSeq member variables in BlockManager
2024-07-24 09:39:35 +02:00
hash.cpp
crypto, hash: replace custom rotl32 with std::rotl
2024-01-05 17:12:38 +01:00
hash.h
Squashed 'src/secp256k1/' changes from 2f2ccc46954..0cdc758a563
2024-11-04 14:59:46 -05:00
headerssync.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
headerssync.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
httprpc.cpp
Merge bitcoin/bitcoin#30401: fix: increase consistency of rpcauth parsing
2024-09-09 12:29:17 -04:00
httprpc.h
…
httpserver.cpp
scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h
2024-10-10 12:22:12 +02:00
httpserver.h
Merge bitcoin/bitcoin#30406: refactor: modernize-use-equals-default
2024-07-11 19:08:46 +01:00
i2p.cpp
Merge bitcoin/bitcoin#29833: i2p: fix and improve logs
2024-06-26 15:28:26 -04:00
i2p.h
i2p: log errors properly according to their severity
2024-06-12 16:19:50 -03:00
indirectmap.h
…
init.cpp
init: warn, don't error, when '-upnp' is set
2024-10-31 14:05:50 -04:00
init.h
multiprocess: Add -ipcbind option to bitcoin-node
2024-09-06 09:08:10 -04:00
key_io.cpp
key: clear out secret data in DecodeExtKey
2024-10-27 15:38:54 +01:00
key_io.h
…
key.cpp
refactor: remove un-tested early returns
2024-08-04 08:52:22 +02:00
key.h
refactor: move SignSchnorr to KeyPair
2024-08-04 08:51:36 +02:00
logging.cpp
log: Enforce trailing newline, Remove redundant m_started_new_line
2024-10-01 11:31:39 +02:00
logging.h
log: Enforce trailing newline, Remove redundant m_started_new_line
2024-10-01 11:31:39 +02:00
mapport.cpp
mapport: remove dead code in DispatchMapPort
2024-10-25 15:02:07 -04:00
mapport.h
interfaces: remove now unused 'use_upnp' arg from 'mapPort'
2024-10-24 18:23:30 +02:00
memusage.h
memusage: Add DynamicUsage for std::string
2024-11-04 18:46:40 +01:00
merkleblock.cpp
[clang-tidy] Enable the misc-no-recursion check
2024-04-07 14:04:45 +01:00
merkleblock.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
net_permissions.cpp
util: move fees.h and error.h to common/messages.h
2024-05-16 10:16:08 -05:00
net_permissions.h
Accept "in" and "out" flags to -whitelist to allow whitelisting manual connections
2024-02-28 10:05:56 -03:00
net_processing.cpp
[p2p] add TxDownloadOptions bool to make TxRequestTracker deterministic
2024-10-24 21:23:56 -04:00
net_processing.h
net: add GetOrphanTransactions() to PeerManager
2024-10-01 21:55:18 -04:00
net_types.cpp
rpc: avoid copying into UniValue
2024-05-20 16:48:19 +00:00
net_types.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
net.cpp
net: Use actual memory size in receive buffer accounting
2024-11-04 18:46:40 +01:00
net.h
net: Use actual memory size in receive buffer accounting
2024-11-04 18:46:40 +01:00
netaddress.cpp
refactor: Remove Span operator==, Use std::ranges::equal
2024-08-13 07:44:31 +02:00
netaddress.h
random: get rid of GetRand by inlining
2024-07-01 12:39:53 -04:00
netbase.cpp
scripted-diff: drop config/ subdir for bitcoin-config.h, rename to bitcoin-build-config.h
2024-10-10 12:22:12 +02:00
netbase.h
net: add All() in ReachableNets
2024-09-10 11:20:40 -03:00
netgroup.cpp
Merge bitcoin/bitcoin#27581: net: Continuous ASMap health check
2023-12-06 11:22:42 -05:00
netgroup.h
net: Add continuous ASMap health check logging
2023-12-02 22:03:08 +01:00
netmessagemaker.h
refactor: NetMsg::Make() without nVersion
2023-11-20 14:02:27 +01:00
noui.cpp
node: Use log levels in noui_ThreadSafeMessageBox
2024-03-21 16:41:16 +01:00
noui.h
…
outputtype.cpp
fix incorrect multisig redeem script size limit for segwit
2024-05-03 14:20:44 -03:00
outputtype.h
fix incorrect multisig redeem script size limit for segwit
2024-05-03 14:20:44 -03:00
pow.cpp
Make G_FUZZING constexpr, require -DBUILD_FOR_FUZZING=ON to execute a fuzz target
2024-10-31 13:51:37 +01:00
pow.h
Add FUZZING_BUILD_MODE_UNSAFE_FOR_PRODUCTION in PoW check
2024-09-02 15:43:33 +01:00
prevector.h
prevector: avoid GCC bogus warnings in insert method
2024-09-11 17:41:26 +02:00
protocol.cpp
protocol: make message types constexpr
2024-02-28 18:03:23 +01:00
protocol.h
Merge bitcoin/bitcoin#29421: net: make the list of known message types a compile time constant
2024-05-21 13:59:33 -04:00
psbt.cpp
util: add TransactionError includes and namespace declarations
2024-05-16 10:16:08 -05:00
psbt.h
Merge bitcoin/bitcoin#30406: refactor: modernize-use-equals-default
2024-07-11 19:08:46 +01:00
pubkey.cpp
refactor: Hand-replace some ParseHex -> ""_hex
2024-08-28 19:11:59 +02:00
pubkey.h
refactor: Make XOnlyPubKey tolerate constexpr std::arrays
2024-08-28 19:09:51 +02:00
random.cpp
Merge bitcoin/bitcoin#31124: util: Remove RandAddSeedPerfmon
2024-10-24 18:08:12 -04:00
random.h
util: Remove RandAddSeedPerfmon
2024-10-21 23:24:17 +02:00
randomenv.cpp
util: Remove RandAddSeedPerfmon
2024-10-21 23:24:17 +02:00
randomenv.h
…
rest.cpp
scripted-diff: Rename PACKAGE_* variables to CLIENT_*
2024-10-28 12:36:19 +00:00
rest.h
…
scheduler.cpp
scripted-diff: Rename SingleThreadedSchedulerClient to SerialTaskRunner
2024-02-15 14:43:14 +01:00
scheduler.h
kernel: Remove dependency on CScheduler
2024-02-16 17:12:52 +01:00
serialize.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
signet.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
signet.h
…
span.h
refactor: Remove Span operator==, Use std::ranges::equal
2024-08-13 07:44:31 +02:00
streams.cpp
streams: add DataStream::GetMemoryUsage
2024-11-04 18:46:40 +01:00
streams.h
streams: add DataStream::GetMemoryUsage
2024-11-04 18:46:40 +01:00
sync.cpp
util: avoid using thread_local variable that has a destructor
2024-05-16 18:16:46 +02:00
sync.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
threadsafety.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
tinyformat.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00
torcontrol.cpp
scripted-diff: LogPrint -> LogDebug
2024-08-29 13:49:57 +02:00
torcontrol.h
…
txdb.cpp
refactor: Rely on returned value of GetCoin instead of parameter
2024-09-18 20:03:47 +02:00
txdb.h
refactor: Rely on returned value of GetCoin instead of parameter
2024-09-18 20:03:47 +02:00
txmempool.cpp
refactor: Rely on returned value of GetCoin instead of parameter
2024-09-18 20:03:47 +02:00
txmempool.h
refactor: Rely on returned value of GetCoin instead of parameter
2024-09-18 20:03:47 +02:00
txorphanage.cpp
net: add GetOrphanTransactions() to PeerManager
2024-10-01 21:55:18 -04:00
txorphanage.h
[fuzz] txdownloadman and txdownload_impl
2024-10-24 21:23:56 -04:00
txrequest.cpp
Merge bitcoin/bitcoin#30194: refactor: use recommended type hiding on multi_index types
2024-08-07 20:00:28 +01:00
txrequest.h
…
uint256.cpp
scripted-diff: Rename SetHex to SetHexDeprecated
2024-07-24 09:15:34 +02:00
uint256.h
test: remove test-only uint256S
2024-09-06 17:36:18 +02:00
undo.h
Include version.h in fewer places
2023-11-16 11:36:22 +10:00
validation.cpp
Merge bitcoin/bitcoin#31064: init: Correct coins db cache size setting
2024-10-29 15:12:41 -04:00
validation.h
Remove unused g_best_block
2024-09-17 09:27:45 +02:00
validationinterface.cpp
refactor: include the proper header rather than forward-declaring RemovalReasonToString
2024-10-08 15:25:47 +00:00
validationinterface.h
[refactor] change ActiveTipChange to use CBlockIndex ref instead of ptr
2024-07-25 11:01:22 +01:00
versionbits.cpp
…
versionbits.h
…
walletinitinterface.h
tidy: modernize-use-equals-default
2024-07-08 11:12:01 +02:00