Suggested by @Sjors in #11536 (comment)
Document RPC method aliasing #12700
pull ryanofsky wants to merge 1 commits into bitcoin:master from ryanofsky:pr/alias changing 2 files +20 −0-
ryanofsky commented at 8:41 PM on March 15, 2018: member
-
4c317d89e9
Document RPC method aliasing
Suggested by Sjors Provoost <sjors@sprovoost.nl> in https://github.com/bitcoin/bitcoin/pull/11536#issuecomment-372820660
-
Sjors commented at 8:48 PM on March 15, 2018: member
Concept ACK. Ideally there would also be some comment next to each alias in places like
CRPCCommand commands[], but apparently that's non trivial. -
ryanofsky commented at 8:54 PM on March 15, 2018: member
Ideally there would also be some comment next to each alias in places like CRPCCommand commands[]
What would the comment say, and why would it be helpful? The only non-obvious behavior I can think of regarding aliases is that they are omitted from the command listing in help text, and this doesn't seem like a relevant fact to mention in the middle of command registration.
- randolf approved
- fanquake added the label Docs on Mar 15, 2018
- fanquake added the label RPC/REST/ZMQ on Mar 15, 2018
-
PierreRochard commented at 4:46 PM on March 18, 2018: contributor
ACK 4c317d89e9d980328028ff01cd9a0465cc22bb7e
-
laanwj commented at 2:58 PM on March 19, 2018: member
utACK https://github.com/bitcoin/bitcoin/pull/12700/commits/4c317d89e9d980328028ff01cd9a0465cc22bb7e. This is exactly the behavior that is desirable for deprecating/renaming RPCs, but needs to be documented.
- laanwj merged this on Mar 19, 2018
- laanwj closed this on Mar 19, 2018
- laanwj referenced this in commit ebdf84c960 on Mar 19, 2018
- PastaPastaPasta referenced this in commit 28d8d99a2c on Jul 17, 2020
- PastaPastaPasta referenced this in commit ea7575375d on Jul 17, 2020
- MarcoFalke locked this on Sep 8, 2021
Contributors
Labels