Document the use of configdata.pm as a script
authorRichard Levitte <levitte@openssl.org>
Mon, 29 Jan 2018 17:19:36 +0000 (18:19 +0100)
committerRichard Levitte <levitte@openssl.org>
Mon, 29 Jan 2018 20:56:48 +0000 (21:56 +0100)
Reviewed-by: Rich Salz <rsalz@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/5185)

CHANGES
INSTALL
NEWS
README

diff --git a/CHANGES b/CHANGES
index b3aa741..f0807c6 100644 (file)
--- a/CHANGES
+++ b/CHANGES
@@ -9,6 +9,11 @@
 
  Changes between 1.1.0f and 1.1.1 [xx XXX xxxx]
 
+  *) Changed Configure so it only says what it does and doesn't dump
+     so much data.  Instead, ./configdata.pm should be used as a script
+     to display all sorts of configuration data.
+     [Richard Levitte]
+
   *) Added processing of "make variables" to Configure.
      [Richard Levitte]
 
diff --git a/INSTALL b/INSTALL
index 006f72d..f8702e4 100644 (file)
--- a/INSTALL
+++ b/INSTALL
                    precedence over environment variables that are defined
                    when reconfiguring.
 
+ Displaying configuration data
+ -----------------------------
+
+ The configuration script itself will say very little, and finishes by
+ creating "configdata.pm".  This perl module can be loaded by other scripts
+ to find all the configuration data, and it can also be used as a script to
+ display all sorts of configuration data in a human readable form.
+
+ For more information, please do:
+
+       $ ./configdata.pm --help                         # Unix
+
+       or
+
+       $ perl configdata.pm --help                      # Windows and VMS
+
  Installation in Detail
  ----------------------
 
diff --git a/NEWS b/NEWS
index 038a673..0fb5314 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -7,6 +7,7 @@
 
   Major changes between OpenSSL 1.1.0f and OpenSSL 1.1.1 [under development]
 
+      o Move the display of configuration data to configdata.pm.
       o Allow GNU style "make variables" to be used with Configure.
       o Add a STORE module (OSSL_STORE)
       o Claim the namespaces OSSL and OPENSSL, represented as symbol prefixes
diff --git a/README b/README
index b6dfda7..fb0334b 100644 (file)
--- a/README
+++ b/README
@@ -68,8 +68,7 @@
  and create an issue on GitHub:
 
     - OpenSSL version: output of 'openssl version -a'
-    - Any "Configure" options that you selected during compilation of the
-      library if applicable (see INSTALL)
+    - Configuration data: output of 'perl configdata.pm --dump'
     - OS Name, Version, Hardware platform
     - Compiler Details (name, version)
     - Application Details (name, version)