Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rpc: Correctly name arguments #14720

Merged
merged 1 commit into from Nov 13, 2018
Merged

Conversation

@MarcoFalke
Copy link
Member

@MarcoFalke MarcoFalke commented Nov 13, 2018

Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to RPCHelpMan.

The tests should pass with or without the changes in src.

Partly stolen from #14459 (More RPC help description fixes by ch4ot1c)

@MarcoFalke
Copy link
Member Author

@MarcoFalke MarcoFalke commented Nov 13, 2018

@MarcoFalke MarcoFalke force-pushed the Mf1811-rpcNameArguments branch from 5385e4e to fad8314 Nov 13, 2018
@MarcoFalke MarcoFalke force-pushed the Mf1811-rpcNameArguments branch from fad8314 to fa0815c Nov 13, 2018
@meshcollider
Copy link
Member

@meshcollider meshcollider commented Nov 13, 2018

utACK fa0815c

@practicalswift
Copy link
Contributor

@practicalswift practicalswift commented Nov 13, 2018

Concept ACK

Nice cleanup!

@laanwj
Copy link
Member

@laanwj laanwj commented Nov 13, 2018

Makes sense, though I guess the idea eventually would be to use the just-merged RPCHelpMan here?

The tests should pass with or without the changes in src.

Might make sense to split them out to a commit that goes in before the src changes to make this clear.

@MarcoFalke
Copy link
Member Author

@MarcoFalke MarcoFalke commented Nov 13, 2018

By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to RPCHelpMan.

@DrahtBot
Copy link
Contributor

@DrahtBot DrahtBot commented Nov 13, 2018

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #14411 ([wallet] Restore ability to list incoming transactions by label by ryanofsky)
  • #13756 (wallet: "avoid_reuse" wallet flag for improved privacy by kallewoof)
  • #12674 (RPC: Support addnode onetry without making the connection priviliged by luke-jr)
  • #10593 (Relax punishment for peers relaying invalid blocks and headers by luke-jr)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

Copy link
Contributor

@ryanofsky ryanofsky left a comment

utACK fa0815c

@MarcoFalke MarcoFalke merged commit fa0815c into bitcoin:master Nov 13, 2018
1 of 2 checks passed
MarcoFalke added a commit that referenced this issue Nov 13, 2018
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from #14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
@MarcoFalke MarcoFalke deleted the Mf1811-rpcNameArguments branch Nov 13, 2018
deadalnix pushed a commit to Bitcoin-ABC/bitcoin-abc that referenced this issue Feb 13, 2020
Summary:
fa0815c300 rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from #14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c

Backport of Core [[bitcoin/bitcoin#14720 | PR14720]]
bitcoin/bitcoin#14720

Test Plan:
  ninja check
  ninja check-functional

  ./bitcoind
  ./bitcoin-cli help waitforblockheight
  ./bitcoin-cli help getblockheader
  ./bitcoin-cli help pruneblockchain
  ./bitcoin-cli help getchaintxstats
  ./bitcoin-cli help scantxoutset
  ./bitcoin-cli help prioritisetransaction
  ./bitcoin-cli help getblocktemplate
  ./bitcoin-cli help addnode
  ./bitcoin-cli help disconnectnode
  ./bitcoin-cli help setban
  ./bitcoin-cli help setnetworkactive
  ./bitcoin-cli help uptime
  ./bitcoin-cli help importprunedfunds
  ./bitcoin-cli help importmulti
  ./bitcoin-cli help getbalance
  ./bitcoin-cli help listtransactions
Verify help text

  ./bitcoin-cli uptime <anything>
Verify this fails with error code -1 and then displays the help message.

Reviewers: O1 Bitcoin ABC, #bitcoin_abc, Fabien

Reviewed By: O1 Bitcoin ABC, #bitcoin_abc, Fabien

Differential Revision: https://reviews.bitcoinabc.org/D5281
Munkybooty added a commit to Munkybooty/dash that referenced this issue Jul 29, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
Munkybooty added a commit to Munkybooty/dash that referenced this issue Aug 3, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
Munkybooty added a commit to Munkybooty/dash that referenced this issue Aug 5, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
Munkybooty added a commit to Munkybooty/dash that referenced this issue Aug 8, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
Munkybooty added a commit to Munkybooty/dash that referenced this issue Aug 9, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
Munkybooty added a commit to Munkybooty/dash that referenced this issue Aug 11, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
5tefan added a commit to 5tefan/dash that referenced this issue Aug 12, 2021
fa0815c rpc: Correctly name arguments (Jon Layton)

Pull request description:

  Consistently use the same name to describe arguments in the documentation and add a test that uses the name.

  By splitting it up, the changes are easier to potentially backport and also make review easier when we switch to `RPCHelpMan`.

  The tests should pass with or without the changes in `src`.

  Partly stolen from bitcoin#14459 (More RPC help description fixes by ch4ot1c)

Tree-SHA512: 1072992b1e93ac41006613523e54a0a8004f529fcb101eb9d74d91474abb0945a5a7539f249905151b904b87448f9efc0cacbd9e052fbe2ea9111e62f3e7249c
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Sep 8, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

7 participants