Skip to content

Commit fad2460

Browse files
author
MarcoFalke
committed
Update contrib/devtools/README.md
* Fix order * Update subtree check
1 parent 5e151a8 commit fad2460

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

contrib/devtools/README.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,37 @@ clang-format.py
77

88
A script to format cpp source code according to [.clang-format](../../src/.clang-format). This should only be applied to new files or files which are currently not actively developed on. Also, git subtrees are not subject to formatting.
99

10+
fix-copyright-headers.py
11+
========================
12+
13+
Every year newly updated files need to have its copyright headers updated to reflect the current year.
14+
If you run this script from src/ it will automatically update the year on the copyright header for all
15+
.cpp and .h files if these have a git commit from the current year.
16+
17+
For example a file changed in 2014 (with 2014 being the current year):
18+
19+
```// Copyright (c) 2009-2013 The Bitcoin Core developers```
20+
21+
would be changed to:
22+
23+
```// Copyright (c) 2009-2014 The Bitcoin Core developers```
24+
25+
git-subtree-check.sh
26+
====================
27+
28+
Run this script from the root of the repository to verify that a subtree matches the contents of
29+
the commit it claims to have been updated to.
30+
31+
To use, make sure that you have fetched the upstream repository branch in which the subtree is
32+
maintained:
33+
* for `src/secp256k1`: https://github.com/bitcoin/secp256k1.git (branch master)
34+
* for `src/leveldb`: https://github.com/bitcoin/leveldb.git (branch bitcoin-fork)
35+
* for `src/univalue`: https://github.com/bitcoin/univalue.git (branch master)
36+
37+
Usage: `git-subtree-check.sh DIR COMMIT`
38+
39+
`COMMIT` may be omitted, in which case `HEAD` is used.
40+
1041
github-merge.sh
1142
===============
1243

@@ -41,21 +72,6 @@ Configuring the github-merge tool for the bitcoin repository is done in the foll
4172
git config githubmerge.testcmd "make -j4 check" (adapt to whatever you want to use for testing)
4273
git config --global user.signingkey mykeyid (if you want to GPG sign)
4374

44-
fix-copyright-headers.py
45-
========================
46-
47-
Every year newly updated files need to have its copyright headers updated to reflect the current year.
48-
If you run this script from src/ it will automatically update the year on the copyright header for all
49-
.cpp and .h files if these have a git commit from the current year.
50-
51-
For example a file changed in 2014 (with 2014 being the current year):
52-
53-
```// Copyright (c) 2009-2013 The Bitcoin Core developers```
54-
55-
would be changed to:
56-
57-
```// Copyright (c) 2009-2014 The Bitcoin Core developers```
58-
5975
optimize-pngs.py
6076
================
6177

@@ -98,18 +114,3 @@ It will do the following automatically:
98114
- add missing translations to the build system (TODO)
99115

100116
See doc/translation-process.md for more information.
101-
102-
git-subtree-check.sh
103-
====================
104-
105-
Run this script from the root of the repository to verify that a subtree matches the contents of
106-
the commit it claims to have been updated to.
107-
108-
To use, make sure that you have fetched the upstream repository branch in which the subtree is
109-
maintained:
110-
* for src/secp256k1: https://github.com/bitcoin/secp256k1.git (branch master)
111-
* for sec/leveldb: https://github.com/bitcoin/leveldb.git (branch bitcoin-fork)
112-
113-
Usage: git-subtree-check.sh DIR COMMIT
114-
115-
COMMIT may be omitted, in which case HEAD is used.

0 commit comments

Comments
 (0)