mirrors/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2024-11-19 09:53:47 +01:00
Code Issues Projects Releases Wiki Activity
Bitcoin Core integration/staging tree
21,807 Commits 6 Branches 318 Tags 3.2 GiB
C++ 64%
Python 19.9%
C 12.4%
CMake 1.1%
Shell 0.9%
Other 1.6%
1ab6c1267e
Go to file
fanquake 1ab6c1267e
Merge #16986: doc: Doxygen-friendly CuckooCache comments 
7aad3b68e7 doc: Doxygen-friendly CuckooCache comments (Jon Layton)

Pull request description:

  Similar theme to #16947.

  - `invalid`, `contains` now appear in Doxygen docs
  - `setup` refers to correct argument name `b`
  - Argument references in `code blocks `
  - Lists markdown conformant, uniform line endings

  Tested with `make docs`

ACKs for top commit:
  laanwj:
    ACK 7aad3b68e7
  practicalswift:
    ACK 7aad3b68e7

Tree-SHA512: 70b38c10e534bad9c6ffcd88cc7a4797644afba5956d47a6c7cc655fcd5857a91f315d6da60e28ce9678d420ed4a51e22267eb8b89e26002b99cad63373dd349
2019-10-28 09:26:44 -04:00
.github github: Add warning for bug reports 2019-10-15 08:53:42 +02:00
.tx gui: Update transifex slug for 0.19 2019-09-02 13:40:01 +02:00
build_msvc build: remove EVP_MD_CTX_new detection 2019-10-24 16:01:43 -04:00
build-aux/m4 build: Installed Qt version only appears if being built 2019-09-30 19:03:16 -04:00
ci Remove BIP70 Support 2019-10-24 16:01:43 -04:00
contrib Remove BIP70 Support 2019-10-24 16:01:43 -04:00
depends Merge #17165: Remove BIP70 support 2019-10-26 11:35:45 +02:00
doc docs: remove protobuf from docs 2019-10-24 16:01:42 -04:00
share build: remove BIP70 entries from macOS Info.plist 2019-10-24 16:01:43 -04:00
src Merge #16986: doc: Doxygen-friendly CuckooCache comments 2019-10-28 09:26:44 -04:00
test Merge #16202: p2p: Refactor network message deserialization 2019-10-28 09:15:59 -04:00
.appveyor.yml Added libbitcoin_qt and bitcoin-qt to the msbuild configuration. 2019-09-08 14:13:05 +02:00
.cirrus.yml test: Make PORT_MIN in test runner configurable 2019-09-19 12:03:40 -04:00
.gitattributes
.gitignore Merge #16371: build: ignore macOS make deploy artefacts & add them to clean-local 2019-08-21 08:02:20 +08:00
.python-version .python-version: Specify full version 3.5.6 2019-03-02 12:06:26 -05:00
.style.yapf test: .style.yapf: Set column_limit=160 2019-03-04 18:28:13 -05:00
.travis.yml Remove BIP70 Support 2019-10-24 16:01:43 -04:00
autogen.sh Added double quotes 2019-10-07 17:02:46 -04:00
configure.ac build: remove EVP_MD_CTX_new detection 2019-10-24 16:01:43 -04:00
CONTRIBUTING.md doc: Added instructions for how to add an upsteam to forked repo 2019-10-20 11:47:42 +01:00
COPYING [Trivial] Update license year range to 2019 2018-12-31 04:27:59 +01:00
INSTALL.md
libbitcoinconsensus.pc.in
Makefile.am Merge #17091: tests: Add test for loadblock option and linearize scripts 2019-10-23 11:21:46 +02:00
README.md doc: Remove travis badge from readme 2019-06-19 11:39:27 -04:00
SECURITY.md doc: Remove explicit mention of version from SECURITY.md 2019-06-14 06:39:17 -04:00

README.md

Bitcoin Core integration/staging tree

https://bitcoincore.org

What is Bitcoin?

Bitcoin is an experimental digital currency that enables instant payments to anyone, anywhere in the world. Bitcoin uses peer-to-peer technology to operate with no central authority: managing transactions and issuing money are carried out collectively by the network. Bitcoin Core is the name of open source software which enables the use of this currency.

For more information, as well as an immediately useable, binary version of the Bitcoin Core software, see https://bitcoincore.org/en/download/, or read the original whitepaper.

License

Bitcoin Core is released under the terms of the MIT license. See COPYING for more information or see https://opensource.org/licenses/MIT.

Development Process

The master branch is regularly built and tested, but is not guaranteed to be completely stable. Tags are created regularly to indicate new official, stable release versions of Bitcoin Core.

The contribution workflow is described in CONTRIBUTING.md and useful hints for developers can be found in doc/developer-notes.md.

Testing

Testing and code review is the bottleneck for development; we get more pull requests than we can review and test on short notice. Please be patient and help out by testing other people's pull requests, and remember this is a security-critical project where any mistake might cost people lots of money.

Automated Testing

Developers are strongly encouraged to write unit tests for new code, and to submit new unit tests for old code. Unit tests can be compiled and run (assuming they weren't disabled in configure) with: make check. Further details on running and extending unit tests can be found in /src/test/README.md.

There are also regression and integration tests, written in Python, that are run automatically on the build server. These tests can be run (if the test dependencies are installed) with: test/functional/test_runner.py

The Travis CI system makes sure that every pull request is built for Windows, Linux, and macOS, and that unit/sanity tests are run automatically.

Manual Quality Assurance (QA) Testing

Changes should be tested by somebody other than the developer who wrote the code. This is especially important for large or high-risk changes. It is useful to add a test plan to the pull request description if testing the changes is not straightforward.

Translations

Changes to translations as well as new translations can be submitted to Bitcoin Core's Transifex page.

Translations are periodically pulled from Transifex and merged into the git repository. See the translation process for details on how this works.

Important: We do not accept translation changes as GitHub pull requests because the next pull from Transifex would automatically overwrite them again.

Translators should also subscribe to the mailing list.