Improve documentation for benchmarks #1005

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. siv2r cross-referenced this on Nov 8, 2021 from issue bench.c: add `--help` option and ci: move env variables by siv2r
6. real-or-random closed this on Dec 5, 2021

   ---

Contributors
real-or-random siv2r jonasnick