bitcoin/doc
MarcoFalke 34d7030063
Merge #21202: [validation] Two small clang lock annotation improvements
25c57d6409 [doc] Add a note about where lock annotations should go. (Amiti Uttarwar)
ad5f01b960 [validation] Move the lock annotation from function definition to declaration (Amiti Uttarwar)

Pull request description:

  Based on reviewing #21188

  the first commit switches the lock annotations on `CheckInputScripts` to be on the function declaration instead of on the function definition. this ensures that all call sites are checked, not just ones that come after the definition.

  the second commit adds a note to the developer-notes section to clarify where the annotations should be applied.

ACKs for top commit:
  MarcoFalke:
    ACK 25c57d6409 🥘
  promag:
    Code review ACK 25c57d6409.

Tree-SHA512: 61b6ef856bf6c6016d535fbdd19daf57b9e59fe54a1f30d47282a071b9b9d60b2466b044ee57929e0320cb1bdef52e7a1687cacaa27031bbc43d058ffffe22ba
2021-02-22 09:47:15 +01:00
..
man scripted-diff: Fix typo in stub manual pages 2021-01-12 16:46:55 +01:00
release-notes Fix 0.21.0 release note to specify correct option BIP 157 support 2021-01-15 14:05:59 -06:00
.gitignore
Doxyfile.in
JSON-RPC-interface.md Update 'Secure string handling' 2020-12-29 01:49:30 +05:30
README.md
README_doxygen.md
README_windows.txt
REST-interface.md rpc: Return total fee in mempool 2021-01-28 10:43:22 +01:00
assets-attribution.md
benchmarking.md
bips.md doc/bips: Add BIPs 43, 44, 49, and 84 2021-02-12 20:48:18 +00:00
bitcoin-conf.md
bitcoin_logo_doxygen.png
build-freebsd.md
build-netbsd.md
build-openbsd.md
build-osx.md doc: Add explicit macdeployqtplus dependencies install step 2021-01-09 09:37:12 +02:00
build-unix.md build: explicitly install libboost-dev package 2021-02-17 09:04:20 +08:00
build-windows.md
dependencies.md doc: Add libnatpmp stuff 2021-01-07 18:07:10 +02:00
descriptors.md docs: correctly identify script type 2021-02-07 12:20:01 -06:00
developer-notes.md [doc] Add a note about where lock annotations should go. 2021-02-17 15:58:23 -08:00
dnsseed-policy.md
files.md
fuzzing.md Merge #20380: doc: Add instructions on how to fuzz the P2P layer using Honggfuzz NetDriver 2021-02-17 09:50:56 +01:00
gitian-building.md
guix.md docs: Point to contrib/guix/README.md in doc/guix.md 2021-01-08 11:40:01 -05:00
init.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
multiprocess.md
productivity.md doc: Add libnatpmp stuff 2021-01-07 18:07:10 +02:00
psbt.md
reduce-memory.md
reduce-traffic.md
release-notes-18077.md doc: Add release notes 2021-01-07 18:07:11 +02:00
release-notes-19776.md
release-notes.md Add release notes for listdescriptors RPC 2021-02-02 08:21:46 +01:00
release-process.md doc: Document use of make-tag script to make tags 2021-01-29 08:46:11 +01:00
shared-libraries.md
tor.md doc: Replace tabs for spaces 2021-02-04 12:06:13 +00:00
translation_process.md
translation_strings_policy.md
zmq.md

README.md

Bitcoin Core

Setup

Bitcoin Core is the original Bitcoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Bitcoin transactions, which requires a few hundred gigabytes of disk space. Depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more.

To download Bitcoin Core, visit bitcoincore.org.

Running

The following are some helpful notes on how to run Bitcoin Core on your native platform.

Unix

Unpack the files into a directory and run:

  • bin/bitcoin-qt (GUI) or
  • bin/bitcoind (headless)

Windows

Unpack the files into a directory, and then run bitcoin-qt.exe.

macOS

Drag Bitcoin Core to your applications folder, and then run Bitcoin Core.

Need Help?

Building

The following are developer notes on how to build Bitcoin Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

Development

The Bitcoin repo's root README contains relevant information on the development process and automated testing.

Resources

Miscellaneous

License

Distributed under the MIT software license.