doc: improve subtree check instructions #19258

pull Sjors wants to merge 1 commits into bitcoin:master from Sjors:2020/06/subtree-docs changing 3 files +8 −2

Sjors commented at 10:41 AM on June 12, 2020: member

Running git-subtree-check.sh requires adding the subtree repository as a remote. I learned that several years ago and then forgot again.

This PR also improves the error message if the subtree commit can't be found.
fanquake added the label Docs on Jun 12, 2020
fanquake added the label Scripts and tools on Jun 12, 2020
doc: improve subtree check instructions a4a3fc4cd2
in test/lint/README.md:29 in 117f69dfc3 outdated
```
  22 | @@ -23,6 +23,12 @@ maintained:
  23 |  * for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master)
  24 |  * for `src/crc32c`: https://github.com/google/crc32c.git (branch master)
  25 |  
  26 | +To do so, add the upstream repository as remote:
  27 | +
  28 | +```
  29 | +git remote add -f secp256k1 https://github.com/bitcoin-core/secp256k1.git
```
MarcoFalke commented at 11:08 AM on June 12, 2020:

I wish -f was called --fetch instead

Sjors commented at 11:32 AM on June 12, 2020:

Changed.

MarcoFalke commented at 11:53 AM on June 12, 2020:

Oh, I didn't know --fetch existed. git help remote doesn't mention it, but it seems to work, so :man_shrugging:

Sjors commented at 12:29 PM on June 12, 2020:

It does does show up when you do git remote add
Sjors force-pushed on Jun 12, 2020
fanquake approved
fanquake commented at 6:58 AM on June 29, 2020: member

ACK a4a3fc4cd2e6f53cdffcc2962fd152a4e40c7413 - this looks ok.
laanwj commented at 3:52 PM on July 9, 2020: member

ACK a4a3fc4cd2e6f53cdffcc2962fd152a4e40c7413
laanwj merged this on Jul 9, 2020
laanwj closed this on Jul 9, 2020
sidhujag referenced this in commit e86e278263 on Jul 9, 2020
zkbot referenced this in commit caed4adf50 on Nov 10, 2020
DrahtBot locked this on Feb 15, 2022

Contributors

Labels

Docs Scripts and tools