docs: Clarifying testing instructions #15127

pull benthecarman wants to merge 1 commits into bitcoin:master from benthecarman:docs-clarifying-test-notes changing 1 files +2 −1

benthecarman commented at 12:05 PM on January 8, 2019: contributor

This statement confused me on my first time reading through. Hopefully, this addition will help someone else on their first time.
fanquake added the label Docs on Jan 8, 2019
sipa commented at 12:39 PM on January 8, 2019: member

Is this needed? I never use those options
benthecarman commented at 12:42 PM on January 8, 2019: contributor

Is this needed? I never use those options

If that's true it might be better to change it to say something like "Be sure not to disable wallet, utils, and daemon, the default is recommended."
fanquake commented at 3:13 PM on January 8, 2019: member

If the sentence is confusing I'd rather we just remove it. I don't think we need to add explicit documentation for options that are enabled by default.
laanwj commented at 3:48 PM on January 8, 2019: member

Also tend to NACK. The tests are built by default, on purpose. It is a matter of following the build steps for whatever platform, no need to duplicate the configure command-line here.
benthecarman force-pushed on Jan 8, 2019
benthecarman commented at 4:15 PM on January 8, 2019: contributor

Changed it so it now gives a link to build instructions instead
jnewbery commented at 4:33 PM on January 8, 2019: member

"Before tests can be run locally, your system must be built." isn't correct. You need to build bitcoind for your system (eg linux, macos, etc), not build your system.

ACK adding a reference to the build instructions.
benthecarman force-pushed on Jan 8, 2019
benthecarman force-pushed on Jan 8, 2019
jonasschnelli commented at 11:39 PM on January 8, 2019: contributor

ACK 127e37e7fcd426c990a6e4c49af9d1c35e76d384
fanquake commented at 11:50 PM on January 8, 2019: member

utACK 127e37e
docs: Clarifying testing instructions ef5ebc6d8f

in test/README.md:21 in 127e37e7fc outdated

  17 | @@ -18,7 +18,8 @@ request is opened. All sets of tests can also be run locally.
  18 |  
  19 |  # Running tests locally
  20 |  
  21 | -Build for your system first. Be sure to enable wallet, utils and daemon when you configure. Tests will not run otherwise.
  22 | +Before tests can be run locally, Bitcoin Core must be built.  See [#building](/doc#building) for help.

hebasto commented at 4:27 PM on January 9, 2019:

Why is hash-sign used here [#building]? Could be [building instructions] ?

benthecarman force-pushed on Jan 9, 2019
jnewbery commented at 5:48 PM on January 9, 2019: member

ACK ef5ebc6d8f11f86ae53f18ef6a20bddbf73ef4e1
hebasto commented at 7:50 PM on January 9, 2019: member

utACK ef5ebc6d8f11f86ae53f18ef6a20bddbf73ef4e1
MarcoFalke merged this on Jan 9, 2019
MarcoFalke closed this on Jan 9, 2019
MarcoFalke referenced this in commit 5da08e0ac5 on Jan 9, 2019
benthecarman deleted the branch on Feb 8, 2019
PastaPastaPasta referenced this in commit 9257714e85 on Jun 26, 2021
PastaPastaPasta referenced this in commit 36343da091 on Jun 28, 2021
DrahtBot locked this on Dec 16, 2021

Contributors

Labels