doc: gen-manpages.py should check build options #33085

pull BrandonOdiwuor wants to merge 2 commits into bitcoin:master from BrandonOdiwuor:genmanpages-build-options changing 1 files +57 −0
  1. BrandonOdiwuor commented at 7:59 am on July 29, 2025: contributor

    Fixes #17506. Second attempt after PR: #29457 (closed)

    This PR fixes the gen-manpages.py script to check the build options and exit when there are missing components. It also adds an option to --skip-build-options-check

    The PR also addresses the issues raised on PR: #29457: - #29457 (review) - the default behaviors is fail - #29457 (comment) - by adding --skip-build-options-check - #29457#pullrequestreview-2433974717 - The PR uses builddir/src/bitcoin-build-config.h to check for HAVE_SYSTEM option and builddir/test/config.ini for the rest as they are only available there respectively

  2. DrahtBot renamed this:
    doc: gen-manpages.py should check build options
    doc: gen-manpages.py should check build options
    on Jul 29, 2025
  3. DrahtBot added the label Docs on Jul 29, 2025
  4. DrahtBot commented at 7:59 am on July 29, 2025: contributor

    The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

    Code Coverage & Benchmarks

    For details see: https://corecheck.dev/bitcoin/bitcoin/pulls/33085.

    Reviews

    See the guideline for information on the review process. A summary of reviews will appear here.

    LLM Linter (✨ experimental)

    Possible typos and grammar issues:

    • “Aborting generating manpages…” -> “Aborting generation of manpages…” [corrects ungrammatical gerund usage]

    drahtbot_id_4_m

  5. BrandonOdiwuor force-pushed on Jul 29, 2025
  6. DrahtBot added the label CI failed on Jul 29, 2025
  7. DrahtBot commented at 8:04 am on July 29, 2025: contributor

    🚧 At least one of the CI tasks failed. Task lint: https://github.com/bitcoin/bitcoin/runs/46923751472 LLM reason (✨ experimental): Python linter errors due to syntax issues in lint-python-utf8-encoding.py and lint-python.py caused the CI failure.

    Try to run the tests locally, according to the documentation. However, a CI failure may still happen due to a number of reasons, for example:

    • Possibly due to a silent merge conflict (the changes in this pull request being incompatible with the current code in the target branch). If so, make sure to rebase on the latest commit of the target branch.

    • A sanitizer issue, which can only be found by compiling with the sanitizer and running the affected test.

    • An intermittent issue.

    Leave a comment here, if you need help tracking down a confusing failure.

  8. doc: Fix gen-manpages to check build options 3636e7b6c1
  9. doc: allow skipping build options check in gen_manpages db2c589475
  10. BrandonOdiwuor force-pushed on Jul 29, 2025
  11. DrahtBot removed the label CI failed on Jul 29, 2025
  12. janb84 commented at 9:47 am on August 4, 2025: contributor

    Personally I like the intent to structure the code more (the introduction of functions).

    Paused reviewing this PR:

    • I paused reviewing this PR because the way the code is currently structured is unfinished to me. The introduction of a function for the new functionality is great but the rest of the code needs to be restructured to better incorporate the use of functions imho (e.g. use a main function).
    • Have not looked at the intent of the code yet.

    (P.S. This is not meant to be harsh but to explain why I paused reviewing the code instead of silently ignoring the PR. This is an effort to either get the PR merged or closed, not leaving PR’s in limbo.)

  13. BrandonOdiwuor commented at 10:11 am on August 19, 2025: contributor

    @janb84 thanks for having a look

    I think introducing a main function would require a huge refactor to the file for such small check.

    I would also love to hear some advantages of adding a main function here


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: 2025-08-22 18:12 UTC

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