Skip to content

Commit 8c15f33

Browse files
author
MarcoFalke
committed
[trivial] Update contrib/devtools/README.md
1 parent 338f62f commit 8c15f33

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

contrib/devtools/README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
Contents
2-
===========
2+
========
33
This directory contains tools for developers working on this repository.
44

5+
clang-format.py
6+
===============
7+
8+
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.
9+
510
github-merge.sh
6-
==================
11+
===============
712

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

@@ -37,23 +42,31 @@ Configuring the github-merge tool for the bitcoin repository is done in the foll
3742
git config --global user.signingkey mykeyid (if you want to GPG sign)
3843

3944
fix-copyright-headers.py
40-
===========================
45+
========================
4146

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

4651
For example a file changed in 2014 (with 2014 being the current year):
52+
4753
```// Copyright (c) 2009-2013 The Bitcoin Core developers```
4854

4955
would be changed to:
56+
5057
```// Copyright (c) 2009-2014 The Bitcoin Core developers```
5158

59+
optimize-pngs.py
60+
================
61+
62+
A script to optimize png files in the bitcoin
63+
repository (requires pngcrush).
64+
5265
symbol-check.py
53-
==================
66+
===============
5467

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

5972
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
7083
.../64/test_bitcoin: symbol _ZNSt8__detail15_List_nod from unsupported version GLIBCXX_3.4.15
7184

7285
update-translations.py
73-
=======================
86+
======================
7487

7588
Run this script from the root of the repository to update all translations from transifex.
7689
It will do the following automatically:
@@ -93,4 +106,5 @@ maintained:
93106
* for sec/leveldb: https://github.com/bitcoin/leveldb.git (branch bitcoin-fork)
94107

95108
Usage: git-subtree-check.sh DIR COMMIT
109+
96110
COMMIT may be omitted, in which case HEAD is used.

0 commit comments

Comments
 (0)