docs/170341: [patch] Minor grammatical errors in engine(3)
Alan Amesbury
amesbury at umn.edu
Thu Aug 2 21:40:14 UTC 2012
>Number: 170341
>Category: docs
>Synopsis: [patch] Minor grammatical errors in engine(3)
>Confidential: no
>Severity: non-critical
>Priority: low
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Thu Aug 02 21:40:13 UTC 2012
>Closed-Date:
>Last-Modified:
>Originator: Alan Amesbury
>Release: FreeBSD 9.0-RELEASE-p1 amd64
>Organization:
University of Minnesota
>Environment:
FreeBSD [REDACTED] 9.0-RELEASE-p1 FreeBSD 9.0-RELEASE-p1 #0: Tue May 15 11:17:43 CDT 2012 root@[REDACTED]:/usr/obj/usr/src/sys/[REDACTED] amd64
>Description:
/usr/src/secure/lib/libcrypto/man/engine.3 contains grammatical errors.
>How-To-Repeat:
Read engine(3).
>Fix:
Patch.
Patch attached with submission follows:
--- engine.3 2012-07-03 12:22:17.848305224 -0500
+++ /tmp/engine.3 2012-08-02 16:29:21.000000000 -0500
@@ -321,7 +321,7 @@
that the structure can not be deallocated until the reference is released.
.PP
However, a structural reference provides no guarantee that the \s-1ENGINE\s0 is
-initiliased and able to use any of its cryptographic
+initialised and able to use any of its cryptographic
implementations. Indeed it's quite possible that most ENGINEs will not
initialise at all in typical environments, as ENGINEs are typically used to
support specialised hardware. To use an \s-1ENGINE\s0's functionality, you need a
@@ -330,8 +330,8 @@
implicitly contains a structural reference as well \- however to avoid
difficult-to-find programming bugs, it is recommended to treat the two
kinds of reference independently. If you have a functional reference to an
-\&\s-1ENGINE\s0, you have a guarantee that the \s-1ENGINE\s0 has been initialised ready to
-perform cryptographic operations and will remain uninitialised
+\&\s-1ENGINE\s0, you have a guarantee that the \s-1ENGINE\s0 has been initialised and is ready to
+perform cryptographic operations, and will remain initialised
until after you have released your reference.
.PP
\&\fIStructural references\fR
@@ -534,7 +534,7 @@
.PP
Here we'll assume we want to load and register all \s-1ENGINE\s0 implementations
bundled with OpenSSL, such that for any cryptographic algorithm required by
-OpenSSL \- if there is an \s-1ENGINE\s0 that implements it and can be initialise,
+OpenSSL \- if there is an \s-1ENGINE\s0 that implements it and can be initialised,
it should be used. The following code illustrates how this can work;
.PP
.Vb 4
>Release-Note:
>Audit-Trail:
>Unformatted:
More information about the freebsd-doc
mailing list