summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRichard Levitte <levitte@openssl.org>2019-11-05 17:48:33 +0100
committerRichard Levitte <levitte@openssl.org>2019-11-07 11:37:37 +0100
commit54a0d4ceb28d53f5b00a27fc5ca8ff8f0ddf9036 (patch)
treeac83cf21527fbcf9236ff725cb72fa77aed5eeeb
parentinclude/openssl/asn1.h: Remove version dependent inclusion of <openssl/bn.h> (diff)
downloadopenssl-54a0d4ceb28d53f5b00a27fc5ca8ff8f0ddf9036.tar.xz
openssl-54a0d4ceb28d53f5b00a27fc5ca8ff8f0ddf9036.zip
Update INSTALL to document the changed '--api' and 'no-deprecated'
Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10364)
-rw-r--r--INSTALL29
1 files changed, 18 insertions, 11 deletions
diff --git a/INSTALL b/INSTALL
index c818ed72b1..0bddf761a1 100644
--- a/INSTALL
+++ b/INSTALL
@@ -141,14 +141,20 @@
--openssldir depend in what configuration is used and what Windows
implementation OpenSSL is built on. More notes on this in NOTES.WIN):
- --api=x.y.z
- Don't build with support for deprecated APIs below the
- specified version number. For example "--api=1.1.0" will
- remove support for all APIS that were deprecated in OpenSSL
- version 1.1.0 or below. This is a rather specialized option
- for developers. If you just intend to remove all deprecated
- APIs entirely (up to the current version), it is easier
- to add the 'no-deprecated' option instead (see below).
+ --api=x.y[.z]
+ Build the OpenSSL libraries to support the API for
+ the specified version. If "no-deprecated" is also
+ given, don't build with support for deprecated APIs
+ in or below the specified version number. For example
+ "--api=1.1.0" with "no-deprecated" will remove
+ support for all APIS that were deprecated in
+ OpenSSL version 1.1.0 or below.
+ This is a rather specialized option for developers.
+ If you just intend to remove all deprecated APIs
+ entirely (up to the current version), only specify
+ "-no-deprecated" (see below).
+ If "--api" isn't given, it defaults to the current
+ OpenSSL minor version.
--cross-compile-prefix=PREFIX
The PREFIX to include in front of commands for your
@@ -356,9 +362,10 @@
Don't build support for Certificate Transparency.
no-deprecated
- Don't build with support for any deprecated APIs. This is the
- same as using "--api" and supplying the latest version
- number.
+ Don't build with support for deprecated APIs up
+ until and including the version given with
+ "--api" (or the current version of "--api" wasn't
+ given).
no-dgram
Don't build support for datagram based BIOs. Selecting this