doc: Clarify configure flags for optional modules #1094

1. 
   robot-dreams commented at 2:15 pm on March 25, 2022: contributor

   Minor doc cleanup as a follow-up to #995 (review)
2. in configure.ac:144 in 489ce253fd outdated

   140@@ -141,19 +141,19 @@ AC_ARG_ENABLE(examples,
   141     [SECP_SET_DEFAULT([enable_examples], [no], [yes])])
   142 
   143 AC_ARG_ENABLE(module_ecdh,
   144-    AS_HELP_STRING([--enable-module-ecdh],[enable ECDH shared secret computation]), [],
   145+    AS_HELP_STRING([--enable-module-ecdh],[enable ECDH shared secret computation [default=no]]), [],
   

   ---

   ---

   

   real-or-random commented at 2:56 pm on March 25, 2022:

   maybe this is the time to reword this to “enable ECDH module”
3. in README.md:71 in 489ce253fd outdated

   67@@ -68,12 +68,15 @@ libsecp256k1 is built using autotools:
   68     $ make check  # run the test suite
   69     $ sudo make install  # optional
   70 
   71+To compile optional modules (such as Schnorr), you need to run `./configure` with additional flags (such as `--enable-module-schnorr`). Run `./configure --help` to see the full list of available flags.
   

   ---

   ---

   

   real-or-random commented at 2:59 pm on March 25, 2022:

   0To 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.
   

   Also below.

   “Schnorr” is a person, so I think “enable Schnorr” is very strange. I keep insisting on this point. (But I don’t always win – https://github.com/rust-bitcoin/rust-secp256k1/pull/327)

4. robot-dreams force-pushed on Mar 25, 2022
5. in README.md:78 in 8e1468d672 outdated

   74 -----------
   75   Usage examples can be found in the [examples](examples) directory. To compile them you need to configure with `--enable-examples`.
   76   * [ECDSA example](examples/ecdsa.c)
   77-  * [Schnorr Signatures example](examples/schnorr.c)
   78+  * [Schnorr signatures example](examples/schnorr.c)
   79   * [Deriving a shared secret(ECDH) example](examples/ecdh.c)
   

   ---

   ---

   

   real-or-random commented at 3:12 pm on March 25, 2022:

   0  * [Deriving a shared secret (ECDH) example](examples/ecdh.c)
   

   Not that we’re on it. (Sorry for not pointing this out earlier. :P)

   ---

   

   robot-dreams commented at 3:14 pm on March 25, 2022:

   Haha, all good!
6. real-or-random approved
7. 
   real-or-random commented at 3:12 pm on March 25, 2022: contributor

   utACK https://github.com/bitcoin-core/secp256k1/pull/1094/commits/8e1468d672e07ce3f182d928efcb40aeb896a489
8. doc: mention optional modules in README d9d94a9969
9. doc: clean up module help text in configure.ac 55512d30b7
10. robot-dreams force-pushed on Mar 25, 2022
11. real-or-random approved
12. 
    real-or-random commented at 3:20 pm on March 25, 2022: contributor

    utACK 55512d30b7921bc46247a78be1da98108f243c1c
13. 
    jonasnick commented at 8:16 pm on March 25, 2022: contributor

    ACK 55512d30b7921bc46247a78be1da98108f243c1c
14. jonasnick merged this on Mar 25, 2022
15. jonasnick closed this on Mar 25, 2022

    ---

16. fanquake referenced this in commit 465d05253a on Mar 30, 2022
17. jonasnick cross-referenced this on Mar 30, 2022 from issue Upstream PRs 1064, 1049, 899, 1068, 1072, 1069, 1074, 1026, 1033, 748, 1079, 1088, 1090, 731, 1089, 995, 1094, 1093 by jonasnick
18. real-or-random referenced this in commit 6c0aecf72b on Apr 1, 2022
19. fanquake referenced this in commit afb7a6fe06 on Apr 6, 2022
20. gwillen referenced this in commit 35d6112a72 on May 25, 2022
21. patricklodder referenced this in commit 21badcf9d2 on Jul 25, 2022
22. patricklodder referenced this in commit 03002a9013 on Jul 28, 2022
23. janus referenced this in commit 3a0652a777 on Aug 4, 2022
24. str4d referenced this in commit 522190d5c3 on Apr 21, 2023
25. vmta referenced this in commit e1120c94a1 on Jun 4, 2023
26. vmta referenced this in commit 8f03457eed on Jul 1, 2023

Contributors
robot-dreams real-or-random jonasnick