Changeset View
Changeset View
Standalone View
Standalone View
contrib/devtools/README.md
| Contents | Contents | ||||
| ======== | ======== | ||||
| This directory contains tools for developers working on this repository. | This directory contains tools for developers working on this repository. | ||||
| check-doc.py | |||||
| ============ | |||||
| Check if all command line args are documented. The return value indicates the | |||||
| number of undocumented args. | |||||
| copyright\_header.py | copyright\_header.py | ||||
| ==================== | ==================== | ||||
| Provides utilities for managing copyright headers of `The Bitcoin developers` | Provides utilities for managing copyright headers of `The Bitcoin 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] | ||||
| ▲ Show 20 Lines • Show All 57 Lines • ▼ Show 20 Lines | |||||
| With in-tree builds this tool can be run from any directory within the | With in-tree builds this tool can be run from any directory within the | ||||
| repostitory. To use this tool with out-of-tree builds set `BUILDDIR`. For | repostitory. To use this tool with out-of-tree builds set `BUILDDIR`. For | ||||
| example: | example: | ||||
| ```bash | ```bash | ||||
| BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh | BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh | ||||
| ``` | ``` | ||||
| git-subtree-check.sh | |||||
| ==================== | |||||
| Run this script from the root of the repository to verify that a subtree matches the contents of | |||||
| the commit it claims to have been updated to. | |||||
| To use, make sure that you have fetched the upstream repository branch in which the subtree is | |||||
| maintained: | |||||
| * for `src/secp256k1`: https://github.com/bitcoin-core/secp256k1.git (branch master) | |||||
| * for `src/leveldb`: https://github.com/bitcoin-core/leveldb.git (branch bitcoin-fork) | |||||
| * for `src/univalue`: https://github.com/bitcoin-core/univalue.git (branch master) | |||||
| * for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master) | |||||
| Usage: `git-subtree-check.sh DIR (COMMIT)` | |||||
| `COMMIT` may be omitted, in which case `HEAD` is used. | |||||
| optimize-pngs.py | optimize-pngs.py | ||||
| ================ | ================ | ||||
| A script to optimize png files in the bitcoin | A script to optimize png files in the bitcoin | ||||
| repository (requires pngcrush). | repository (requires pngcrush). | ||||
| security-check.py and test-security-check.py | security-check.py and test-security-check.py | ||||
| ============================================ | ============================================ | ||||
| Show All 34 Lines | |||||