doc: Add unified docs for configuration autotools/CMake/manual builds #1372

pull hebasto wants to merge 4 commits into bitcoin-core:master from hebasto:230704-doc changing 6 files +308 −71
  1. hebasto commented at 8:57 pm on July 4, 2023: member

    Closes the last item in the “Affecting both build systems” group in #1235.

    Draft for now, as it is based on #1291.

  2. cmake: Add `ProcessConfigurations.cmake` module 014e063a10
  3. cmake: Use `SECP256K1_COVERAGE` instead of `CMAKE_BUILD_TYPE=Coverage`
    This change fixes coverage-enabled builds for multi-configuration
    generators, e.g., "Ninja Multi-Config".
    4b3bd66540
  4. autotools, docs: Adjust help string for `--enable-coverage` option 94dd0c0b99
  5. Add `doc/build-options.md` 8eee93dabe
  6. real-or-random added the label documentation on Jul 5, 2023
  7. real-or-random added the label build on Jul 5, 2023
  8. hebasto marked this as a draft on Jul 5, 2023
  9. sipa commented at 1:28 pm on July 14, 2023: contributor
    I’d prefer the documentation to have a single table with all configuration options, perhaps separated into sections, but not in separate tables. It’s a bit chaotic now.
  10. real-or-random commented at 3:21 pm on July 14, 2023: contributor

    Hm, I tend to think that I like the current layout, with the top-level sections being the different options (and not the build systems). It makes it easy to have larger description texts, e.g., the explanation of the window size.

    But yeah, it’s not very elegant when the tables all have different column widths (if this is what you dislike @sipa). In principle, it seems possible to set the column widths:

    0<table>
    1<tr><td width="500">foo</td><td>bar</td>
    2<table>
    

    But that’s hard to read as plain text, and it’s deprecated HTML (GitHub doesn’t like style="width:500px")… Not convinced.

  11. fanquake commented at 4:52 pm on July 1, 2024: member

    Draft for now, as it is based on #1291.

    If this is just docs, does it need to be based on #1291 (which seems to have stalled)?


github-metadata-mirror

This is a metadata mirror of the GitHub repository bitcoin-core/secp256k1. This site is not affiliated with GitHub. Content is generated from a GitHub metadata backup.
generated: 2024-11-21 12:15 UTC

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