Skip to content

gen-manpages output depends on build options, so needs to check them #17506

@laanwj

Description

@laanwj

The gen-manpages.py generates UNIX manual pages based on the -help output from the binairies that result from the build.

This means that the options documented vary based on the build system settings. In the manual pages that are checked in, we would like to document as many options as possible.

Ideally the script needs to check for:

  • HAVE_SYSTEM so that -alertnotify and other notifications are documented
  • ENABLE_WALLET so that wallet specific arguments are documented
  • USE_UPNP so that UPnP arguments are documented
  • ENABLE_ZMQ so that ZMQ arguments are documented

An alternative would be to generate the manual page from the source code instead (e.g. pick up and parse AddArg). This is much more complicated, though, due to use of strprintf and such.

Good first issue

The purpose of the good first issue label is to highlight which issues are suitable for a new contributor without a deep understanding of the codebase.

Useful skills: shell scripting

Want to work on this issue?

You do not need to request permission to start working on this. You are encouraged to comment on the issue if you are planning to work on it. This will help other contributors monitor which issues are actively being addressed and is also an effective way to request assistance if and when you need it.

For guidance on contributing, please read CONTRIBUTING.md before opening your pull request.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions