aboutsummaryrefslogtreecommitdiff
path: root/src/secp256k1/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/secp256k1/README.md')
-rw-r--r--src/secp256k1/README.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/src/secp256k1/README.md b/src/secp256k1/README.md
index 182c29d9ce..5fc07dd4fa 100644
--- a/src/secp256k1/README.md
+++ b/src/secp256k1/README.md
@@ -66,18 +66,9 @@ libsecp256k1 is built using autotools:
$ ./autogen.sh
$ ./configure
$ make
- $ make check
+ $ make check # run the test suite
$ sudo make install # optional
-Exhaustive tests
------------
-
- $ ./exhaustive_tests
-
-With valgrind, you might need to increase the max stack size:
-
- $ valgrind --max-stackframe=2500000 ./exhaustive_tests
-
Test coverage
-----------
@@ -100,6 +91,18 @@ To create a HTML report with coloured and annotated source code:
$ mkdir -p coverage
$ gcovr --exclude 'src/bench*' --html --html-details -o coverage/coverage.html
+Benchmark
+------------
+If configured with `--enable-benchmark` (which is the default), binaries for benchmarking the libsecp256k1 functions will be present in the root directory after the build.
+
+To print the benchmark result to the command line:
+
+ $ ./bench_name
+
+To create a CSV file for the benchmark result :
+
+ $ ./bench_name | sed '2d;s/ \{1,\}//g' > bench_name.csv
+
Reporting a vulnerability
------------