Skip to content

BITCOIN MAINNETLive explorer status

₿MyBitcoinExplorer

Explorer Mempool Feed Forum Visualizer Receipts Tools Learn Code

Inside Bitcoin

Opening the selected file…

₿MyBitcoinExplorer

Bitcoin, in focus.
Explore the network. Understand the connections.

Explore Bitcoin with clarity.

Explore

Block explorer Mempool Bitcoin message feed Fee estimates Transaction graph

Build & learn

Developer tools API documentation Bitcoin guides Inside Bitcoin source Our methodology

MyBitcoinExplorer

Watchlists & alerts About the project Network status Address monitoring

© 2026 MyBitcoinExplorer. Bitcoin, in focus.Privacy Terms Contact Bitcoin mainnet

READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server440 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

bitcoin / bitcoinstable

Find a file

▤ check-doc.py

▤ commit-script-check.sh

▤ git-subtree-check.sh

▤ lint_ignore_dirs.py

▤ lint-circular-dependencies.py

▤ lint-files.py

▤ lint-include-guards.py

▤ lint-includes.py

▤ lint-locale-dependence.py

▤ lint-python.py

▤ lint-qt-translation.py

▤ lint-shell-locale.py

▤ lint-shell.py

▤ lint-submodule.py

▤ lint-tests.py

sanitizer_suppressions

▤ CMakeLists.txt

▤ config.ini.in

▤ download_utils.py

▤ get_previous_releases.py

▤ .editorconfig

▤ .gitattributes

▤ .python-version

▤ .style.yapf

▤ CMakeLists.txtGuide

▤ CMakePresets.json

▤ CONTRIBUTING.md

▤ COPYINGGuide

▤ CTestConfig.cmake

▤ libbitcoinkernel.pc.in

▤ README.mdGuide

▤ SECURITY.md

bitcoin / test / lint / check-doc.py

Download source ↓

2,807 bytes · SHA-256 707e50f8c72dce6d… · View upstream ↗

1#!/usr/bin/env python3
2# Copyright (c) 2015-present 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
6'''
7This checks if all command line args are documented.
8Return value is 0 to indicate no error.
9'''
10
11from subprocess import check_output
12import re
13
14FOLDER_GREP = 'src'
15FOLDER_TEST = 'src/test/'
16REGEX_ARG = r'\b(?:GetArg|GetArgs|GetBoolArg|GetIntArg|GetPathArg|IsArgSet|get_net)\("(-[^"]+)"'
17REGEX_DOC = r'AddArg\("(-[^"=]+?)(?:=|")'
18CMD_ROOT_DIR = '$(git rev-parse --show-toplevel)/{}'.format(FOLDER_GREP)
19CMD_GREP_ARGS = r"git grep --perl-regexp '{}' -- {} ':(exclude){}'".format(REGEX_ARG, CMD_ROOT_DIR, FOLDER_TEST)
20CMD_GREP_WALLET_ARGS = r"git grep --function-context 'void WalletInit::AddWalletOptions' -- {} | grep AddArg".format(CMD_ROOT_DIR)
21CMD_GREP_WALLET_HIDDEN_ARGS = r"git grep --function-context 'void DummyWalletInit::AddWalletOptions' -- {}".format(CMD_ROOT_DIR)
22CMD_GREP_DOCS = r"git grep --perl-regexp '{}' {}".format(REGEX_DOC, CMD_ROOT_DIR)
23# list unsupported, deprecated and duplicate args as they need no documentation
24SET_DOC_OPTIONAL = set(['-h', '-?', '-dbcrashratio', '-forcecompactdb', '-ipcconnect', '-ipcfd'])
25
26
27def lint_missing_argument_documentation():
28    used = check_output(CMD_GREP_ARGS, shell=True, text=True).strip()
29    docd = check_output(CMD_GREP_DOCS, shell=True, text=True).strip()
30
31    args_used = set(re.findall(re.compile(REGEX_ARG), used))
32    args_docd = set(re.findall(re.compile(REGEX_DOC), docd)).union(SET_DOC_OPTIONAL)
33    args_need_doc = args_used.difference(args_docd)
34    args_unknown = args_docd.difference(args_used)
35
36    print("Args used        : {}".format(len(args_used)))
37    print("Args documented  : {}".format(len(args_docd)))
38    print("Args undocumented: {}".format(len(args_need_doc)))
39    print(args_need_doc)
40    print("Args unknown     : {}".format(len(args_unknown)))
41    print(args_unknown)
42
43    assert 0 == len(args_need_doc), "Please document the following arguments: {}".format(args_need_doc)
44
45
46def lint_missing_hidden_wallet_args():
47    wallet_args = check_output(CMD_GREP_WALLET_ARGS, shell=True, text=True).strip()
48    wallet_hidden_args = check_output(CMD_GREP_WALLET_HIDDEN_ARGS, shell=True, text=True).strip()
49
50    wallet_args = set(re.findall(re.compile(REGEX_DOC), wallet_args))
51    wallet_hidden_args = set(re.findall(re.compile(r'    "([^"=]+)'), wallet_hidden_args))
52
53    hidden_missing = wallet_args.difference(wallet_hidden_args)
54    if hidden_missing:
55        assert 0, "Please add {} to the hidden args in DummyWalletInit::AddWalletOptions".format(hidden_missing)
56
57
58def main():
59    lint_missing_argument_documentation()
60    lint_missing_hidden_wallet_args()
61
62
63if __name__ == "__main__":
64    main()
65

