aboutsummaryrefslogtreecommitdiff
path: root/contrib/devtools/README.md
AgeCommit message (Collapse)Author
2021-03-19Doc: Tell howto install clang-format on Debian/Ubuntuwodry
Because only macOS wasy mentioned, I was unsure if this would be a macOS specific tool. I guess Linux is more used than Mac, so Linux guide should be there, too.
2020-05-05contrib: Remove optimize-pngs.py script, which lives in the maintainer repoMarcoFalke
https://github.com/bitcoin-core/bitcoin-maintainer-tools/blob/master/optimize-pngs.py
2020-03-22scripts: add PE dylib checking to symbol-check.pyfanquake
2020-01-04scripts: add MACHO dylib checking to symbol-check.pyfanquake
2020-01-02scripts: add MACHO PIE check to security-check.pyfanquake
2019-08-20scripts: move update-translations.py to maintainer-tools repofanquake
2019-08-19scripts: remove github-merge.pyfanquake
This script has been moved to the bitcoin-core/bitcoin-maintainer-tools repository, after discussion in a core dev meeting. The rationale being that it is also useful to other projects, and thus should be moved to a more general repository. Meeting log: http://www.erisian.com.au/bitcoin-core-dev/log-2019-08-15.html See also: https://github.com/bitcoin-core/bitcoin-maintainer-tools/pull/28
2019-06-11Fix spelling errors identified by codespell 1.15.0Ben Woosley
After this commit, the only remaining output is: $ test/lint/lint-spelling.sh src/test/base32_tests.cpp:14: fo ==> of, for src/test/base64_tests.cpp:14: fo ==> of, for ^ Warning: codespell identified likely spelling errors. Any false positives? Add them to the list of ignored words in test/lint/lint-spelling.ignore-words.txt Note: * I ignore several valid alternative spellings * homogenous is present in tinyformat, hence should be addressed upstream * process' is correct only if there are plural processes
2019-03-14Merge #15444: [docs] Additional productivity tipsMarcoFalke
ff7f31e07d [doc] productivity: more advanced git range-diff (Sjors Provoost) 3a21905a4e [doc] devtools: mention clang-format dependency (Sjors Provoost) bf12093191 [doc] productivity: fix broken link (Sjors Provoost) Pull request description: Fixes a broken link to `devtools/README.md`, points out the `clang-format` dependency and adds a `git range-diff` incantation that works even with rebases and squashes. Tree-SHA512: 36e46282f1e28d1bf3f48ada995fbac548f61b7747091eb032b60919cf76c7bdad0fa8aecb0c47adbdaa9ef986d3ec7752b0bb94c63191401856e2ddeec48f3e
2019-03-02build: Require python 3.5MarcoFalke
2019-02-19[doc] devtools: mention clang-format dependencySjors Provoost
2019-01-14contrib: Allow use of github API authentication in github-mergeWladimir J. van der Laan
The API request limit for unauthenticated requests is quite low. I started running into rate limiting errors. The limit for authenticated requests is much higher. This patch adds an optional configuration setting `user.ghtoken` that, when set, is used to authenticate requests to the API.
2018-05-29doc: remove leftover check-doc documentationfanquake
2018-05-29Merge #13281: test: Move linters to test/lint, add readmeWladimir J. van der Laan
fa3c910bfeab00703c947c5200a64c21225b50ef test: Move linters to test/lint, add readme (MarcoFalke) Pull request description: This moves the checks and linters from `devtools` to a subfolder in `test`. (Motivated by my opinion that the dev tools are mostly for generating code and updating the repo whereas the linters are read-only checks.) Also, adds a readme to clarify that checks and linters are only meant to prevent bugs and user facing issues, not merely stylistic preference or inconsistencies. (This is motivated by the diversity in developers and work flows as well as existing code styles. It would be too disruptive to change all existing code to a single style or too burdensome to force all developers to adhere to a single style. Also note that our style guide is changing, so locking in at the wrong style "too early" would only waste resources.) Tree-SHA512: 9b10e89f2aeaf0c8a9ae248aa891d74e0abf0569f8e5dfd266446efa8bfaf19f0ea0980abf0b0b22f0d8416ee90d7435d21a9f9285b66df43f370b7979173406
2018-05-24test: Move linters to test/lint, add readmeMarcoFalke
2018-05-16Add circular dependencies scriptPieter Wuille
2018-04-09[doc] devtools: Setup ots git integrationMarcoFalke
2018-01-31contrib: Add support for out-of-tree builds in gen-manpages.shWladimir J. van der Laan
This adds support for setting the environment variable `BUILDDIR` to point to executables that are outside the source directory. E.g. to invoke the tool when the build is in $PWD/build: ```bash BUILDDIR=$PWD/build contrib/devtools/gen-manpages.sh ```
2017-02-09Fix typo and spelling inconsistency in CONTRIBUTING.mdKoki Takahashi
Fix spellings of GitHub Remove unnecessary changes Fix GitHub spelling on doc/translation_process.md
2017-01-28[doc] Remove unused clang format dev scriptMarcoFalke
Also, update the clang format file to reflect the current coding style mentioned in the developer notes.
2016-11-02Merge #8674: tools for analyzing, updating and adding copyright headers in ↵Wladimir J. van der Laan
source files 159597a [devtools] script support for managing source file copyright headers (isle2983)
2016-09-10[devtools] script support for managing source file copyright headersisle2983
Three subcommands to this script: 1) ./copyright_header.py report Examines git-tracked files with extensions that match: INCLUDE = ['*.h', '*.cpp', '*.cc', '*.c', '*.py'] Helps to: -> Identify source files without copyright -> Identify source files added with something other than "The Bitcoin Core developers" holder so we can be sure it is appropriate -> Identify unintentional typos in the copyright line 2) ./copyright_header.py update Replaces fix-copyright-headers.py. It does file editing in native python rather than subprocessing out to perl as was the case with fix-copyright-headers.py. It also shares code with the 'report' functions. 3) ./copyright_header.py insert Inserts a copyright header into a source file with the proper format and dates.
2016-08-27add gen-manpages.sh description to README.mdnomnombtc
2016-08-19[doc] Update git-subtree-check.sh READMEMarcoFalke
2016-04-29[doc] Update bitcoin-core GitHub linksMarcoFalke
2016-01-20devtools: replace github-merge with python versionWladimir J. van der Laan
This is meant to be a direct translation of the bash script, with the difference that it retrieves the PR title from github, thus creating pull messages like: Merge #12345: Expose transaction temperature over RPC
2016-01-19Merge pull request #7280Wladimir J. van der Laan
faeda0e [travis] Run contrib/devtools/check-doc.py early (MarcoFalke) fada0c9 [travis] Fail when documentation is outdated (MarcoFalke)
2016-01-06[contrib] Prepare clang-format-diff for usageMarcoFalke
2016-01-04[travis] Fail when documentation is outdatedMarcoFalke
2015-12-13[devtools] Rewrite fix-copyright-headers.pyMarcoFalke
2015-12-02Update contrib/devtools/README.mdMarcoFalke
* Fix order * Update subtree check
2015-11-04devtools: Update README.mdMarcoFalke
2015-10-15[trivial] Update contrib/devtools/README.mdMarcoFalke
2015-04-02Add git-subtree-check.sh scriptPieter Wuille
2014-12-19Added "Core" to copyright headerssandakersmann
Github-Pull: #5494 Rebased-From: 15de949bb9277e442302bdd8dee299a8d6deee60
2014-05-01devtools: add a script to fetch and postprocess translationsWladimir J. van der Laan
Run this script from the root of the repository to update all translations from transifex. It will do the following automatically: - create a transifex configuration file - fetch all translations - post-process them into valid and committable format
2014-04-25devtools: add script to check symbols from Linux gitian executablesWladimir J. van der Laan
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.
2014-02-09Copyright header updates s/2013/2014 on files whose last git commit was done ↵gubatron
in 2014. contrib/devtools/fix-copyright-headers.py script to be able to perform this maintenance task with ease during the rest of the year, every year. Modifications to contrib/devtools/README.md to document what fix-copyright-headers.py does.
2013-11-24contrib: add sipa's github-merge scriptWladimir J. van der Laan