Page MenuHomePhabricator

Complete missing argument documentation
ClosedPublic

Authored by Fabien on Jan 12 2019, 13:18.

Details

Reviewers
deadalnix
Group Reviewers
Restricted Project
Commits
rABC708d675bab9a: Complete missing argument documentation
Summary

Add documentation for the -finalizationdelay and -maxreorgdepth args,
set documentation optional for -parkdeepreorg and -replayprotectionactivationtime.

Depends on D2318

Test Plan
./contrib/devtools/check-doc.py

Ensure it returns 0 undocumented argument.

./src/bitcoind --help

Check the arguments are correctly documented

Diff Detail

Repository
rABC Bitcoin ABC
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Fabien created this revision.Jan 12 2019, 13:18
Herald added a reviewer: Restricted Project. · View Herald TranscriptJan 12 2019, 13:18
Herald added a subscriber: schancel. · View Herald Transcript
deadalnix requested changes to this revision.Jan 14 2019, 16:24
deadalnix added inline comments.
contrib/devtools/check-doc.py
41 ↗(On Diff #6630)

You should remove this configuration. Unless that script is able to tell you when a flag in there is no found in the codebase.

src/init.cpp
411 ↗(On Diff #6630)

The different arguments are grouped by function in there. For instance, all the log help messages about logging are together. It follows that these two should be together.

This revision now requires changes to proceed.Jan 14 2019, 16:24
Fabien added inline comments.Jan 15 2019, 07:38
contrib/devtools/check-doc.py
41 ↗(On Diff #6630)

I'm not sure I understand your concern here. There is no consequence on the script if one of these flags get removed from the codebase, if this is what you mean ?
Warning about the flag not found in the code would be pretty simple too.

Fabien updated this revision to Diff 6664.Jan 15 2019, 07:48

Group the documented args

deadalnix added inline comments.Jan 15 2019, 11:36
contrib/devtools/check-doc.py
41 ↗(On Diff #6630)

This argument needs to go from the codebase. It's sole purpose is to test the activation of the fork and the fork activated 3 month ago.

Fabien added inline comments.Jan 15 2019, 12:18
contrib/devtools/check-doc.py
41 ↗(On Diff #6630)

Could this be left to other diffs ?

deadalnix added inline comments.Jan 15 2019, 12:52
contrib/devtools/check-doc.py
41 ↗(On Diff #6630)

It probably should, but this will not go away and likely not be noticed by whoever does the cleanup.

Fabien updated this revision to Diff 6691.Jan 16 2019, 10:08

Rebase on top of D2318 to remove -magneticanomalyactivationtime

deadalnix accepted this revision.Jan 17 2019, 00:55
This revision is now accepted and ready to land.Jan 17 2019, 00:55
Fabien updated this revision to Diff 6826.Jan 22 2019, 16:12

Rebase

This revision was automatically updated to reflect the committed changes.