Fix help-debug -checkpoints #17286

pull ariard wants to merge 1 commits into bitcoin:master from ariard:2019-10-comment-validation changing 1 files +1 −1

ariard commented at 6:50 PM on October 28, 2019: member

No description provided.
fanquake added the label Docs on Oct 28, 2019

in src/validation.h:113 in d870553694 outdated

 104 | @@ -105,17 +105,22 @@ static const int64_t BLOCK_DOWNLOAD_TIMEOUT_BASE = 1000000;
 105 |  /** Additional block download timeout per parallel downloading peer (i.e. 5 min) */
 106 |  static const int64_t BLOCK_DOWNLOAD_TIMEOUT_PER_PEER = 500000;
 107 |  
 108 | +/** Default for -maxtipage, maximum tip age in seconds to consider node in initial block download. */
 109 |  static const int64_t DEFAULT_MAX_TIP_AGE = 24 * 60 * 60;
 110 |  /** Maximum age of our tip in seconds for us to be considered current for fee estimation */
 111 |  static const int64_t MAX_FEE_ESTIMATION_TIP_AGE = 3 * 60 * 60;
 112 |  
 113 | +/** Default for -checkpoints, enable skipping verification of known chain history until block 295000. */

jnewbery commented at 8:54 PM on October 28, 2019:

That's not what checkpoints do :slightly_smiling_face:

MarcoFalke commented at 8:59 PM on October 28, 2019:

To be fair the -help-debug was never updated either

MarcoFalke commented at 9:03 PM on October 28, 2019:

See:

ariard commented at 9:14 PM on October 28, 2019:

Oh you're right, I've double-down on the error already there in the help-debug. Fixed both

ariard force-pushed on Oct 28, 2019
laanwj commented at 10:39 AM on October 30, 2019: member

Thanks for adding documentation, though I'm not sure it's a good idea to duplicate command line option documentation when documenting defaults. This will tend to go out of sync. ~0 on this.
MarcoFalke commented at 1:41 PM on October 30, 2019: member

Might be fine to just say "default for -foobar"
ariard commented at 4:45 PM on October 30, 2019: member

@laanwj yes I was a bit dubious at first because as you they can fall out of sync easily but then I noticed than some of them were already commented like DEFAULT_MIN_RELAY_TX_FEE and DEFAULT_ANCESTOR_LIMIT. Was willingly to be consistent there, and that's still less code to grep when you're trying to understand what these values are doing.
jnewbery commented at 7:14 PM on October 30, 2019: member

I'm with @laanwj on this one. Duplicating comments seems unnecessary, and adds the potential for them to go out of sync.
MarcoFalke commented at 7:39 PM on October 30, 2019: member

git grep -C 1 '\-persistmempool\>' src can be used to display the default value and the help text, so no need to duplicate it
Fix incorrect help-debug for -checkpoints a8b82867d5
ariard force-pushed on Oct 30, 2019
ariard commented at 10:32 PM on October 30, 2019: member

Okay no worries, curtailed commit to just fixing -checkpoints help-debug if people don't think duplicating comment is necessary.
ariard renamed this:
~~doc: Add/extend comments for user-tunable values in validation.h~~
Fix help-debug -checkpoints
on Oct 30, 2019
jnewbery commented at 6:38 PM on October 31, 2019: member

I think the default for -option code comments are useful, just not repeating the help text. I'd support you adding those.

ACK a8b82867d544d221de00f6a0e26dbcc389326629 for improving the -prune help text.
MarcoFalke commented at 6:42 PM on October 31, 2019: member

ACK a8b82867d544d221de00f6a0e26dbcc389326629
laanwj referenced this in commit b54666c849 on Nov 1, 2019
laanwj merged this on Nov 1, 2019
laanwj closed this on Nov 1, 2019
sidhujag referenced this in commit 5f4f92fee7 on Nov 1, 2019
sidhujag referenced this in commit 5e82495c48 on Nov 10, 2020
DrahtBot locked this on Dec 16, 2021

Contributors

Labels