phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 23:09:44 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

doc: update developer docs for subtree renaming

Browse source
This commit is contained in:
fanquake 2021-09-29 14:40:43 +08:00
parent 8daecf4d1d
commit 2b90eae33c
No known key found for this signature in database
GPG key ID: 2EEB9F5CC09526C1
2 changed files with 21 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
doc/developer-notes.md
View file

@ -963,37 +963,41 @@ Subtrees
Several parts of the repository are subtrees of software maintained elsewhere. Several parts of the repository are subtrees of software maintained elsewhere.
Some of these are maintained by active developers of Bitcoin Core, in which case changes should probably go Some of these are maintained by active developers of Bitcoin Core, in which case
directly upstream without being PRed directly against the project. They will be merged back in the next changes should go directly upstream without being PRed directly against the project.
subtree merge. They will be merged back in the next subtree merge.
Others are external projects without a tight relationship with our project. Changes to these should also Others are external projects without a tight relationship with our project. Changes
be sent upstream, but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated to these should also be sent upstream, but bugfixes may also be prudent to PR against
quickly. Cosmetic changes should be purely taken upstream. a Bitcoin Core subtree, so that they can be integrated quickly. Cosmetic changes
should be taken upstream.
There is a tool in `test/lint/git-subtree-check.sh` ([instructions](../test/lint#git-subtree-checksh)) to check a subtree directory for consistency with There is a tool in `test/lint/git-subtree-check.sh` ([instructions](../test/lint#git-subtree-checksh))
its upstream repository. to check a subtree directory for consistency with its upstream repository.
Current subtrees include: Current subtrees include:
- src/leveldb - src/leveldb
- Upstream at https://github.com/google/leveldb ; Maintained by Google, but - Subtree at https://github.com/bitcoin-core/leveldb-subtree ; maintained by Core contributors.
open important PRs to Core to avoid delay. - Upstream at https://github.com/google/leveldb ; maintained by Google. Open
important PRs to the subtree to avoid delay.
- **Note**: Follow the instructions in [Upgrading LevelDB](#upgrading-leveldb) when - **Note**: Follow the instructions in [Upgrading LevelDB](#upgrading-leveldb) when
merging upstream changes to the LevelDB subtree. merging upstream changes to the LevelDB subtree.
- src/crc32c - src/crc32c
- Used by leveldb for hardware acceleration of CRC32C checksums for data integrity. - Used by leveldb for hardware acceleration of CRC32C checksums for data integrity.
- Upstream at https://github.com/google/crc32c ; Maintained by Google. - Subtree at https://github.com/bitcoin-core/crc32c-subtree ; maintained by Core contributors.
- Upstream at https://github.com/google/crc32c ; maintained by Google.
- src/secp256k1 - src/secp256k1
- Upstream at https://github.com/bitcoin-core/secp256k1/ ; actively maintained by Core contributors. - Upstream at https://github.com/bitcoin-core/secp256k1/ ; maintained by Core contributors.
- src/crypto/ctaes - src/crypto/ctaes
- Upstream at https://github.com/bitcoin-core/ctaes ; actively maintained by Core contributors. - Upstream at https://github.com/bitcoin-core/ctaes ; maintained by Core contributors.
- src/univalue - src/univalue
- Upstream at https://github.com/bitcoin-core/univalue ; actively maintained by Core contributors, deviates from upstream https://github.com/jgarzik/univalue - Subtree at https://github.com/bitcoin-core/univalue-subtree ; maintained by Core contributors.
- Deviates from upstream https://github.com/jgarzik/univalue.
Upgrading LevelDB Upgrading LevelDB
--------------------- ---------------------

6
test/lint/README.md
View file

@ -27,10 +27,10 @@ Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
To do a full check with `-r`, make sure that you have fetched the upstream repository branch in which the subtree is To do a full check with `-r`, make sure that you have fetched the upstream repository branch in which the subtree is
maintained: maintained:
* for `src/secp256k1`: https://github.com/bitcoin-core/secp256k1.git (branch master) * for `src/secp256k1`: https://github.com/bitcoin-core/secp256k1.git (branch master)
* for `src/leveldb`: https://github.com/bitcoin-core/leveldb.git (branch bitcoin-fork) * for `src/leveldb`: https://github.com/bitcoin-core/leveldb-subtree.git (branch bitcoin-fork)
* for `src/univalue`: https://github.com/bitcoin-core/univalue.git (branch master) * for `src/univalue`: https://github.com/bitcoin-core/univalue-subtree.git (branch master)
* for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master) * for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master)
* for `src/crc32c`: https://github.com/google/crc32c.git (branch master) * for `src/crc32c`: https://github.com/bitcoin-core/crc32c-subtree.git (branch bitcoin-fork)
To do so, add the upstream repository as remote: To do so, add the upstream repository as remote: