clang-format-diff.py

A script to format unified git diffs according to [.clang-format](../../src/.clang-format).

Requires `clang-format`, installed e.g. via `brew install clang-format` on macOS.

For instance, to format the last commit with 0 lines of context,

the script should be called from the git root folder as follows.

copyright\_header.py

Provides utilities for managing copyright headers of `The PIVX

developers` in repository source files. It has three subcommands:

Running these subcommands without arguments displays a usage string.

copyright\_header.py report \<base\_directory\> [verbose]

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.

Specifying `verbose` will list the full filenames of files of each category.

copyright\_header.py update \<base\_directory\> [verbose]

Updates all the copyright headers of `The PIVX developers` which were

changed in a year more recent than is listed. For example:

will be updated to:

where `<lastModifiedYear>` is obtained from the `git log` history.

This subcommand also handles copyright headers that have only a single year. In

those cases:

will be updated to:

where the update is appropriate.

copyright\_header.py insert \<file\>

Inserts a copyright header for `The PIVX developers` at the top of the

file in either Python or C++ style as determined by the file extension. If the

file is a Python file and it has `#!` starting the first line, the header is

inserted in the line below it.

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 equal to `<current_year>`, it will be set as a single

year rather than two hyphenated years.

If the file already has a copyright for `The PIVX developers`, the

script will exit.

gen-manpages.sh

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/

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

example:

BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh

git config --global user.signingkey mykeyid

The API request limit for unauthenticated requests is quite low, but the

limit for authenticated requests is much higher. If you start running

into rate limiting errors it can be useful to set an authentication token

so that the script can authenticate requests.

- First, go to [Personal access tokens](https://github.com/settings/tokens).

- Click 'Generate new token'.

- Fill in an arbitrary token description. No further privileges are needed.

- Click the `Generate token` button at the bottom of the form.

- Copy the generated token (should be a hexadecimal string)

Then do:

git config --global user.ghtoken "pasted token"

Create and verify timestamps of merge commits

To create or verify timestamps on the merge commits, install the OpenTimestamps

client via `pip3 install opentimestamps-client`. Then, dowload the gpg wrapper

`ots-git-gpg-wrapper.sh` and set it as git's `gpg.program`. See

[the ots git integration documentation](https://github.com/opentimestamps/opentimestamps-client/blob/master/doc/git-integration.md#usage)

for further details.

A script to optimize png files in the PIVX

repository (requires pngcrush).

Perform basic ELF security checks on a series of executables.

find ../gitian-builder/build -type f -executable | xargs python3 contrib/devtools/symbol-check.py

circular-dependencies.py

Run this script from the root of the source tree (`src/`) to find circular dependencies in the source code.

This looks only at which files include other files, treating the `.cpp` and `.h` file as one unit.

Example usage:

cd .../src

../contrib/devtools/circular-dependencies.py {*,*/*,*/*/*}.{h,cpp}