Paths

Table of Contentst

Pass rpc/mining RPC argument descriptions to RPCHelpMan
ClosedPublic
Actions

Authored by nakihito on Apr 13 2020, 18:41.

Details

Reviewers

Group Reviewers

Restricted Owners Package	(Owns No Changed Paths)
Restricted Project

Commits

rSTAGING28c8d7fa85b5: Pass rpc/mining RPC argument descriptions to RPCHelpMan
rABC28c8d7fa85b5: Pass rpc/mining RPC argument descriptions to RPCHelpMan

Summary

PR14796 changes the help text of the dummy argument in
prioritisetransaction from optional to required. PR14785 was added to
prevent this.

Merge #14875: RPCHelpMan: Support required arguments after optional ones

fa9a5bc1a0 RPCHelpMan: Support required arguments after optional ones (MarcoFalke)

Pull request description:

There was a requirement that required arguments could not be positioned after an optional argument, but the deprecation of priority made the second argument to `prioritisetransaction` optional. So support that in `RPCHelpMan`.

Also format all named arguments in the same way (without the wrapping `"` even for strings), since the extended description already mentions the type and it feels odd to special case strings.

Tree-SHA512: c125145afb4a63abc995aaf0a89489efc0f470a720727a1ca6ee0bfd2bcbc59e87c38128dd1e0cdf03dbb5b18e84867887c3dabf6ec8378e66cb1f4cecb9e407

Partial backport of Core PR14796 and PR14875

Test Plan

mkdir master
mkdir patched

On master:

ninja
./bitcoind
./bitcoin-cli help > RPCs
./getrpchelps.sh RPCs master

On the patched branch:

ninja
./bitcoind
./getrpchelps.sh RPCs patched
./checkrpc.sh RPCs master patched D5714diff

Verify the changes in D5714diff.

Scripts:

getrpchelps.sh231 BDownload

checkrpc.sh489 BDownload

D5714diff:

D5714diff3 KBDownload

Diff Detail

Repository

rABC Bitcoin ABC

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

nakihito created this revision.Apr 13 2020, 18:41

Owners added a reviewer: Restricted Owners Package.Apr 13 2020, 18:41

Herald added a reviewer: Restricted Project. · View Herald TranscriptApr 13 2020, 18:41

nakihito planned changes to this revision.Apr 13 2020, 18:41

[Bot Message]
One or more PR numbers were detected in the summary.
Links to those PRs have been inserted into the summary for reference.

Build Bitcoin-ABC / Diffs / Diff Testing (build-diff) started.

nakihito edited the summary of this revision. (Show Details)Apr 13 2020, 18:42

nakihito edited the test plan for this revision. (Show Details)

Build Bitcoin-ABC / Diffs / Diff Testing (build-diff) passed.

Harbormaster completed remote builds in B10197: Diff 18773.Apr 13 2020, 18:52

nakihito edited the test plan for this revision. (Show Details)Apr 13 2020, 23:08

nakihito requested review of this revision.Apr 13 2020, 23:15

nakihito added a child revision: D5726: Complete PR14796 by cleaning up some old functions and names.Apr 14 2020, 00:20

nakihito edited the test plan for this revision. (Show Details)Apr 14 2020, 00:36

Fabien accepted this revision.Apr 14 2020, 11:50

This revision is now accepted and ready to land.Apr 14 2020, 11:50

Closed by commit rABC28c8d7fa85b5: Pass rpc/mining RPC argument descriptions to RPCHelpMan (authored by nakihito). · Explain WhyApr 15 2020, 20:24

This revision was automatically updated to reflect the committed changes.

nakihito added a commit: rABC28c8d7fa85b5: Pass rpc/mining RPC argument descriptions to RPCHelpMan.

nakihito added a commit: rSTAGING28c8d7fa85b5: Pass rpc/mining RPC argument descriptions to RPCHelpMan.May 5 2020, 18:58

Revision Contents
Changeset List

Path

Size

src/

rpc/

mining.cpp

181 lines

util.cpp

24 lines

Diff 18839

View Options

src/rpc/mining.cpp