doc: Clarify rpcwallet flag url change #14448

1. 
   JBaczuk commented at 7:49 pm on October 9, 2018: contributor

   This adds clarification to the bitcoin-cli -rpcwallet flag in the help command. This will benefit users who want to utilize this feature without the cli, for example curl. It isn’t readily apparent that this changes the url used in the RPC call.
2. clarify rpcwallet flag url change 0c69ff6171
3. in src/bitcoin-cli.cpp:54 in 0c69ff6171

   50@@ -51,7 +51,7 @@ static void SetupCliArgs()
   51     gArgs.AddArg("-rpcport=<port>", strprintf("Connect to JSON-RPC on <port> (default: %u, testnet: %u, regtest: %u)", defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort(), regtestBaseParams->RPCPort()), false, OptionsCategory::OPTIONS);
   52     gArgs.AddArg("-rpcuser=<user>", "Username for JSON-RPC connections", false, OptionsCategory::OPTIONS);
   53     gArgs.AddArg("-rpcwait", "Wait for RPC server to start", false, OptionsCategory::OPTIONS);
   54-    gArgs.AddArg("-rpcwallet=<walletname>", "Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to bitcoind)", false, OptionsCategory::OPTIONS);
   55+    gArgs.AddArg("-rpcwallet=<walletname>", "Send RPC for non-default wallet on RPC server (needs to exactly match corresponding -wallet option passed to bitcoind). This changes the RPC endpoint used, e.g. http://127.0.0.1:8332/wallet/<walletname>", false, OptionsCategory::OPTIONS);
   

   ---

   ---

   

   promag commented at 9:13 pm on October 9, 2018:

   Is this relevant from the bitcoin-cli user’s point of view? At least I’d drop the e.g. ... part here.

   ---

   

   JBaczuk commented at 3:11 am on October 10, 2018:

   I’m not sure the best place for this, but I think an example url would be helpful somewhere. There are curl examples for each command help, but not for any of the flags.

   ---

   

   ryanofsky commented at 9:40 pm on November 12, 2018:

   I disagree with meshcollider and promag, and think this information is useful. Or at least I don’t understand how it harms anyone. I hate documentation that just gives me a handwavy gloss about how an option is intended to be used without saying what it actually does.

   Of course it would also be good to document wallet endpoints in markdown. There is some text in the 0.15.0 release notes (“HTTP RPC requests should be send to the…”) that could be moved to JSON-RPC-interface.md. This could be done here or in a separate PR. I actually remember complaining about lack of API documentation when this feature was first added #10849 (comment), and I guess it still doesn’t exist.

   ---

   

   laanwj commented at 8:57 am on November 23, 2018:

   I generally don’t think the option help is the place to put very detailed specifications (just like the release notes are not !), but in this case I kind of like it because it’s short and directly illustrates what it does.
4. 
   promag commented at 9:15 pm on October 9, 2018: member

   Maybe improve documentation like create doc/RPC-interface.md.
5. fanquake added the label Docs on Oct 9, 2018
6. 
   meshcollider commented at 4:20 am on November 9, 2018: contributor

   Agree with @promag, IMO this isn’t the right place to put such an example, it would be better in some other documentation not in bitcoin-cli help text
7. 
   JBaczuk commented at 2:25 pm on November 9, 2018: contributor

   I agree, maybe doc/RPC-interface.md is a better solution, the only problem is that many users will not know about the new doc. Perhaps the incentive to dig a little is great enough. I wonder if the doc/RPC-interface.md would be too difficult to maintain, e.g. the manpages are is generated deterministically.
8. ryanofsky approved
9. 
   ryanofsky commented at 9:42 pm on November 12, 2018: member

   utACK 0c69ff61719e9bc4938a9675a36b4170dfca4e6c
10. 
    laanwj commented at 8:57 am on November 23, 2018: member

    utACK 0c69ff61719e9bc4938a9675a36b4170dfca4e6c
11. laanwj renamed this:
    clarify rpcwallet flag url change
    doc: Clarify rpcwallet flag url change
    on Nov 23, 2018
12. laanwj merged this on Nov 23, 2018
13. laanwj closed this on Nov 23, 2018

    ---

14. laanwj referenced this in commit e3a1b74cdf on Nov 23, 2018
15. jasonbcox referenced this in commit 7b2fda0ad0 on Nov 10, 2020
16. PastaPastaPasta referenced this in commit 94cc0761a8 on Jun 27, 2021
17. PastaPastaPasta referenced this in commit be0dd353e3 on Jun 28, 2021
18. PastaPastaPasta referenced this in commit b728b7fdc4 on Jun 29, 2021
19. PastaPastaPasta referenced this in commit 097f696212 on Jul 1, 2021
20. PastaPastaPasta referenced this in commit 71834bb137 on Jul 1, 2021
21. PastaPastaPasta referenced this in commit fb3dd1c5c3 on Jul 1, 2021
22. UdjinM6 referenced this in commit 506ef8087c on Jul 5, 2021
23. MarcoFalke locked this on Sep 8, 2021

Contributors
JBaczuk promag ryanofsky laanwj meshcollider

Labels
Docs