Skip to content

Commit 2b90eae

Browse files
committed
doc: update developer docs for subtree renaming
1 parent 8daecf4 commit 2b90eae

File tree

2 files changed

+21
-17
lines changed

2 files changed

+21
-17
lines changed

doc/developer-notes.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -963,37 +963,41 @@ Subtrees
963963

964964
Several parts of the repository are subtrees of software maintained elsewhere.
965965

966-
Some of these are maintained by active developers of Bitcoin Core, in which case changes should probably go
967-
directly upstream without being PRed directly against the project. They will be merged back in the next
968-
subtree merge.
966+
Some of these are maintained by active developers of Bitcoin Core, in which case
967+
changes should go directly upstream without being PRed directly against the project.
968+
They will be merged back in the next subtree merge.
969969

970-
Others are external projects without a tight relationship with our project. Changes to these should also
971-
be sent upstream, but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated
972-
quickly. Cosmetic changes should be purely taken upstream.
970+
Others are external projects without a tight relationship with our project. Changes
971+
to these should also be sent upstream, but bugfixes may also be prudent to PR against
972+
a Bitcoin Core subtree, so that they can be integrated quickly. Cosmetic changes
973+
should be taken upstream.
973974

974-
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
975-
its upstream repository.
975+
There is a tool in `test/lint/git-subtree-check.sh` ([instructions](../test/lint#git-subtree-checksh))
976+
to check a subtree directory for consistency with its upstream repository.
976977

977978
Current subtrees include:
978979

979980
- src/leveldb
980-
- Upstream at https://github.com/google/leveldb ; Maintained by Google, but
981-
open important PRs to Core to avoid delay.
981+
- Subtree at https://github.com/bitcoin-core/leveldb-subtree ; maintained by Core contributors.
982+
- Upstream at https://github.com/google/leveldb ; maintained by Google. Open
983+
important PRs to the subtree to avoid delay.
982984
- **Note**: Follow the instructions in [Upgrading LevelDB](#upgrading-leveldb) when
983985
merging upstream changes to the LevelDB subtree.
984986

985987
- src/crc32c
986988
- Used by leveldb for hardware acceleration of CRC32C checksums for data integrity.
987-
- Upstream at https://github.com/google/crc32c ; Maintained by Google.
989+
- Subtree at https://github.com/bitcoin-core/crc32c-subtree ; maintained by Core contributors.
990+
- Upstream at https://github.com/google/crc32c ; maintained by Google.
988991

989992
- src/secp256k1
990-
- Upstream at https://github.com/bitcoin-core/secp256k1/ ; actively maintained by Core contributors.
993+
- Upstream at https://github.com/bitcoin-core/secp256k1/ ; maintained by Core contributors.
991994

992995
- src/crypto/ctaes
993-
- Upstream at https://github.com/bitcoin-core/ctaes ; actively maintained by Core contributors.
996+
- Upstream at https://github.com/bitcoin-core/ctaes ; maintained by Core contributors.
994997

995998
- src/univalue
996-
- Upstream at https://github.com/bitcoin-core/univalue ; actively maintained by Core contributors, deviates from upstream https://github.com/jgarzik/univalue
999+
- Subtree at https://github.com/bitcoin-core/univalue-subtree ; maintained by Core contributors.
1000+
- Deviates from upstream https://github.com/jgarzik/univalue.
9971001

9981002
Upgrading LevelDB
9991003
---------------------

test/lint/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
2727
To do a full check with `-r`, make sure that you have fetched the upstream repository branch in which the subtree is
2828
maintained:
2929
* for `src/secp256k1`: https://github.com/bitcoin-core/secp256k1.git (branch master)
30-
* for `src/leveldb`: https://github.com/bitcoin-core/leveldb.git (branch bitcoin-fork)
31-
* for `src/univalue`: https://github.com/bitcoin-core/univalue.git (branch master)
30+
* for `src/leveldb`: https://github.com/bitcoin-core/leveldb-subtree.git (branch bitcoin-fork)
31+
* for `src/univalue`: https://github.com/bitcoin-core/univalue-subtree.git (branch master)
3232
* for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master)
33-
* for `src/crc32c`: https://github.com/google/crc32c.git (branch master)
33+
* for `src/crc32c`: https://github.com/bitcoin-core/crc32c-subtree.git (branch bitcoin-fork)
3434

3535
To do so, add the upstream repository as remote:
3636

0 commit comments

Comments
 (0)