Skip to content

Commit 9851498

Browse files
author
MarcoFalke
committed
Merge #9246: Developer docs about existing subtrees.
08ed8c1 Developer docs about existing subtrees. (Gregory Maxwell)
2 parents 5412c08 + 08ed8c1 commit 9851498

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

0 commit comments

Comments
 (0)