Improve documentation for benchmarks #1005

issue real-or-random opened this issue on November 8, 2021
  1. real-or-random commented at 10:28 AM on November 8, 2021: contributor

    A follow-up PR could add a --help which would also mention the get_iters environment variable (I have to look up in the source how it's called exactly every time).

    Originally posted by @jonasnick in #991#pullrequestreview-799481944

    We could also remove the indirection in cirrus.sh (https://github.com/bitcoin-core/secp256k1/blob/master/ci/cirrus.sh#L35-L37) and define the "right" constants directly in cirrus.yml. I tend to look the constants up in cirrus.yml and then see the wrong constants without the SECP256K1_ prefix.

  2. siv2r commented at 3:02 PM on November 8, 2021: contributor

    mention the get_iters environment variable

    I don't understand. Do we have to mention the value of the iters variable (stores the value of get_iters func)? Or the value of SECP256K1_BENCH_ITERS?

  3. jonasnick commented at 3:30 PM on November 8, 2021: contributor

    I was just suggesting to mention the string SECP256K1_BENCH_ITERS in case someone would want to use a custom number of iterations.

  4. siv2r commented at 3:32 PM on November 8, 2021: contributor

    Ahh, got it!

  5. real-or-random closed this on Dec 5, 2021

  6. Harrm referenced this in commit 6ad908aa00 on Feb 9, 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: 2026-05-19 06:52 UTC