aboutsummaryrefslogtreecommitdiff
path: root/contrib/devtools/README.md
diff options
context:
space:
mode:
authorWladimir J. van der Laan <laanwj@gmail.com>2014-04-24 17:43:22 +0200
committerWladimir J. van der Laan <laanwj@gmail.com>2014-04-25 12:19:37 +0200
commit74fc254c2b4b2fd8392a246fc3b1520ca88da4fd (patch)
tree431fac88e881baf76beb4a338247a9ac95b26c77 /contrib/devtools/README.md
parent4765b8c11679aeb76efd9ce907a5c17661d4b018 (diff)
downloadbitcoin-74fc254c2b4b2fd8392a246fc3b1520ca88da4fd.tar.xz
devtools: add script to check symbols from Linux gitian executables
Add 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.
Diffstat (limited to 'contrib/devtools/README.md')
-rw-r--r--contrib/devtools/README.md28
1 files changed, 25 insertions, 3 deletions
diff --git a/contrib/devtools/README.md b/contrib/devtools/README.md
index f0d25fd7a2..697a714a47 100644
--- a/contrib/devtools/README.md
+++ b/contrib/devtools/README.md
@@ -3,7 +3,7 @@ Contents
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.
@@ -36,7 +36,8 @@ Configuring the github-merge tool for the bitcoin repository is done in the foll
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
+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
@@ -46,4 +47,25 @@ For example a file changed in 2014 (with 2014 being the current year):
```// Copyright (c) 2009-2013 The Bitcoin developers```
would be changed to:
-```// Copyright (c) 2009-2014 The Bitcoin developers``` \ No newline at end of file
+```// Copyright (c) 2009-2014 The Bitcoin developers```
+
+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
+