docs: Document lint tests #13708

pull masonicboom wants to merge 1 commits into bitcoin:master from masonicboom:document-lint-tests changing 1 files +27 −4

masonicboom commented at 1:50 am on July 19, 2018: none
fanquake added the label Docs on Jul 19, 2018

in test/README.md:6 in 192685f4db outdated

2@@ -3,17 +3,18 @@ utilities in their entirety. It does not contain unit tests, which
3 can be found in [/src/test](/src/test), [/src/wallet/test](/src/wallet/test),
4 etc.
5 
6-There are currently two sets of tests in this directory:
7+There are currently three sets of tests in this directory:

Empact commented at 5:13 am on July 19, 2018:

nit: how about “the following” - the number isn’t particularly important

masonicboom commented at 4:28 pm on July 19, 2018:

Good point

in test/README.md:192 in 192685f4db outdated

187+
188+The lint tests require a python library called flake8. To install it: `pip3 install flake8`.
189+
190+#### Running the tests
191+
192+Individual tests can be run by directly calling the test script, eg:

practicalswift commented at 7:41 am on July 19, 2018:

Nit: e.g.

masonicboom commented at 4:28 pm on July 19, 2018:

Whoops. Copy-pasta. I’ll fix this and the source

docs: Document lint tests b5f1c28bc7
in test/README.md:204 in 192685f4db outdated
199+ 200+``` 201+test/lint/lint-all.sh 202+``` 203+ 204+NOTE: on macOS you may receive warnings like `grep: empty (sub)expression`. To fix, install GNU grep.
practicalswift commented at 7:42 am on July 19, 2018:

Which scripts trigger this? We should try to fix that.

masonicboom commented at 4:27 pm on July 19, 2018:

lint-locale-dependence.sh. These two lines have this group expression which triggers it (|_r|_s):

https://github.com/bitcoin/bitcoin/blob/master/test/lint/lint-locale-dependence.sh#L202 https://github.com/bitcoin/bitcoin/blob/master/test/lint/lint-locale-dependence.sh#L206

practicalswift commented at 9:06 pm on July 19, 2018:

Thanks! Fixed in #13720 :-)

practicalswift commented at 9:30 pm on September 7, 2018:

Please remove this. It is no longer accurate :-)
masonicboom force-pushed on Jul 19, 2018
MarcoFalke commented at 9:47 pm on August 12, 2018: member

utACK b5f1c28bc7d875681ce5f74ea8e32d601c2557b2, but should wait for the nit
laanwj commented at 10:49 am on August 28, 2018: member

ping @masonicboom, please either update for the nit or reject it
DrahtBot commented at 9:00 pm on September 7, 2018: member
DrahtBot closed this on Sep 7, 2018
DrahtBot reopened this on Sep 7, 2018
MarcoFalke added the label Up for grabs on Sep 14, 2018
fanquake commented at 5:11 am on October 20, 2018: member

Replaced by #14526.
fanquake closed this on Oct 20, 2018
fanquake removed the label Up for grabs on Oct 20, 2018
MarcoFalke referenced this in commit 73cddb36a8 on Oct 21, 2018
PastaPastaPasta referenced this in commit dc425c3fea on Jul 17, 2021
MarcoFalke locked this on Sep 8, 2021

Contributors
masonicboom Empact practicalswift MarcoFalke laanwj DrahtBot fanquake

Labels
Docs