Page MenuHomePhabricator

Lexically order the arguments documentation
AbandonedPublic

Authored by Fabien on Jan 11 2019, 16:58.

Details

Reviewers
Mengerian
deadalnix
Group Reviewers
Restricted Project
Summary

The arguments documentations should be lexically ordered inside their
category. The only exceptions are -? and -version which are kept in
first position (some kind documentation shortcut).
This will make it easier to add missing documentation.

Test Plan
./autogen.sh
mkdir build
cd build
../configure --enable-debug

Ensure that all the optional features are activated (all yes)

make -j<your machine number of logic core>
./src/bitcoind --help

Check all the arguments are documented in lexical ordering inside their
category (excepted -? and -version)

Diff Detail

Repository
rABC Bitcoin ABC
Branch
help_reorder
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 4486
Build 7035: Bitcoin ABC Teamcity Staging
Build 7034: arc lint + arc unit

Event Timeline

Fabien created this revision.Jan 11 2019, 16:58
Herald added a reviewer: Restricted Project. · View Herald TranscriptJan 11 2019, 16:58
Herald added a subscriber: schancel. · View Herald Transcript
deadalnix requested changes to this revision.Jan 11 2019, 17:07

Just don't do this. It'll just create a ton of merge conflict and "The arguments documentations should be lexically ordered inside their category." is really not a good reason.

This revision now requires changes to proceed.Jan 11 2019, 17:07
Fabien abandoned this revision.Jan 11 2019, 17:28