Skip to content

Commit 497d2c9

Browse files
fanquakeknst
authored andcommitted
Merge bitcoin#23126: doc: update developer docs for subtree renaming
2b90eae doc: update developer docs for subtree renaming (fanquake) Pull request description: Update the developer docs after the [recent subtree renaming](bitcoin#22646 (comment)). ACKs for top commit: hebasto: ACK 2b90eae Tree-SHA512: ed0eec8db888e60595c07f4fad0a506673e4b10345fb2dd6d1a98d785da22bddf1fe8896aa52fd67f5e1688e3c91c6b642739e08646f1b920f50f0d35037d961
1 parent 7217f24 commit 497d2c9

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
@@ -1132,37 +1132,41 @@ Subtrees
11321132

11331133
Several parts of the repository are subtrees of software maintained elsewhere.
11341134

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

1139-
Others are external projects without a tight relationship with our project. Changes to these should also
1140-
be sent upstream, but bugfixes may also be prudent to PR against Dash Core so that they can be integrated
1141-
quickly. Cosmetic changes should be purely taken upstream.
1139+
Others are external projects without a tight relationship with our project. Changes
1140+
to these should also be sent upstream, but bugfixes may also be prudent to PR against
1141+
a Dash Core subtree, so that they can be integrated quickly. Cosmetic changes
1142+
should be taken upstream.
11421143

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

11461147
Current subtrees include:
11471148

11481149
- src/leveldb
1149-
- Upstream at https://github.com/google/leveldb ; Maintained by Google, but
1150-
open important PRs to Core to avoid delay.
1150+
- Subtree at https://github.com/bitcoin-core/leveldb-subtree ; maintained by Core contributors.
1151+
- Upstream at https://github.com/google/leveldb ; maintained by Google. Open
1152+
important PRs to the subtree to avoid delay.
11511153
- **Note**: Follow the instructions in [Upgrading LevelDB](#upgrading-leveldb) when
11521154
merging upstream changes to the LevelDB subtree.
11531155

11541156
- src/crc32c
11551157
- Used by leveldb for hardware acceleration of CRC32C checksums for data integrity.
1156-
- Upstream at https://github.com/google/crc32c ; Maintained by Google.
1158+
- Subtree at https://github.com/bitcoin-core/crc32c-subtree ; maintained by Core contributors.
1159+
- Upstream at https://github.com/google/crc32c ; maintained by Google.
11571160

11581161
- src/secp256k1
1159-
- Upstream at https://github.com/bitcoin-core/secp256k1/ ; actively maintained by Core contributors.
1162+
- Upstream at https://github.com/bitcoin-core/secp256k1/ ; maintained by Core contributors.
11601163

11611164
- src/crypto/ctaes
1162-
- Upstream at https://github.com/bitcoin-core/ctaes ; actively maintained by Core contributors.
1165+
- Upstream at https://github.com/bitcoin-core/ctaes ; maintained by Core contributors.
11631166

11641167
- src/univalue
1165-
- Upstream at https://github.com/bitcoin-core/univalue ; actively maintained by Core contributors, deviates from upstream https://github.com/jgarzik/univalue
1168+
- Subtree at https://github.com/bitcoin-core/univalue-subtree ; maintained by Core contributors.
1169+
- Deviates from upstream https://github.com/jgarzik/univalue.
11661170

11671171
- src/minisketch
11681172
- Upstream at https://github.com/sipa/minisketch ; maintained by Core contributors.

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
* for `src/minisketch`: https://github.com/sipa/minisketch.git (branch master)
3535

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

0 commit comments

Comments
 (0)