mirror/openssl
2
0
Fork 0
mirror of https://github.com/openssl/openssl.git synced 2025-02-05 14:10:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use '[option...]' not '[[ options ]]' in text

Browse Source 
Looks more like manpage format. :)
Also remove `{{..}}` notation and rewrite around it.

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16329)
This commit is contained in:
Rich Salz 2021-08-16 17:31:59 -04:00 committed by Richard Levitte
parent a8d9bd8114
commit a4ffb33ea8
2 changed files with 14 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
INSTALL.md
View File

@ -120,21 +120,11 @@ represents one of the four commands
Arguments Arguments
--------- ---------
**Mandatory arguments** are enclosed in double curly braces. **Optional Arguments** are enclosed in square brackets.
A simple example would be
$ type {{ filename }} [option...]
which is to be understood to use the command `type` on some file name A trailing ellipsis means that more than one could be specified.
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.
Quick Installation Guide Quick Installation Guide
======================== ========================
@ -1155,15 +1145,15 @@ the same.
#### Unix / Linux / macOS #### Unix / Linux / macOS
$ ./Configure [[ options ]] $ ./Configure [options...]
#### OpenVMS #### OpenVMS
$ perl Configure [[ options ]] $ perl Configure [options...]
#### Windows #### Windows
$ perl Configure [[ options ]] $ perl Configure [options...]
### Manual Configuration ### 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 name as the argument to `Configure`. For example, a `linux-elf` user would
run: run:
$ ./Configure linux-elf [[ options ]] $ ./Configure linux-elf [options...]
### Creating your own Configuration ### Creating your own Configuration
If your system isn't listed, you will have to create a 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 configuration for your system. See the available configs as examples
and read [Configurations/README.md](Configurations/README.md) and and read [Configurations/README.md](Configurations/README.md) and
[Configurations/README-design.md](Configurations/README-design.md) [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 $ mkdir /var/tmp/openssl-build
$ cd /var/tmp/openssl-build $ cd /var/tmp/openssl-build
$ /PATH/TO/OPENSSL/SOURCE/Configure [[ options ]] $ /PATH/TO/OPENSSL/SOURCE/Configure [options...]
#### OpenVMS example #### OpenVMS example
$ set default sys$login: $ set default sys$login:
$ create/dir [.tmp.openssl-build] $ create/dir [.tmp.openssl-build]
$ set default [.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 #### Windows example
$ C: $ C:
$ mkdir \temp-openssl $ mkdir \temp-openssl
$ cd \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 Paths can be relative just as well as absolute. `Configure` will do its best
to translate them to relative paths whenever possible. to translate them to relative paths whenever possible.

4
util/perl/OpenSSL/config.pm
View File

@ -473,7 +473,7 @@ EOF
if ( $ISA64 == 1 && $KERNEL_BITS eq '' ) { if ( $ISA64 == 1 && $KERNEL_BITS eq '' ) {
print <<EOF; print <<EOF;
WARNING! To build 64-bit package, do this: WARNING! To build 64-bit package, do this:
KERNEL_BITS=64 $WHERE/Configure \[\[ options \]\] KERNEL_BITS=64 $WHERE/Configure [options...]
EOF EOF
maybe_abort(); maybe_abort();
} }
@ -489,7 +489,7 @@ EOF
print <<EOF; print <<EOF;
WARNING! To build 32-bit package, do this: WARNING! To build 32-bit package, do this:
KERNEL_BITS=32 $WHERE/Configure \[\[ options \]\] KERNEL_BITS=32 $WHERE/Configure [options...]
EOF EOF
maybe_abort(); maybe_abort();
return { target => "darwin64-x86_64" }; return { target => "darwin64-x86_64" };