Debug console needs a little documentation on usage #9195

issue laanwj opened this issue on November 21, 2016
  1. laanwj commented at 9:39 AM on November 21, 2016: member

    It would be nice if the debug console had a little help page of itself, to describe the syntax to issue commands (also the nested ones), and a disclaimer that usage can be dangerous.

    Maybe add a debug-console-only command like help that shows how to use nested commands and potentially other advanced tricks, and add 'for more information on using this console type XXX'.

    See also:

  2. laanwj added the label GUI on Nov 21, 2016
  3. laanwj added the label Easy to implement on Nov 21, 2016
  4. lmlsna commented at 6:54 PM on November 14, 2017: contributor

    Is this issue still in need of a pull request?

    I know the standard RPC help command is accessible through the console, and the scammer warning has already been added. However, there still appears to be little/no documentation about nested commands (or other peculiarities not applicable to the command line RPC).

    There is a comment block in rpcconsole.cpp#L134, that gives a quick overview, and I'd be happy to flush that out (either as a doc or as a debug console only help command). I just wanted to make sure this was still needed before starting.

  5. jonasschnelli commented at 7:05 AM on November 15, 2017: contributor

    @lmlsna: Yes. A PR that would add some documentation for the nested command syntax would be highly welcome. Not sure if it should be added directly to the console intro or if there should be sort of an "help" icon with more explanations...

  6. lmlsna commented at 10:14 PM on November 15, 2017: contributor

    I pushed a PR adding a help-console pseudo-command that dumps some explaination and examples.

    Not sure if this is the best way of doing it, but it seemed reasonable, and I'm open to suggestions.

  7. laanwj referenced this in commit 7293d06413 on Nov 19, 2017
  8. fanquake commented at 1:16 PM on November 19, 2017: member

    Closing now that #11698 is merged.

  9. fanquake closed this on Nov 19, 2017

  10. PastaPastaPasta referenced this in commit 7ffbf8143d on Jan 17, 2020
  11. PastaPastaPasta referenced this in commit 29ec248a03 on Jan 22, 2020
  12. PastaPastaPasta referenced this in commit 9733330f78 on Jan 22, 2020
  13. PastaPastaPasta referenced this in commit 97adc728da on Jan 29, 2020
  14. PastaPastaPasta referenced this in commit 8977118599 on Jan 29, 2020
  15. PastaPastaPasta referenced this in commit c7b8b2b35c on Jan 29, 2020
  16. ckti referenced this in commit 953ed59806 on Mar 28, 2021
  17. DrahtBot locked this on Sep 8, 2021

github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin/bitcoin. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2026-04-13 15:15 UTC

This site is hosted by @0xB10C
More mirrored repositories can be found on mirror.b10c.me