Skip to content

Commit af33b20

Browse files
suchorskimspncp
authored andcommitted
Fixed some grammar and spelling
Reviewed-by: Richard Levitte <[email protected]> Reviewed-by: Tomas Mraz <[email protected]> Reviewed-by: Matthias St. Pierre <[email protected]> (Merged from openssl#19262)
1 parent 19b6b5f commit af33b20

11 files changed

+64
-64
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ To request new features or report bugs, please open an issue on GitHub
1414
To submit a patch, please open a pull request on GitHub. If you are thinking
1515
of making a large contribution, open an issue for it before starting work,
1616
to get comments from the community. Someone may be already working on
17-
the same thing or there may be reasons why that feature isn't implemented.
17+
the same thing, or there may be reasons why that feature isn't implemented.
1818

1919
To make it easier to review and accept your pull request, please follow these
2020
guidelines:
@@ -54,7 +54,7 @@ guidelines:
5454
(usually by rebasing) before it will be acceptable.
5555
5656
4. Patches should follow our [coding style] and compile without warnings.
57-
Where `gcc` or `clang` is available you should use the
57+
Where `gcc` or `clang` is available, you should use the
5858
`--strict-warnings` `Configure` option. OpenSSL compiles on many varied
5959
platforms: try to ensure you only use portable features. Clean builds via
6060
GitHub Actions and AppVeyor are required, and they are started automatically

HACKING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This document describes the way to add custom modifications to OpenSSL sources.
99
[Configurations/unix-Makefile.tmpl](Configurations/unix-Makefile.tmpl)
1010
to pick up that file.
1111

12-
After that perform the following steps:
12+
After that, perform the following steps:
1313

1414
./Configure -Werror --strict-warnings [your-options]
1515
make update
@@ -27,7 +27,7 @@ This document describes the way to add custom modifications to OpenSSL sources.
2727

2828
`make update` also generates files related to OIDs (in the `crypto/objects/`
2929
folder) and errors.
30-
If a merge error occurs in one of these generated files then the
30+
If a merge error occurs in one of these generated files, then the
3131
generated files need to be removed and regenerated using `make update`.
32-
To aid in this process the generated files can be committed separately
32+
To aid in this process, the generated files can be committed separately
3333
so they can be removed easily.

INSTALL.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1020,7 +1020,7 @@ below and how these flags interact with those variables.
10201020

10211021
Additional options that are not otherwise recognised are passed through as
10221022
they are to the compiler as well. Unix-style options beginning with a
1023-
`-` or `+` and Windows-style options beginning with a `/` are recognized.
1023+
`-` or `+` and Windows-style options beginning with a `/` are recognised.
10241024
Again, consult your compiler documentation.
10251025

10261026
If the option contains arguments separated by spaces, then the URL-style

NOTES-ANDROID.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Notes for Android platforms
44
Requirement details
55
-------------------
66

7-
Beside basic tools like perl and make you'll need to download the Android
7+
Beside basic tools like perl and make, you'll need to download the Android
88
NDK. It's available for Linux, macOS and Windows, but only Linux
99
version was actually tested. There is no reason to believe that macOS
1010
wouldn't work. And as for Windows, it's unclear which "shell" would be
@@ -26,13 +26,13 @@ Notes for Android platforms
2626
invoke `$(CROSS_COMPILE)clang` [`*gcc` on NDK 19 and lower] and company.
2727
(`./Configure` will fail and give you a hint if you get it wrong.)
2828

29-
Apart from `PATH` adjustment you need to set `ANDROID_NDK_ROOT` environment
29+
Apart from `PATH` adjustment, you need to set `ANDROID_NDK_ROOT` environment
3030
to point at the `NDK` directory. If you're using a side-by-side NDK the path
3131
will look something like `/some/where/android-sdk/ndk/<ver>`, and for a
3232
standalone NDK the path will be something like `/some/where/android-ndk-<ver>`.
3333
Both variables are significant at both configuration and compilation times.
3434
The NDK customarily supports multiple Android API levels, e.g. `android-14`,
35-
`android-21`, etc. By default latest API level is chosen. If you need to target
35+
`android-21`, etc. By default, latest API level is chosen. If you need to target
3636
an older platform pass the argument `-D__ANDROID_API__=N` to `Configure`,
3737
with `N` being the numerical value of the target platform version. For example,
3838
to compile for Android 10 arm64 with a side-by-side NDK r20.0.5594570
@@ -59,15 +59,15 @@ Notes for Android platforms
5959
conflict, and mixing the two is therefore not supported. Migration to
6060
`CROSS_SYSROOT`-less setup is recommended.
6161

62-
One can engage clang by adjusting PATH to cover same NDK's clang. Just
62+
One can engage clang by adjusting PATH to cover the same NDK's clang. Just
6363
keep in mind that if you miss it, Configure will try to use gcc...
6464
Also, PATH would need even further adjustment to cover unprefixed, yet
6565
target-specific, ar and ranlib. It's possible that you don't need to
6666
bother, if binutils-multiarch is installed on your Linux system.
6767

6868
Another option is to create so called "standalone toolchain" tailored
6969
for single specific platform including Android API level, and assign its
70-
location to `ANDROID_NDK_ROOT`. In such case you have to pass matching
70+
location to `ANDROID_NDK_ROOT`. In such case, you have to pass matching
7171
target name to Configure and shouldn't use `-D__ANDROID_API__=N`. `PATH`
7272
adjustment becomes simpler, `$ANDROID_NDK_ROOT/bin:$PATH` suffices.
7373

NOTES-PERL.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ Perl on Windows
3333
---------------
3434

3535
There are a number of build targets that can be viewed as "Windows".
36-
Indeed, there are `VC-*` configs targeting VisualStudio C, as well as
36+
Indeed, there are `VC-*` configs targeting Visual Studio C, as well as
3737
MinGW and Cygwin. The key recommendation is to use a Perl installation
3838
that matches the build environment. For example, if you will build
3939
on Cygwin be sure to use the Cygwin package manager to install Perl.
4040
For MSYS builds use the MSYS provided Perl.
41-
For VC-* builds we recommend Strawberry Perl, from <http://strawberryperl.com>.
41+
For VC-* builds, we recommend Strawberry Perl, from <http://strawberryperl.com>.
4242
An alternative is ActiveState Perl, from <http://www.activestate.com/ActivePerl>
4343
for which you may need to explicitly select the Perl module Win32/Console.pm
4444
available via <https://platform.activestate.com/ActiveState>.

NOTES-UNIX.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,14 @@ Notes for UNIX-like platforms
101101
shared library face exactly the same problem with non-default locations.
102102
The OpenSSL config options mentioned above might or might not have bearing
103103
on linking of the target application. "Might" means that under some
104-
circumstances it would be sufficient to link with OpenSSL shared library
104+
circumstances, it would be sufficient to link with OpenSSL shared library
105105
"naturally", i.e. with `-L/whatever/path -lssl -lcrypto`. But there are
106106
also cases when you'd have to explicitly specify runtime search path
107107
when linking your application. Consult your system documentation and use
108108
above section as inspiration...
109109

110110
Shared OpenSSL builds also install static libraries. Linking with the
111-
latter is likely to require special care, because linkers usually look
111+
latter is likely to require special care because linkers usually look
112112
for shared libraries first and tend to remain "blind" to static OpenSSL
113113
libraries. Referring to system documentation would suffice, if not for
114114
a corner case. On AIX static libraries (in shared build) are named

NOTES-WINDOWS.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ or
2323

2424
"Hosted" OpenSSL relies on an external POSIX compatibility layer
2525
for building (using GNU/Unix shell, compiler, and tools) and at run time.
26-
For this option you can use Cygwin.
26+
For this option, you can use Cygwin.
2727

2828
Native builds using Visual C++
2929
==============================
@@ -212,15 +212,15 @@ Linking native applications
212212

213213
This section applies to all native builds.
214214

215-
If you link with static OpenSSL libraries then you're expected to
215+
If you link with static OpenSSL libraries, then you're expected to
216216
additionally link your application with `WS2_32.LIB`, `GDI32.LIB`,
217217
`ADVAPI32.LIB`, `CRYPT32.LIB` and `USER32.LIB`. Those developing
218218
non-interactive service applications might feel concerned about
219219
linking with `GDI32.LIB` and `USER32.LIB`, as they are justly associated
220220
with interactive desktop, which is not available to service
221221
processes. The toolkit is designed to detect in which context it's
222222
currently executed, GUI, console app or service, and act accordingly,
223-
namely whether or not to actually make GUI calls. Additionally those
223+
namely whether to actually make GUI calls. Additionally, those
224224
who wish to `/DELAYLOAD:GDI32.DLL` and `/DELAYLOAD:USER32.DLL` and
225225
actually keep them off service process should consider implementing
226226
and exporting from .exe image in question own `_OPENSSL_isservice` not
@@ -261,5 +261,5 @@ Apart from that, follow the Unix / Linux instructions in INSTALL.md.
261261

262262
NOTE: `make test` and normal file operations may fail in directories
263263
mounted as text (i.e. `mount -t c:\somewhere /home`) due to Cygwin
264-
stripping of carriage returns. To avoid this ensure that a binary
264+
stripping of carriage returns. To avoid this, ensure that a binary
265265
mount is used, e.g. `mount -b c:\somewhere /home`.

README-ENGINES.md

+33-33
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ Built-in ENGINE implementations
2222
There are currently built-in ENGINE implementations for the following
2323
crypto devices:
2424

25-
* Microsoft CryptoAPI
26-
* VIA Padlock
27-
* nCipher CHIL
25+
- Microsoft CryptoAPI
26+
- VIA Padlock
27+
- nCipher CHIL
2828

2929
In addition, dynamic binding to external ENGINE implementations is now
3030
provided by a special ENGINE called "dynamic". See the "DYNAMIC ENGINE"
3131
section below for details.
3232

3333
At this stage, a number of things are still needed and are being worked on:
3434

35-
1. Integration of EVP support.
36-
2. Configuration support.
37-
3. Documentation!
35+
1. Integration of EVP support.
36+
2. Configuration support.
37+
3. Documentation!
3838

3939
Integration of EVP support
4040
--------------------------
@@ -87,17 +87,17 @@ devices from common OpenSSL-based applications. Bugs and/or inexplicable
8787
behaviour in using a specific ENGINE implementation should be sent to the
8888
author of that implementation (if it is mentioned in the corresponding C
8989
file), and in the case of implementations for commercial hardware
90-
devices, also through whatever vendor support channels are available. If
90+
devices, also through whatever vendor support channels are available. If
9191
none of this is possible, or the problem seems to be something about the
9292
ENGINE API itself (ie. not necessarily specific to a particular ENGINE
9393
implementation) then you should mail complete details to the relevant
9494
OpenSSL mailing list. For a definition of "complete details", refer to
9595
the OpenSSL "README" file. As for which list to send it to:
9696

97-
* openssl-users: if you are *using* the ENGINE abstraction, either in an
98-
pre-compiled application or in your own application code.
97+
- openssl-users: if you are *using* the ENGINE abstraction, either in an
98+
pre-compiled application or in your own application code.
9999

100-
* openssl-dev: if you are discussing problems with OpenSSL source code.
100+
- openssl-dev: if you are discussing problems with OpenSSL source code.
101101

102102
USAGE
103103
=====
@@ -185,7 +185,7 @@ the shared-library ENGINE implementation. If this command succeeds, the
185185
(copy of the) 'dynamic' ENGINE will magically morph into the ENGINE
186186
that has been loaded from the shared-library. As such, any control
187187
commands supported by the loaded ENGINE could then be executed as per
188-
normal. Eg. if ENGINE "foo" is implemented in the shared-library
188+
normal. For instance, if ENGINE "foo" is implemented in the shared-library
189189
"libfoo.so" and it supports some special control command "CMD_FOO", the
190190
following code would load and use it (NB: obviously this code has no
191191
error checking);
@@ -270,35 +270,36 @@ This example will show building the "atalla" ENGINE in the
270270
crypto/engine/ directory as a shared-library for use via the "dynamic"
271271
ENGINE.
272272

273-
1. "cd" to the crypto/engine/ directory of a pre-compiled OpenSSL
274-
source tree.
273+
1. "cd" to the crypto/engine/ directory of a pre-compiled OpenSSL
274+
source tree.
275275

276-
2. Recompile at least one source file so you can see all the compiler
277-
flags (and syntax) being used to build normally. Eg;
276+
2. Recompile at least one source file so you can see all the compiler
277+
flags (and syntax) being used to build normally. Eg;
278278

279-
touch hw_atalla.c ; make
279+
touch hw_atalla.c ; make
280280

281-
will rebuild "hw_atalla.o" using all such flags.
281+
will rebuild "hw_atalla.o" using all such flags.
282282

283-
3. Manually enter the same compilation line to compile the
284-
"hw_atalla.c" file but with the following two changes;
285-
* add "-DENGINE_DYNAMIC_SUPPORT" to the command line switches,
286-
* change the output file from "hw_atalla.o" to something new,
287-
eg. "tmp_atalla.o"
283+
3. Manually enter the same compilation line to compile the
284+
"hw_atalla.c" file but with the following two changes;
288285

289-
4. Link "tmp_atalla.o" into a shared-library using the top-level
290-
OpenSSL libraries to resolve any dependencies. The syntax for doing
291-
this depends heavily on your system/compiler and is a nightmare
292-
known well to anyone who has worked with shared-library portability
293-
before. 'gcc' on Linux, for example, would use the following syntax;
286+
- add "-DENGINE_DYNAMIC_SUPPORT" to the command line switches,
287+
- change the output file from "hw_atalla.o" to something new,
288+
eg. "tmp_atalla.o"
294289

295-
gcc -shared -o dyn_atalla.so tmp_atalla.o -L../.. -lcrypto
290+
4. Link "tmp_atalla.o" into a shared-library using the top-level
291+
OpenSSL libraries to resolve any dependencies. The syntax for doing
292+
this depends heavily on your system/compiler and is a nightmare
293+
known well to anyone who has worked with shared-library portability
294+
before. 'gcc' on Linux, for example, would use the following syntax;
296295

297-
5. Test your shared library using "openssl engine" as explained in the
298-
previous section. Eg. from the top-level directory, you might try
296+
gcc -shared -o dyn_atalla.so tmp_atalla.o -L../.. -lcrypto
299297

300-
apps/openssl engine -vvvv dynamic \
301-
-pre SO_PATH:./crypto/engine/dyn_atalla.so -pre LOAD
298+
5. Test your shared library using "openssl engine" as explained in the
299+
previous section. Eg. from the top-level directory, you might try
300+
301+
apps/openssl engine -vvvv dynamic \
302+
-pre SO_PATH:./crypto/engine/dyn_atalla.so -pre LOAD
302303

303304
If the shared-library loads successfully, you will see both "-pre"
304305
commands marked as "SUCCESS" and the list of control commands
@@ -314,4 +315,3 @@ It seems like the ENGINE part doesn't work too well with CryptoSwift on Win32.
314315
A quick test done right before the release showed that trying "openssl speed
315316
-engine cswift" generated errors. If the DSO gets enabled, an attempt is made
316317
to write at memory address 0x00000002.
317-

README-FIPS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The FIPS module must have the self tests run, and the FIPS module config file
5050
output generated on every machine that it is to be used on. You must not copy
5151
the FIPS module config file output data from one machine to another.
5252

53-
On Unix the `openssl fipsinstall` command will be invoked as follows by default:
53+
On Unix, the `openssl fipsinstall` command will be invoked as follows by default:
5454

5555
$ openssl fipsinstall -out /usr/local/ssl/fipsmodule.cnf -module /usr/local/lib/ossl-modules/fips.so
5656

README-PROVIDERS.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Standard Providers
1515
Providers are containers for algorithm implementations. Whenever a cryptographic
1616
algorithm is used via the high level APIs a provider is selected. It is that
1717
provider implementation that actually does the required work. There are five
18-
providers distributed with OpenSSL. In the future we expect third parties to
18+
providers distributed with OpenSSL. In the future, we expect third parties to
1919
distribute their own providers which can be added to OpenSSL dynamically.
2020
Documentation about writing providers is available on the [provider(7)]
2121
manual page.
@@ -31,10 +31,10 @@ explicitly (e.g. in the application or via config), then this is the provider
3131
that will be used. It is loaded automatically the first time that we try to
3232
get an algorithm from a provider if no other provider has been loaded yet.
3333
If another provider has already been loaded then it won't be loaded
34-
automatically. Therefore if you want to use it in conjunction with other
35-
providers then you must load it explicitly.
34+
automatically. Therefore, if you want to use it in conjunction with other
35+
providers, then you must load it explicitly.
3636

37-
This is a "built-in" provider which means that it is compiled and linked
37+
This is a "built-in" provider, which means that it is compiled and linked
3838
into the libcrypto library and does not exist as a separate standalone module.
3939

4040
The Legacy Provider
@@ -58,7 +58,7 @@ The FIPS provider contains a sub-set of the algorithm implementations available
5858
from the default provider, consisting of algorithms conforming to FIPS standards.
5959
It is intended that this provider will be FIPS140-2 validated.
6060

61-
In some cases there may be minor behavioural differences between algorithm
61+
In some cases, there may be minor behavioural differences between algorithm
6262
implementations in this provider compared to the equivalent algorithm in the
6363
default provider. This is typically in order to conform to FIPS standards.
6464

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ Source code tarballs of the official releases can be downloaded from
6363
The OpenSSL project does not distribute the toolkit in binary form.
6464

6565
However, for a large variety of operating systems precompiled versions
66-
of the OpenSSL toolkit are available. In particular on Linux and other
67-
Unix operating systems it is normally recommended to link against the
66+
of the OpenSSL toolkit are available. In particular, on Linux and other
67+
Unix operating systems, it is normally recommended to link against the
6868
precompiled shared libraries provided by the distributor or vendor.
6969

7070
For Testing and Development
@@ -94,7 +94,7 @@ GitHub and clone your public fork instead.
9494

9595
git clone https://github.com/yourname/openssl.git
9696

97-
This is necessary, because all development of OpenSSL nowadays is done via
97+
This is necessary because all development of OpenSSL nowadays is done via
9898
GitHub pull requests. For more details, see [Contributing](#contributing).
9999

100100
Build and Install
@@ -133,7 +133,7 @@ Wiki
133133
----
134134

135135
There is a Wiki at [wiki.openssl.org] which is currently not very active.
136-
It contains a lot of useful information, not all of which is up to date.
136+
It contains a lot of useful information, not all of which is up-to-date.
137137

138138
License
139139
=======
@@ -148,7 +148,7 @@ Support
148148
=======
149149

150150
There are various ways to get in touch. The correct channel depends on
151-
your requirement. see the [SUPPORT](SUPPORT.md) file for more details.
151+
your requirement. See the [SUPPORT](SUPPORT.md) file for more details.
152152

153153
Contributing
154154
============
@@ -160,7 +160,7 @@ Legalities
160160
==========
161161

162162
A number of nations restrict the use or export of cryptography. If you are
163-
potentially subject to such restrictions you should seek legal advice before
163+
potentially subject to such restrictions, you should seek legal advice before
164164
attempting to develop or distribute cryptographic code.
165165

166166
Copyright

0 commit comments

Comments
 (0)