use EXIT_ codes instead of magic numbers for exit(…) and main return values #1609

issue theStack openend this issue on September 27, 2024
  1. theStack commented at 1:23 am on September 27, 2024: contributor

    This is really only a minor issue, but I noticed while reviewing #1479 that the return codes of functions in the examples could potentially be confusing. Throughout the API and internal functions we use 0=failure/1=success, while for the main function and (exit(...)) it’s the other way round, i.e. 0=success/1=failure. We could use EXIT_{SUCCESS,FAILURE} (defined in stdlib.h, see https://en.cppreference.com/w/c/program/EXIT_status) for the latter instead for more clarity.

    See e.g. https://github.com/bitcoin/bitcoin/pull/9067/commits/4441018d0860fce64ee74fa78da79bbb21114ca9 for a comparable change in Bitcoin Core as orientation. This could be a good first issue.

  2. real-or-random commented at 12:46 pm on September 27, 2024: contributor

    Concept ACK

    I had the same thought in the past.

    My suggestion to remove assert() in the examples is slightly related and could be addressed in another commit in the same PR that would resolve this issue here.

  3. real-or-random added the label user-documentation on Sep 27, 2024
  4. real-or-random added the label refactor/smell on Sep 27, 2024
  5. real-or-random added the label good first issue on Sep 27, 2024

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-10-08 09:15 UTC

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