INSTALL: clarify documentation of the --api=x.y.z deprecation option

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9599)

diff --git a/INSTALL b/INSTALL
index 3104801896785e4fa490c7e4cc3d0902f926f3d3..9ea1f115138fd0f1ee6ba70c88c297e190e948af 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -145,7 +145,10 @@
                    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
                    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.
+                   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).

 
   --cross-compile-prefix=PREFIX
                    The PREFIX to include in front of commands for your
 
   --cross-compile-prefix=PREFIX
                    The PREFIX to include in front of commands for your