Add documentation for the -finalizationdelay and -maxreorgdepth args,
set documentation optional for -parkdeepreorg and -replayprotectionactivationtime.
Depends on D2318
Details
Details
- Reviewers
deadalnix - Group Reviewers
Restricted Project - Commits
- rSTAGING708d675bab9a: Complete missing argument documentation
rABC708d675bab9a: Complete missing argument documentation
./contrib/devtools/check-doc.py
Ensure it returns 0 undocumented argument.
./src/bitcoind --help
Check the arguments are correctly documented
Diff Detail
Diff Detail
- Repository
- rABC Bitcoin ABC
- Branch
- argument_documentation
- Lint
Lint Passed - Unit
No Test Coverage - Build Status
Buildable 4543 Build 7149: Bitcoin ABC Buildbot (legacy) Build 7148: arc lint + arc unit
Event Timeline
| 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. |
| 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 ? |
| 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. |
| contrib/devtools/check-doc.py | ||
|---|---|---|
| 41 ↗ | (On Diff #6630) | Could this be left to other diffs ? |
| 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. |