Changeset View
Changeset View
Standalone View
Standalone View
contrib/devtools/README.md
| Show All 17 Lines | |||||
| ``` | ``` | ||||
| git diff -U0 HEAD~1.. | ./contrib/devtools/clang-format-diff.py -p1 -i -v | git diff -U0 HEAD~1.. | ./contrib/devtools/clang-format-diff.py -p1 -i -v | ||||
| ``` | ``` | ||||
| copyright\_header.py | copyright\_header.py | ||||
| ==================== | ==================== | ||||
| Provides utilities for managing copyright headers of `The Bitcoin Core | Provides utilities for managing copyright headers of `The Bitcoin developers` | ||||
| developers` in repository source files. It has three subcommands: | in repository source files. It has three subcommands: | ||||
| ``` | ``` | ||||
| $ ./copyright_header.py report <base_directory> [verbose] | $ ./copyright_header.py report <base_directory> [verbose] | ||||
| $ ./copyright_header.py update <base_directory> | $ ./copyright_header.py update <base_directory> | ||||
| $ ./copyright_header.py insert <file> | $ ./copyright_header.py insert <file> | ||||
| ``` | ``` | ||||
| Running these subcommands without arguments displays a usage string. | Running these subcommands without arguments displays a usage string. | ||||
| copyright\_header.py report \<base\_directory\> [verbose] | copyright\_header.py report \<base\_directory\> [verbose] | ||||
| --------------------------------------------------------- | --------------------------------------------------------- | ||||
| Produces a report of all copyright header notices found inside the source files | Produces a report of all copyright header notices found inside the source files | ||||
| of a repository. Useful to quickly visualize the state of the headers. | of a repository. Useful to quickly visualize the state of the headers. | ||||
| Specifying `verbose` will list the full filenames of files of each category. | Specifying `verbose` will list the full filenames of files of each category. | ||||
| copyright\_header.py update \<base\_directory\> [verbose] | copyright\_header.py update \<base\_directory\> [verbose] | ||||
| --------------------------------------------------------- | --------------------------------------------------------- | ||||
| Updates all the copyright headers of `The Bitcoin Core developers` which were | Updates all the copyright headers of `The Bitcoin developers` which were changed | ||||
| changed in a year more recent than is listed. For example: | in a year more recent than is listed. For example: | ||||
| ``` | ``` | ||||
| // Copyright (c) <firstYear>-<lastYear> The Bitcoin Core developers | // Copyright (c) <firstYear>-<lastYear> The Bitcoin developers | ||||
| ``` | ``` | ||||
| will be updated to: | will be updated to: | ||||
| ``` | ``` | ||||
| // Copyright (c) <firstYear>-<lastModifiedYear> The Bitcoin Core developers | // Copyright (c) <firstYear>-<lastModifiedYear> The Bitcoin developers | ||||
| ``` | ``` | ||||
| where `<lastModifiedYear>` is obtained from the `git log` history. | where `<lastModifiedYear>` is obtained from the `git log` history. | ||||
| This subcommand also handles copyright headers that have only a single year. In | This subcommand also handles copyright headers that have only a single year. In | ||||
| those cases: | those cases: | ||||
| ``` | ``` | ||||
| // Copyright (c) <year> The Bitcoin Core developers | // Copyright (c) <year> The Bitcoin developers | ||||
| ``` | ``` | ||||
| will be updated to: | will be updated to: | ||||
| ``` | ``` | ||||
| // Copyright (c) <year>-<lastModifiedYear> The Bitcoin Core developers | // Copyright (c) <year>-<lastModifiedYear> The Bitcoin developers | ||||
| ``` | ``` | ||||
| where the update is appropriate. | where the update is appropriate. | ||||
| copyright\_header.py insert \<file\> | copyright\_header.py insert \<file\> | ||||
| ------------------------------------ | ------------------------------------ | ||||
| Inserts a copyright header for `The Bitcoin Core developers` at the top of the | Inserts a copyright header for `The Bitcoin developers` at the top of the file | ||||
| file in either Python or C++ style as determined by the file extension. If the | in either Python or C++ style as determined by the file extension. If the file | ||||
| file is a Python file and it has `#!` starting the first line, the header is | is a Python file and it has `#!` starting the first line, the header is | ||||
| inserted in the line below it. | inserted in the line below it. | ||||
| The copyright dates will be set to be `<year_introduced>-<current_year>` where | The copyright dates will be set to be `<year_introduced>-<current_year>` where | ||||
| `<year_introduced>` is according to the `git log` history. If | `<year_introduced>` is according to the `git log` history. If | ||||
| `<year_introduced>` is equal to `<current_year>`, it will be set as a single | `<year_introduced>` is equal to `<current_year>`, it will be set as a single | ||||
| year rather than two hyphenated years. | year rather than two hyphenated years. | ||||
| If the file already has a copyright for `The Bitcoin Core developers`, the | If the file already has a copyright for `The Bitcoin developers`, the script | ||||
| script will exit. | will exit. | ||||
| gen-manpages.sh | gen-manpages.sh | ||||
| =============== | =============== | ||||
| A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option. | A small script to automatically create manpages in ../../doc/man by running the release binaries with the -help option. | ||||
| This requires help2man which can be found at: https://www.gnu.org/software/help2man/ | This requires help2man which can be found at: https://www.gnu.org/software/help2man/ | ||||
| git-subtree-check.sh | git-subtree-check.sh | ||||
| ▲ Show 20 Lines • Show All 92 Lines • Show Last 20 Lines | |||||