Commit 6a1a66c180cba5f2d4189e89327de23505c7f4dd attempted to properly render RPC results of the type ANY.
However, the commit is incomplete.
Fix it, by properly rendering all ANY types.
Moreover, a few trivial refactors after #34683 are included here.
<!--e57a25ab6845829454e8d69fc972939a-->
The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.
<!--006a51241073e994b41acfe9ec718e94-->
For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/35842.
<!--021abf342d371248e50ceaed478a90ca-->
See the guideline and AI policy for information on the review process.
| Type | Reviewers |
|---|---|
| ACK | sedited, willcl-ark |
If your review is incorrectly listed, please copy-paste <code><!--meta-tag:bot-skip--></code> into the comment that the bot should ignore.
<!--5faf32d7da4f0f540f40219e4f7537a3-->
Rendered diff:
diff --git a/echo b/echo
index 58d7d21..4f5d878 100644
--- a/echo
+++ b/echo
@@ -17,3 +17,6 @@ Arguments:
8. arg7 (string, optional)
9. arg8 (string, optional)
10. arg9 (string, optional)
+
+Result:
+xxx (any) Returns whatever was passed in
diff --git a/echojson b/echojson
index 15a45f8..7976600 100644
--- a/echojson
+++ b/echojson
@@ -17,3 +17,6 @@ Arguments:
8. arg7 (string, optional)
9. arg8 (string, optional)
10. arg9 (string, optional)
+
+Result:
+xxx (any) Returns whatever was passed in
This is more explicit and comes with compile-time checks to ensure all default types are covered.
This will render all ANY results.
However, the one in the help RPC should still be hidden. This is done by
applying HelpElisionSkip and also skipping over empty result sections in
ToDescriptionString.
Also, run clang-format. Can be reviewed via --ignore-all-space
There is no recursion.
This is clearer, because it does not encode the default value in the
source code syntax. Also, using named args is clearer than positional
args.
Also, run clang-format on the new code.
This refactor follow other uses of CLIENT_NAME, such as in RPCMethod stop().
ACK fac4b06e997e197d6dca4c41bdec99c0ba84cfca
cc @willcl-ark As the author of commit https://github.com/bitcoin/bitcoin/commit/6a1a66c180cba5f2d4189e89327de23505c7f4dd, you may be qualified to review :)
ACK fac4b06e997e197d6dca4c41bdec99c0ba84cfca
All looks good to me, thanks for the followups :)
I was wondering whether it would be worth adding a specific (regression) test for this, but I don't think it probably is. Could be just checking for (any) in bitcoin-cli help echo and no (any)'s in bitcoin-cli help.