Skip to content

Commit 912b7cc

Browse files
committed
Merge bitcoin-core/secp256k1#1094: doc: Clarify configure flags for optional modules
55512d3 doc: clean up module help text in configure.ac (Elliott Jin) d9d94a9 doc: mention optional modules in README (Elliott Jin) Pull request description: ACKs for top commit: real-or-random: utACK 55512d3 jonasnick: ACK 55512d3 Tree-SHA512: ae4ec355730983117c5e9a8a8abd17aaf42afe6f8f8f7474a551df6269a62094883e0827d2f3642e3ed6eb26cf71982c20f7ac27498cb4bd7e4aea57ec308d6a
2 parents d0ad581 + 55512d3 commit 912b7cc

File tree

2 files changed

+8
-5
lines changed

2 files changed

+8
-5
lines changed

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,15 @@ libsecp256k1 is built using autotools:
6868
$ make check # run the test suite
6969
$ sudo make install # optional
7070

71+
To compile optional modules (such as Schnorr signatures), you need to run `./configure` with additional flags (such as `--enable-module-schnorrsig`). Run `./configure --help` to see the full list of available flags.
72+
7173
Usage examples
7274
-----------
7375
Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`.
7476
* [ECDSA example](examples/ecdsa.c)
75-
* [Schnorr Signatures example](examples/schnorr.c)
76-
* [Deriving a shared secret(ECDH) example](examples/ecdh.c)
77+
* [Schnorr signatures example](examples/schnorr.c)
78+
* [Deriving a shared secret (ECDH) example](examples/ecdh.c)
79+
To compile the Schnorr signature and ECDH examples, you also need to configure with `--enable-module-schnorrsig` and `--enable-module-ecdh`.
7780

7881
Test coverage
7982
-----------

configure.ac

+3-3
Original file line numberDiff line numberDiff line change
@@ -141,19 +141,19 @@ AC_ARG_ENABLE(examples,
141141
[SECP_SET_DEFAULT([enable_examples], [no], [yes])])
142142

143143
AC_ARG_ENABLE(module_ecdh,
144-
AS_HELP_STRING([--enable-module-ecdh],[enable ECDH shared secret computation]), [],
144+
AS_HELP_STRING([--enable-module-ecdh],[enable ECDH module [default=no]]), [],
145145
[SECP_SET_DEFAULT([enable_module_ecdh], [no], [yes])])
146146

147147
AC_ARG_ENABLE(module_recovery,
148148
AS_HELP_STRING([--enable-module-recovery],[enable ECDSA pubkey recovery module [default=no]]), [],
149149
[SECP_SET_DEFAULT([enable_module_recovery], [no], [yes])])
150150

151151
AC_ARG_ENABLE(module_extrakeys,
152-
AS_HELP_STRING([--enable-module-extrakeys],[enable extrakeys module]), [],
152+
AS_HELP_STRING([--enable-module-extrakeys],[enable extrakeys module [default=no]]), [],
153153
[SECP_SET_DEFAULT([enable_module_extrakeys], [no], [yes])])
154154

155155
AC_ARG_ENABLE(module_schnorrsig,
156-
AS_HELP_STRING([--enable-module-schnorrsig],[enable schnorrsig module]), [],
156+
AS_HELP_STRING([--enable-module-schnorrsig],[enable schnorrsig module [default=no]]), [],
157157
[SECP_SET_DEFAULT([enable_module_schnorrsig], [no], [yes])])
158158

159159
AC_ARG_ENABLE(external_default_callbacks,

0 commit comments

Comments
 (0)