A READING COMPANION

Source available. Guide coming next.

This file is included in the stable source snapshot. A file-specific guide has not been published yet.

440 guided files · 2,580 pending. Guides cover key sections, not every line.

cmake/bitcoin-build-config.h.in src/consensus/amount.h src/consensus/consensus.h src/primitives/block.h src/primitives/transaction.h src/crypto/sha256.h src/util/moneystr.h src/clientversion.h src/uint256.h src/script/script.h src/policy/policy.h CMakeLists.txt README.md COPYING src/consensus/tx_check.cpp src/consensus/tx_verify.cpp src/consensus/merkle.cpp src/pow.cpp src/validation.cpp src/script/interpreter.cpp src/script/solver.cpp src/script/sign.cpp src/key_io.cpp src/net.cpp src/net_processing.cpp src/netaddress.cpp src/protocol.h src/wallet/wallet.cpp src/wallet/spend.cpp

Code page 1

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/wallet/fees.cpp

src/wallet/load.cpp

src/txmempool.cpp

src/node/miner.cpp

src/chainparams.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/crypto/sha256.cpp

src/serialize.h

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/arith_uint256.h

src/blockencodings.h

src/blockfilter.h

src/crypto/siphash.h

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/compressor.h

src/compressor.cpp

src/flatfile.cpp

src/dbwrapper.h

src/util/chaintype.h

src/util/chaintype.cpp

src/scheduler.h

src/scheduler.cpp

src/checkqueue.h

src/threadsafety.h

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/blockfilter.cpp

src/merkleblock.cpp

src/merkleblock.h

src/addrman.cpp

src/netgroup.cpp

src/net_permissions.cpp

src/netbase.cpp

src/torcontrol.cpp

src/net_types.h

src/net_types.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/server.cpp

src/rpc/mempool.cpp

src/rpc/mining.cpp

src/rpc/net.cpp

src/rpc/node.cpp

src/rpc/blockchain.h

src/rpc/client.h

src/rpc/mempool.h

src/rpc/mining.h

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/abort.cpp

src/node/abort.h

src/node/caches.cpp

src/node/caches.h

src/kernel/caches.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/util/rbf.cpp

src/util/thread.h

src/common/netif.h

src/common/url.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/util/thread.cpp

src/kernel/types.h

src/interfaces/rpc.h

src/util/fees.cpp

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

src/attributes.h

src/chainparams.h

src/clientversion.cpp

src/common/signmessage.cpp

src/compat/assumptions.h

src/compat/byteswap.h

src/compat/cpuid.h

src/compat/endian.h

src/compat/stdin.cpp

src/compat/stdin.h

src/core_memusage.h

src/crypto/common.h

src/deploymentinfo.cpp

src/deploymentinfo.h

src/deploymentstatus.cpp

src/deploymentstatus.h

src/dummywallet.cpp

src/external_signer.h

src/indirectmap.h

src/init/basic.cpp

src/init/bitcoin-gui.cpp

src/init/bitcoin-node.cpp

src/init/bitcoin-qt.cpp

src/init/bitcoin-wallet.cpp

src/init/bitcoind.cpp

src/init/common.h

src/interfaces/init.h

src/interfaces/ipc.h

src/logging/categories.h

src/logging/timer.h

src/net_permissions.h

src/netmessagemaker.h

src/node/chainstatemanager_args.cpp

src/node/connection_types.h

src/node/context.h

src/node/interface_ui.h

src/node/mempool_args.cpp

src/node/mining_args.cpp

src/node/minisketchwrapper.cpp

src/node/txreconciliation.h

src/node/warnings.h

src/outputtype.cpp

src/outputtype.h

src/policy/fees/estimator_args.cpp

src/policy/fees/estimator_args.h

src/policy/fees/estimator_man.cpp

src/policy/fees/estimator_man.h

src/policy/packages.h

src/policy/rbf.h

src/policy/truc_policy.h

src/primitives/block.cpp

src/randomenv.h

src/script/keyorigin.h

src/script/parsing.cpp

src/script/parsing.h

src/script/script_error.h

src/script/sigcache.cpp

src/script/sigcache.h

src/script/solver.h

src/script/verify_flags.h

src/semaphore_grant.h

src/support/allocators/secure.h

src/support/allocators/zeroafterfree.h

src/uint256.cpp

src/util/bip32.cpp

src/util/fees.h

src/util/fs.cpp

src/util/result.h

src/util/string.cpp

src/util/tokenpipe.cpp

src/util/translation.h

src/util/vector.h

src/versionbits.h

src/versionbits_impl.h

src/wallet/external_signer_scriptpubkeyman.h

src/wallet/fees.h

src/wallet/load.h

src/wallet/receive.h

src/wallet/rpc/wallet.h

src/wallet/types.h

src/walletinitinterface.h

src/zmq/zmqabstractnotifier.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.