summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiels Möller <nisse@lysator.liu.se>2015-03-30 20:56:21 +0200
committerNiels Möller <nisse@lysator.liu.se>2015-03-30 20:56:21 +0200
commit19b9de6c5fcb790102f584f03ccd0d3759bbd831 (patch)
treeb4b4773c0b1d7dc334ffd443e0e15d8440c7fb33
parentee547d595f3f8d028d01bb438b77d3aa5e35aa43 (diff)
downloadnettle-19b9de6c5fcb790102f584f03ccd0d3759bbd831.tar.gz
Documentation update.
-rw-r--r--ChangeLog3
-rw-r--r--nettle.texinfo42
2 files changed, 33 insertions, 12 deletions
diff --git a/ChangeLog b/ChangeLog
index 7f41eed2..35fbefc7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
2015-03-30 Niels Möller <nisse@diamant.hack.org>
+ * nettle.texinfo: Updated version number.
+ (Installation): Document some more configure options.
+
* testsuite/symbols-test: Look for NETTLE_USE_MINI_GMP in
version.h, not bignum.h.
diff --git a/nettle.texinfo b/nettle.texinfo
index 08812fa3..7fe2471e 100644
--- a/nettle.texinfo
+++ b/nettle.texinfo
@@ -7,14 +7,14 @@
@syncodeindex fn cp
@c %**end of header
-@set UPDATED-FOR 3.0
+@set UPDATED-FOR 3.1
@set AUTHOR Niels Möller
@copying
This manual is for the Nettle library (version @value{UPDATED-FOR}), a
low-level cryptographic library.
-Originally written 2001 by @value{AUTHOR}, updated 2014.
+Originally written 2001 by @value{AUTHOR}, updated 2015.
@quotation
This manual is placed in the public domain. You may freely copy it, in
@@ -4902,17 +4902,35 @@ make install
@end example
@noindent
-to install in under the default prefix, @file{/usr/local}.
+to install it under the default prefix, @file{/usr/local}. Using GNU
+make is strongly recommended. By default, both static and shared
+libraries are built and installed.
+
+To get a list of configure options, use @code{./configure --help}. Some
+of the more interesting are:
+
+@table @option
+@item --enable-fat
+Include multiple versions of certain functions in the library, and
+select the ones to use at run-time, depending on available processor
+features. Supported for ARM and x86_64.
+
+@item --enable-mini-gmp
+Use the smaller and slower ``mini-gmp'' implementation of the bignum
+functions needed for public-key cryptography, instead of the real GNU
+GMP library. This option is intended primarily for smaller embedded
+systems. Note that builds using mini-gmp are @strong{not} binary compatible
+with regular builds of Nettle, and more likely to leak side-channel
+information.
+
+@item --disable-shared
+Omit building the shared libraries.
+
+@item --disable-dependency-tracking
+Disable the automatic dependency tracking. You will likely need this
+option to be able to build with BSD make.
-To get a list of configure options, use @code{./configure --help}.
-
-By default, both static and shared libraries are built and installed. To
-omit building the shared libraries, use the @option{ --disable-shared}
-option to @command{./configure}.
-
-Using GNU make is recommended. For other make programs, in particular
-BSD make, you may have to use the @option{--disable-dependency-tracking}
-option to @command{./configure}.
+@end table
@node Index, , Installation, Top
@comment node-name, next, previous, up