Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for benchmarks #1005

Closed
real-or-random opened this issue Nov 8, 2021 · 3 comments · Fixed by #1008
Closed

Improve documentation for benchmarks #1005

real-or-random opened this issue Nov 8, 2021 · 3 comments · Fixed by #1008

Comments

@real-or-random
Copy link
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 (review)

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.

@siv2r
Copy link
Contributor

siv2r commented Nov 8, 2021

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?

@jonasnick
Copy link
Contributor

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

@siv2r
Copy link
Contributor

siv2r commented Nov 8, 2021

Ahh, got it!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants