foster/bitcoin-core
0
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-03-05 14:06:27 -05:00
Code Issues Activity

doc: improve subtree check instructions

Browse source
This commit is contained in:
Sjors Provoost 2020-06-12 12:33:00 +02:00
parent 6762a627ec
commit a4a3fc4cd2
No known key found for this signature in database
GPG key ID: 57FF9BDBCC301009
3 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/developer-notes.md
View file

@ -874,7 +874,7 @@ Others are external projects without a tight relationship with our project. Chan
be sent upstream, but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated be sent upstream, but bugfixes may also be prudent to PR against Bitcoin Core so that they can be integrated
quickly. Cosmetic changes should be purely taken upstream. quickly. Cosmetic changes should be purely taken upstream.
There is a tool in `test/lint/git-subtree-check.sh` 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)) to check a subtree directory for consistency with
its upstream repository. its upstream repository.
Current subtrees include: Current subtrees include:

6
test/lint/README.md
View file

@ -23,6 +23,12 @@ maintained:
* 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/google/crc32c.git (branch master)
To do so, add the upstream repository as remote:
```
git remote add --fetch secp256k1 https://github.com/bitcoin-core/secp256k1.git
```
Usage: `git-subtree-check.sh DIR (COMMIT)` Usage: `git-subtree-check.sh DIR (COMMIT)`
`COMMIT` may be omitted, in which case `HEAD` is used. `COMMIT` may be omitted, in which case `HEAD` is used.

2
test/lint/git-subtree-check.sh
View file

@ -81,7 +81,7 @@ fi
# get the tree in the subtree commit referred to # get the tree in the subtree commit referred to
if [ "d$(git cat-file -t $rev 2>/dev/null)" != dcommit ]; then if [ "d$(git cat-file -t $rev 2>/dev/null)" != dcommit ]; then
echo "subtree commit $rev unavailable: cannot compare" >&2 echo "subtree commit $rev unavailable: cannot compare. Did you add and fetch the remote?" >&2
exit exit
fi fi
tree_subtree=$(git show -s --format="%T" $rev) tree_subtree=$(git show -s --format="%T" $rev)