Fix command line help for -printtoconsole and -debuglogfile #13589

pull satwo wants to merge 9 commits into bitcoin:master from satwo:master changing 2 files +3 −2
  1. satwo commented at 8:07 PM on July 2, 2018: contributor

    #13004 changed the default behavior for -printtoconsole but this has not been reflected in the command line help.

    This fixes the description of -printtoconsole to reflect this change, and also provides the user with missing information on how to explicitly disable logging to debug.log.

    At present I have made the latter update to two separate places (-printtoconsole and -debuglogfile) because a user looking for information on how to disable logging is probably going to look in the "Debugging/Testing Options" section. Moving -debuglogfile from the "General" options category to the "Debugging/Testing" section could potentially remove the need for this redundancy, but is probably out of the scope of this PR.

  2. Fix command line help for -printtoconsole and -debuglogfile
    #13004 changed the default behavior for printtoconsole but this has not been reflected in the command line help.

This fixes the description of -printtoconsole to reflect this change, and also provides the user with missing information on how to explicitly disable logging to debug.log.

At present I have made the latter update to two separate places (-printtoconsole and -debuglogfile) because a user looking for information on how to disable logging is probably going to look in the "Debugging/Testing Options" section. Moving -debuglogfile from the "General" options category to the "Debugging/Testing" section could potentially remove the need for this redundancy but may be out of the scope of this PR.
    5e59bb2502
  3. fanquake added the label Docs on Jul 3, 2018
  4. sipa commented at 6:56 PM on July 3, 2018: member

    utACK 5e59bb250272447362fa9ae573d201a02afe1edf. Does this need release notes as well?

  5. satwo commented at 7:17 PM on July 3, 2018: contributor

    Added release notes for #13004 to 0.16.1.

  6. Add release notes for #13004 749b5864dd
  7. Fix ordering of release notes 20622f93bf
  8. promag commented at 9:11 PM on July 3, 2018: member

    Travis error (unrelated):

    wallet_encryption.py failed, Duration: 3 s
stdout:
2018-07-03T20:07:21.836000Z TestFramework (INFO): Initializing test directory /tmp/bitcoin_test_runner_20180703_200428/wallet_encryption_16
2018-07-03T20:07:24.958000Z TestFramework (ERROR): Assertion failed
Traceback (most recent call last):
  File "/home/travis/build/bitcoin/bitcoin/build/bitcoin-x86_64-unknown-linux-gnu/test/functional/test_framework/test_framework.py", line 160, in main
    self.run_test()
  File "/home/travis/build/bitcoin/bitcoin/build/bitcoin-x86_64-unknown-linux-gnu/test/functional/wallet_encryption.py", line 45, in run_test
    assert_raises_rpc_error(-13, "Please enter the wallet passphrase with walletpassphrase first", self.nodes[0].dumpprivkey, address)
  File "/home/travis/build/bitcoin/bitcoin/build/bitcoin-x86_64-unknown-linux-gnu/test/functional/test_framework/util.py", line 105, in assert_raises_rpc_error
    assert try_rpc(code, message, fun, *args, **kwds), "No exception raised"
