mirror of
https://github.com/bitcoin/bitcoin.git
synced 2024-11-20 10:38:42 +01:00
6342348072
bbbbdb0cd5ci: Add filesystem lint check (MarcoFalke)fada2f9110refactor: Replace <filesystem> with <util/fs.h> (MarcoFalke) Pull request description: Using `std::filesystem` is problematic: * There is a `fs` namespace wrapper for it. So having two ways to achieve the same is confusing. * Not using the `fs` wrapper is dangerous and buggy, because it disables known bugs by deleting problematic functions. Fix all issues by removing use of it and adding a linter to avoid using it again in the future. ACKs for top commit: TheCharlatan: ACKbbbbdb0cd5fanquake: ACKbbbbdb0cd5🦀 Tree-SHA512: 0e2d49742b08eb2635e6fce41485277cb9c40fe20b81017c391d3472a43787db1278a236825714ca1e41c9d2f59913865cfb0c649e3c8ab1fb598c849f80c660
66 lines
2.2 KiB
Markdown
66 lines
2.2 KiB
Markdown
This folder contains lint scripts.
|
|
|
|
Running locally
|
|
===============
|
|
|
|
To run linters locally with the same versions as the CI environment, use the included
|
|
Dockerfile:
|
|
|
|
```sh
|
|
DOCKER_BUILDKIT=1 docker build -t bitcoin-linter --file "./ci/lint_imagefile" ./ && docker run --rm -v $(pwd):/bitcoin -it bitcoin-linter
|
|
```
|
|
|
|
Building the container can be done every time, because it is fast when the
|
|
result is cached and it prevents issues when the image changes.
|
|
|
|
test runner
|
|
===========
|
|
|
|
To run the checks in the test runner outside the docker, use:
|
|
|
|
```sh
|
|
( cd ./test/lint/test_runner/ && cargo fmt && cargo clippy && cargo run )
|
|
```
|
|
|
|
check-doc.py
|
|
============
|
|
Check for missing documentation of command line options.
|
|
|
|
commit-script-check.sh
|
|
======================
|
|
Verification of [scripted diffs](/doc/developer-notes.md#scripted-diffs).
|
|
Scripted diffs are only assumed to run on the latest LTS release of Ubuntu. Running them on other operating systems
|
|
might require installing GNU tools, such as GNU sed.
|
|
|
|
git-subtree-check.sh
|
|
====================
|
|
Run this script from the root of the repository to verify that a subtree matches the contents of
|
|
the commit it claims to have been updated to.
|
|
|
|
```
|
|
Usage: test/lint/git-subtree-check.sh [-r] DIR [COMMIT]
|
|
test/lint/git-subtree-check.sh -?
|
|
```
|
|
|
|
- `DIR` is the prefix within the repository to check.
|
|
- `COMMIT` is the commit to check, if it is not provided, HEAD will be used.
|
|
- `-r` checks that subtree commit is present in repository.
|
|
|
|
To do a full check with `-r`, make sure that you have fetched the upstream repository branch in which the subtree is
|
|
maintained:
|
|
* for `src/secp256k1`: https://github.com/bitcoin-core/secp256k1.git (branch master)
|
|
* for `src/leveldb`: https://github.com/bitcoin-core/leveldb-subtree.git (branch bitcoin-fork)
|
|
* for `src/crypto/ctaes`: https://github.com/bitcoin-core/ctaes.git (branch master)
|
|
* for `src/crc32c`: https://github.com/bitcoin-core/crc32c-subtree.git (branch bitcoin-fork)
|
|
* for `src/minisketch`: https://github.com/sipa/minisketch.git (branch master)
|
|
|
|
To do so, add the upstream repository as remote:
|
|
|
|
```
|
|
git remote add --fetch secp256k1 https://github.com/bitcoin-core/secp256k1.git
|
|
```
|
|
|
|
all-lint.py
|
|
===========
|
|
Calls other scripts with the `lint-` prefix.
|