History

Wladimir J. van der Laan aaba10f275 Revert "Make nicer pull request merge messages" This reverts commit `1078fb0885` (and thus pull #5623). It has various issues: - Pull request names get cut off at ", see e.g. `a026a56` - Merge script no longer copes with pulls that have a milestone attached, due to a duplicate 'title' in JSON that is not handled by the ad-hoc parsing.		2015-02-20 09:59:33 +01:00
..
README.md	Added "Core" to copyright headers	2014-12-19 19:55:32 +01:00
fix-copyright-headers.py	Added "Core" to copyright headers	2014-12-19 19:55:32 +01:00
github-merge.sh	Revert "Make nicer pull request merge messages"	2015-02-20 09:59:33 +01:00
optimize-pngs.py	contrib: improve optimize-pngs.py	2015-01-14 17:19:04 +01:00
symbol-check.py	Remove references to X11 licence	2014-12-16 15:56:50 +08:00
update-translations.py	Remove references to X11 licence	2014-12-16 15:56:50 +08:00

README.md

This directory contains tools for developers working on this repository.

github-merge.sh

A small script to automate merging pull-requests securely and sign them with GPG.

For example:

./github-merge.sh bitcoin/bitcoin 3077

(in any git repository) will help you merge pull request #3077 for the bitcoin/bitcoin repository.

What it does:

Fetch master and the pull request.
Locally construct a merge commit.
Show the diff that merge results in.
Ask you to verify the resulting source tree (so you can do a make check or whatever).
Ask you whether to GPG sign the merge commit.
Ask you whether to push the result upstream.

This means that there are no potential race conditions (where a pullreq gets updated while you're reviewing it, but before you click merge), and when using GPG signatures, that even a compromised github couldn't mess with the sources.

Setup

Configuring the github-merge tool for the bitcoin repository is done in the following way:

git config githubmerge.repository bitcoin/bitcoin
git config githubmerge.testcmd "make -j4 check" (adapt to whatever you want to use for testing)
git config --global user.signingkey mykeyid (if you want to GPG sign)

fix-copyright-headers.py

Every year newly updated files need to have its copyright headers updated to reflect the current year. If you run this script from src/ it will automatically update the year on the copyright header for all .cpp and .h files if these have a git commit from the current year.

symbol-check.py

A script to check that the (Linux) executables produced by gitian only contain allowed gcc, glibc and libstdc++ version symbols. This makes sure they are still compatible with the minimum supported Linux distribution versions.

Example usage after a gitian build:

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

If only supported symbols are used the return value will be 0 and the output will be empty.

If there are 'unsupported' symbols, the return value will be 1 a list like this will be printed:

.../64/test_bitcoin: symbol memcpy from unsupported version GLIBC_2.14
.../64/test_bitcoin: symbol __fdelt_chk from unsupported version GLIBC_2.15
.../64/test_bitcoin: symbol std::out_of_range::~out_of_range() from unsupported version GLIBCXX_3.4.15
.../64/test_bitcoin: symbol _ZNSt8__detail15_List_nod from unsupported version GLIBCXX_3.4.15

update-translations.py

Run this script from the root of the repository to update all translations from transifex. It will do the following automatically:

fetch all translations
post-process them into valid and committable format
add missing translations to the build system (TODO)

See doc/translation-process.md for more information.