Page MenuHomePhabricator
Differential D6231

Merge #15746: rpc: RPCHelpMan: Always name dictionary keys
ClosedPublic
Actions

Authored by nakihito on May 22 2020, 20:46.

Details

Reviewers
deadalnix
Group Reviewers
Restricted Owners Package(Owns No Changed Paths)
Restricted Project
Commits
rABC2429c346e2ed: Merge #15746: rpc: RPCHelpMan: Always name dictionary keys
Summary

fa26eb5e8f rpc: RPCHelpMan: Always push_name when outer type is an object (MarcoFalke)
fa652b229e rpc: Add some doxygen comments to utils (MarcoFalke)

Pull request description:

Fixes two issues reported in #15737:

* > I am very perplexed as to how the code I'm looking at is generating the help text I'm seeing

So add documentation

* > This is a value for which a key is missing

So always serialize the name of the dictionary key if the outer type is a dictionary

ACKs for commit fa26eb:

promag:
  Tested ACK fa26eb5.

Tree-SHA512: b6f0cee1f1123d245d4902e8e113b5260cae7f2cb39c9bfb8893c5b0b33ffb6349ad05813d560d39a94ccf655399c05fcda15d9b0733e6bd696538fe0aca7021

Backport of Core PR15746

Test Plan

On master:

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

Then on the patched branch:

ninja
./bitcoind
./getrpchelps.sh RPCs patched
./checkrpc.sh RPCs master patched help.diff

Verify changes in help.diff.

Scripts:

getrpchelps.sh231 BDownload

checkrpc.sh489 BDownload

help.diff:

help.diff885 BDownload

Diff Detail

Event Timeline

nakihito created this revision.May 22 2020, 20:46
Owners added a reviewer: Restricted Owners Package.May 22 2020, 20:46
Herald added a reviewer: Restricted Project. · View Herald TranscriptMay 22 2020, 20:46
nakihito requested review of this revision.May 22 2020, 20:46
nakihito planned changes to this revision.
teamcity edited the summary of this revision. (Show Details)May 22 2020, 20:46

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

teamcity added a comment.May 22 2020, 20:47

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

teamcity added a comment.May 22 2020, 20:47

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

teamcity added a comment.May 22 2020, 20:47

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

nakihito requested review of this revision.May 22 2020, 20:48
nakihito edited the summary of this revision. (Show Details)
nakihito edited the test plan for this revision. (Show Details)
teamcity added a comment.May 22 2020, 20:49

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

teamcity added a comment.May 22 2020, 20:50

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

teamcity added a comment.May 22 2020, 20:56

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

Harbormaster completed remote builds in B10991: Diff 20545.May 22 2020, 20:56
deadalnix accepted this revision.May 22 2020, 21:17
deadalnix edited the summary of this revision. (Show Details)
This revision is now accepted and ready to land.May 22 2020, 21:18
Closed by commit rABC2429c346e2ed: Merge #15746: rpc: RPCHelpMan: Always name dictionary keys (authored by MarcoFalke <falke.marco@gmail.com>, committed by nakihito). · Explain WhyMay 22 2020, 21:33
This revision was automatically updated to reflect the committed changes.
nakihito added a commit: rABC2429c346e2ed: Merge #15746: rpc: RPCHelpMan: Always name dictionary keys.

Revision Contents
Changeset List

PathSize
src/
rpc/
39 lines

Diff 20545

View Options

src/rpc/util.cpp

Loading...