neobytes-project/neobytes
neobytes-project/neobytes
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

[trivial] Update contrib/devtools/README.md

Browse Source
This commit is contained in:
MarcoFalke 2015-10-15 19:42:22 +02:00
parent 338f62f701
commit 8c15f33d15
1 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
contrib/devtools/README.md
View File

@ -1,9 +1,14 @@
Contents Contents
=========== ========
This directory contains tools for developers working on this repository. This directory contains tools for developers working on this repository.
clang-format.py
===============
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.
github-merge.sh github-merge.sh
================== ===============
A small script to automate merging pull-requests securely and sign them with GPG. A small script to automate merging pull-requests securely and sign them with GPG.
@ -37,23 +42,31 @@ Configuring the github-merge tool for the bitcoin repository is done in the foll
git config --global user.signingkey mykeyid (if you want to GPG sign) git config --global user.signingkey mykeyid (if you want to GPG sign)
fix-copyright-headers.py fix-copyright-headers.py
=========================== ========================
Every year newly updated files need to have its copyright headers updated to reflect the current year. 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 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. .cpp and .h files if these have a git commit from the current year.
For example a file changed in 2014 (with 2014 being the current year): For example a file changed in 2014 (with 2014 being the current year):
```// Copyright (c) 2009-2013 The Bitcoin Core developers``` ```// Copyright (c) 2009-2013 The Bitcoin Core developers```
would be changed to: would be changed to:
```// Copyright (c) 2009-2014 The Bitcoin Core developers``` ```// Copyright (c) 2009-2014 The Bitcoin Core developers```
optimize-pngs.py
================
A script to optimize png files in the bitcoin
repository (requires pngcrush).
symbol-check.py symbol-check.py
================== ===============
A script to check that the (Linux) executables produced by gitian only contain 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 allowed gcc, glibc and libstdc++ version symbols. This makes sure they are
still compatible with the minimum supported Linux distribution versions. still compatible with the minimum supported Linux distribution versions.
Example usage after a gitian build: Example usage after a gitian build:
@ -70,7 +83,7 @@ If there are 'unsupported' symbols, the return value will be 1 a list like this
.../64/test_bitcoin: symbol _ZNSt8__detail15_List_nod 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 update-translations.py
======================= ======================
Run this script from the root of the repository to update all translations from transifex. Run this script from the root of the repository to update all translations from transifex.
It will do the following automatically: It will do the following automatically:
@ -93,4 +106,5 @@ maintained:
* for sec/leveldb: https://github.com/bitcoin/leveldb.git (branch bitcoin-fork) * for sec/leveldb: https://github.com/bitcoin/leveldb.git (branch bitcoin-fork)
Usage: git-subtree-check.sh DIR COMMIT Usage: git-subtree-check.sh DIR COMMIT
COMMIT may be omitted, in which case HEAD is used. COMMIT may be omitted, in which case HEAD is used.