[openssl] master update
Richard Levitte
levitte at openssl.org
Tue Sep 7 13:25:13 UTC 2021
The branch master has been updated
via a4ffb33ea8b7bcf04b8181dafce7ac512081d0ab (commit)
from a8d9bd8114510d3a1708da3922f07e7f707674bc (commit)
- Log -----------------------------------------------------------------
commit a4ffb33ea8b7bcf04b8181dafce7ac512081d0ab
Author: Rich Salz <rsalz at akamai.com>
Date: Mon Aug 16 17:31:59 2021 -0400
Use '[option...]' not '[[ options ]]' in text
Looks more like manpage format. :)
Also remove `{{..}}` notation and rewrite around it.
Reviewed-by: Tomas Mraz <tomas at openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit at gmail.com>
Reviewed-by: Richard Levitte <levitte at openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16329)
-----------------------------------------------------------------------
Summary of changes:
INSTALL.md | 33 ++++++++++++---------------------
util/perl/OpenSSL/config.pm | 4 ++--
2 files changed, 14 insertions(+), 23 deletions(-)
diff --git a/INSTALL.md b/INSTALL.md
index 5d53cef1aa..70eb8da1ed 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -120,21 +120,11 @@ represents one of the four commands
Arguments
---------
-**Mandatory arguments** are enclosed in double curly braces.
-A simple example would be
+**Optional Arguments** are enclosed in square brackets.
- $ type {{ filename }}
+ [option...]
-which is to be understood to use the command `type` on some file name
-determined by the user.
-
-**Optional Arguments** are enclosed in double square brackets.
-
- [[ options ]]
-
-Note that the notation assumes spaces around `{`, `}`, `[`, `]`, `{{`, `}}` and
-`[[`, `]]`. This is to differentiate from OpenVMS directory
-specifications, which also use [ and ], but without spaces.
+A trailing ellipsis means that more than one could be specified.
Quick Installation Guide
========================
@@ -1155,15 +1145,15 @@ the same.
#### Unix / Linux / macOS
- $ ./Configure [[ options ]]
+ $ ./Configure [options...]
#### OpenVMS
- $ perl Configure [[ options ]]
+ $ perl Configure [options...]
#### Windows
- $ perl Configure [[ options ]]
+ $ perl Configure [options...]
### Manual Configuration
@@ -1185,12 +1175,13 @@ When you have identified your system (and if necessary compiler) use this
name as the argument to `Configure`. For example, a `linux-elf` user would
run:
- $ ./Configure linux-elf [[ options ]]
+ $ ./Configure linux-elf [options...]
### Creating your own Configuration
If your system isn't listed, you will have to create a configuration
-file named `Configurations/{{ something }}.conf` and add the correct
+file named `Configurations/YOURFILENAME.conf` (replace `YOURFILENAME`
+with a filename of your choosing) and add the correct
configuration for your system. See the available configs as examples
and read [Configurations/README.md](Configurations/README.md) and
[Configurations/README-design.md](Configurations/README-design.md)
@@ -1214,21 +1205,21 @@ directory and invoking the configuration commands from there.
$ mkdir /var/tmp/openssl-build
$ cd /var/tmp/openssl-build
- $ /PATH/TO/OPENSSL/SOURCE/Configure [[ options ]]
+ $ /PATH/TO/OPENSSL/SOURCE/Configure [options...]
#### OpenVMS example
$ set default sys$login:
$ create/dir [.tmp.openssl-build]
$ set default [.tmp.openssl-build]
- $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [[ options ]]
+ $ perl D:[PATH.TO.OPENSSL.SOURCE]Configure [options...]
#### Windows example
$ C:
$ mkdir \temp-openssl
$ cd \temp-openssl
- $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [[ options ]]
+ $ perl d:\PATH\TO\OPENSSL\SOURCE\Configure [options...]
Paths can be relative just as well as absolute. `Configure` will do its best
to translate them to relative paths whenever possible.
diff --git a/util/perl/OpenSSL/config.pm b/util/perl/OpenSSL/config.pm
index 7250791b5b..d8be17cdc5 100755
--- a/util/perl/OpenSSL/config.pm
+++ b/util/perl/OpenSSL/config.pm
@@ -473,7 +473,7 @@ EOF
if ( $ISA64 == 1 && $KERNEL_BITS eq '' ) {
print <<EOF;
WARNING! To build 64-bit package, do this:
- KERNEL_BITS=64 $WHERE/Configure \[\[ options \]\]
+ KERNEL_BITS=64 $WHERE/Configure [options...]
EOF
maybe_abort();
}
@@ -489,7 +489,7 @@ EOF
print <<EOF;
WARNING! To build 32-bit package, do this:
- KERNEL_BITS=32 $WHERE/Configure \[\[ options \]\]
+ KERNEL_BITS=32 $WHERE/Configure [options...]
EOF
maybe_abort();
return { target => "darwin64-x86_64" };
More information about the openssl-commits
mailing list