AssertionError: No exception raised
2018-07-03T20:07:25.016000Z TestFramework (INFO): Stopping nodes
2018-07-03T20:07:25.118000Z TestFramework (WARNING): Not cleaning up dir /tmp/bitcoin_test_runner_20180703_200428/wallet_encryption_16
2018-07-03T20:07:25.119000Z TestFramework (ERROR): Test failed. Test logging available at /tmp/bitcoin_test_runner_20180703_200428/wallet_encryption_16/test_framework.log
2018-07-03T20:07:25.119000Z TestFramework (ERROR): Hint: Call /home/travis/build/bitcoin/bitcoin/build/bitcoin-x86_64-unknown-linux-gnu/test/functional/combine_logs.py '/tmp/bitcoin_test_runner_20180703_200428/wallet_encryption_16' to consolidate all logs

    I've restarted it.

    BTW, squash commits (at least the last 2).

  9. Revert "Fix ordering of release notes"
    This reverts commit 20622f93bf11f397c9d4991f182fef6ab5371f43.
    2f64955df9
  10. Revert "Add release notes for #13004"
    This reverts commit 749b5864dd666a3808a5cfef74bfa7356cf978dc.
    6ac98f8ae4
  11. Revert "Fix command line help for -printtoconsole and -debuglogfile"
    This reverts commit 5e59bb250272447362fa9ae573d201a02afe1edf.
    35097dbfe5
  12. Fix command line help for -printtoconsole and -debuglogfile; add release notes 49fcdb0512
  13. satwo commented at 10:39 PM on July 3, 2018: contributor

    Thanks, Promag. Working on squashing these into a single commit...

  14. Squash commits f52734a552
  15. Merge branch 'master' of https://github.com/satwo/bitcoin 9371c1f792
  16. satwo commented at 2:13 AM on July 4, 2018: contributor

    Well, my inexperience with Git is showing. All relevant changes have been squashed into f52734a, but I don't know how to get rid of the other 8 commits.

  17. in doc/release-notes/release-notes-0.16.1.md:113 in 9371c1f792 
     109 | @@ -110,6 +110,7 @@ weights.
 110 |  - #12442 `f3b8d85` devtools: Exclude patches from lint-whitespace (MarcoFalke)
 111 |  - #12988 `acdf433` Hold cs_main while calling UpdatedBlockTip() signal (skeees)
 112 |  - #12985 `0684cf9` Windows: Avoid launching as admin when NSIS installer ends. (JeremyRand)
 113 | +- #13004 `6a3b0d3` Print to console by default when not run with -daemon (practicalswift)
    laanwj commented at 12:50 PM on July 4, 2018:

    Did you intend to update the historical release notes for 0.16.1?

    satwo commented at 2:56 PM on July 8, 2018:

    Sorry for the late reply. I did intend that, because I figured the changes went into effect in 0.16.1 and that was the version that I was having problems with.

  18. laanwj commented at 12:53 PM on July 4, 2018: member

    Added release notes for #13004 to 0.16.1.

    This is wrong, #13004 isn't in 0.16.1. If you want to add to the release notes for the next release you need to update doc/release-notes.md. There, you can mention that the interpretation of -printtoconsole and -debuglogfile changed in a seperate section.

  19. randolf approved
  20. MarcoFalke commented at 8:01 AM on July 8, 2018: member

    @satwo Are you still working on this?

  21. MarcoFalke added the label Up for grabs on Jul 8, 2018
  22. fanquake commented at 1:17 PM on July 8, 2018: member

    I've rebased and PR'd a version of this with the release note changes removed in #13614. @satwo Your changes are still attributed to you there.

  23. fanquake closed this on Jul 8, 2018
  24. fanquake removed the label Up for grabs on Jul 8, 2018
  25. satwo commented at 2:26 PM on July 8, 2018: contributor

    Sorry; have been traveling the last few days and hadn't had the opportunity to complete this. Thank you @fanquake for rebasing and fixing the release note changes.

  26. laanwj referenced this in commit 17e9106c86 on Jul 9, 2018
  27. PastaPastaPasta referenced this in commit ab41ac7b6e on Jul 17, 2020
  28. PastaPastaPasta referenced this in commit b837837ea6 on Jul 17, 2020
  29. PastaPastaPasta referenced this in commit 2222a9b9f5 on Jul 17, 2020
  30. MarcoFalke locked this on Sep 8, 2021
Contributors
satwosipapromaglaanwjrandolfMarcoFalkefanquake
Labels
Docs
Linked (view graph)
#13004 Print to console by default when not run with -daemon#13614 doc: Update command line help for -printtoconsole and -debuglogfile (satwo)
github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-13 21:15 UTC
This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me