Update README.md inside of src/test/ #8428

pull Christewart wants to merge 1 commits into bitcoin:master from Christewart:imporve_test_readme changing 1 files +9 −12

Christewart commented at 4:53 PM on July 29, 2016: member

Improves clarity for README in the test directory
sipa commented at 7:39 PM on July 29, 2016: member

Can you stick to the text width of 80 characters, and provide a more accurate commit message? Also, it's not improving clarify - the original text in README.md right now is simply wrong and this PR fixes it.
Christewart renamed this:
~~Update README.md~~
Update README.md inside of src/test/
on Jul 30, 2016

in src/test/README.md:None in 242d886196 outdated

  21 | +test_bitcoin.cpp. To add a new unit test file to our test suite you need 
  22 | +to add the file to `src/Makefile.test.include`.  The pattern is to create 
  23 | +one test file for each class or source file for which you want to create 
  24 | +unit tests.  The file naming convention is `<source_filename>_tests.cpp` 
  25 | +and such files should wrap their tests in a test suite 
  26 | +called `<source_filename>_tests`. For an examples of this pattern,

paveljanik commented at 7:31 PM on July 30, 2016:

an example

in src/test/README.md:None in 242d886196 outdated

  17 | -examples of this pattern, examine uint160_tests.cpp and
  18 | -uint256_tests.cpp.
  19 | -
  20 | -Add the source files to /src/Makefile.test.include to add them to the build.
  21 | +test_bitcoin.cpp. To add a new unit test file to our test suite you need 
  22 | +to add the file to `src/Makefile.test.include`.  The pattern is to create

paveljanik commented at 7:31 PM on July 30, 2016:

two spaces?

paveljanik commented at 7:32 PM on July 30, 2016: contributor

Please squash all commits after fixing nits.

Update README.md

Updating documentation for adding new unit test files

Removing unneeded sentence from README

Removing uint160_tests.cpp as it DNE

Formatting command line instructions to use ``

fixing 80 char formatting issue in README

fixing more nits

b8db185952

Christewart force-pushed on Jul 31, 2016
Christewart commented at 8:45 PM on July 31, 2016: member

For some reason I couldn't squash to a more descriptive commit message, I tried following bitcoin core's guide and got an error saying I couldn't pick the specific commit I wanted to show
MarcoFalke commented at 9:05 PM on July 31, 2016: member

try git commit --amend
laanwj merged this on Aug 3, 2016
laanwj closed this on Aug 3, 2016
laanwj referenced this in commit fc93486d2a on Aug 3, 2016
luke-jr referenced this in commit 9b0097976f on Sep 21, 2016
codablock referenced this in commit 4c7ec86138 on Sep 19, 2017
codablock referenced this in commit d374a2af94 on Dec 29, 2017
codablock referenced this in commit 7c62457e6f on Jan 8, 2018
lateminer referenced this in commit 941baa9eb5 on Nov 11, 2018
andvgal referenced this in commit 4da07f6da3 on Jan 6, 2019
DrahtBot locked this on Sep 8, 2021

Contributors