Issue Details
- Number
- 17506
- Title
- gen-manpages output depends on build options, so needs to check them
- Description
- The [gen-manpages.py](https://github.com/bitcoin/bitcoin/blob/master/contrib/devtools/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](https://github.com/bitcoin/bitcoin/blob/master/CONTRIBUTING.md) before opening your pull request.
- URL
-
https://github.com/bitcoin/bitcoin/issue/17506
- Closed by
-
#29457
Back to List