Skip to content

Commit b390e8e

Browse files
MarcoFalkecodablock
authored andcommitted
Merge bitcoin#9246: Developer docs about existing subtrees.
08ed8c1 Developer docs about existing subtrees. (Gregory Maxwell)
1 parent b8a81d4 commit b390e8e

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

doc/developer-notes.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -410,6 +410,37 @@ GUI
410410
should not interact with the user. That's where View classes come in. The converse also
411411
holds: try to not directly access core data structures from Views.
412412
413+
Subtrees
414+
----------
415+
416+
Several parts of the repository are subtrees of software maintained elsewhere.
417+
418+
Some of these are maintained by active developers of Bitcoin Core, in which case changes should probably go
419+
directly upstream without being PRed directly against the project. They will be merged back in the next
420+
subtree merge.
421+
422+
Others are external projects without a tight relationship with our project. Changes to these should also
423+
be sent upstream but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated
424+
quickly. Cosmetic changes should be purely taken upstream.
425+
426+
There is a tool in contrib/devtools/git-subtree-check.sh to check a subtree directory for consistency with
427+
its upstream repository.
428+
429+
Current subtrees include:
430+
431+
- src/leveldb
432+
- Upstream at https://github.com/google/leveldb ; Maintained by Google, but open important PRs to Core to avoid delay
433+
434+
- src/libsecp256k1
435+
- Upstream at https://github.com/bitcoin-core/secp256k1/ ; actively maintaned by Core contributors.
436+
437+
- src/crypto/ctaes
438+
- Upstream at https://github.com/bitcoin-core/ctaes ; actively maintained by Core contributors.
439+
440+
- src/univalue
441+
- Upstream at https://github.com/jgarzik/univalue ; report important PRs to Core to avoid delay.
442+
443+
413444
Git and github tips
414445
---------------------
415446

0 commit comments

Comments
 (0)