Skip to content

Use RPCHelpMan for most RPCs

Dagur Valberg Johannsson requested to merge dagurval/bitcoin-cash-node:rpchelpman into master

This is a partial cherry-pick of PR14726.

Some of the more difficult conflicts were skipped. Help strings for RPC calls unique to BCHN have not been converted.

I kept the Core syntax styling, as 1) it will make it easier to port additional improvements to RPCHelpMan, and 2) the style inherited from previous project didn't reformat help text properly, but rather just chopped strings at 80 chars, making a big mess.

Remaining methods can be incrementally converted. The task conversion task is very well defined, so perhaps using bounties?

Test plan

Observe that the help output is not changed for the worse. There are some improvements.

  1. Revert this change and build bitcoind (ninja bitcoind)
  2. Run ./gen-manpages.sh from contrib/devtools
  3. Commit documentation changes git stage -u && git commit -m test. This is the RPC documentation before the patch.
  4. Revert the revert (step 1) and build bitcoind
  5. Run ./gen-manpages.sh from contrib/devtools
  6. Run git diff to observe there are no changes

My diff is posted in a comment in this MR.

Edited by Dagur Valberg Johannsson

Merge request reports