Fix typos found by codespell
authorDimitri Papadopoulos <3234522+DimitriPapadopoulos@users.noreply.github.com>
Wed, 10 May 2023 10:10:57 +0000 (12:10 +0200)
committerTomas Mraz <tomas@openssl.org>
Fri, 12 May 2023 08:26:49 +0000 (10:26 +0200)
Fix only typos in doc/man* for inclusion in 3.* branches.

Other typos have been fixed in a different commit.

Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/20924)

14 files changed:
doc/man3/DTLSv1_get_timeout.pod
doc/man3/DTLSv1_handle_timeout.pod
doc/man3/EC_GROUP_copy.pod
doc/man3/EC_KEY_new.pod
doc/man3/EC_POINT_add.pod
doc/man3/EC_POINT_new.pod
doc/man3/OSSL_CRMF_MSG_set0_validity.pod
doc/man3/OSSL_PARAM.pod
doc/man3/OSSL_PARAM_int.pod
doc/man3/PKCS7_sign.pod
doc/man3/SSL_CTX_set_options.pod
doc/man3/X509_STORE_CTX_new.pod
doc/man3/X509_get_default_cert_file.pod
doc/man7/provider-base.pod

index fbaf0f96123653b2d01e842eeaf85f20bb468551..8ef916415cebfab8f15a4a0244f228c2182c088c 100644 (file)
@@ -32,7 +32,7 @@ Once the timeout expires, DTLSv1_handle_timeout() should be called to handle any
 internal processing which is due; for more information, see
 L<DTLSv1_handle_timeout(3)>.
 
-L<SSL_get_tick_timeout(3)> supercedes all use cases for this this function and
+L<SSL_get_tick_timeout(3)> supersedes all use cases for this this function and
 may be used instead of it.
 
 =head1 RETURN VALUES
index 77c1a89ab4fd7ed9089c3ca5d0058cdeb72809d2..a188f0892480d0f132773b71238186d48e655e71 100644 (file)
@@ -21,7 +21,7 @@ when to call DTLSv1_handle_timeout().
 This function is only applicable to DTLS objects. It returns 0 if called on
 any other kind of SSL object.
 
-L<SSL_tick(3)> supercedes all use cases for this this function and may be used
+L<SSL_tick(3)> supersedes all use cases for this this function and may be used
 instead of it.
 
 =head1 RETURN VALUES
index 279fd0d197ffc6b5305f47de78c8c192b7c214cc..25c91d731bdfd0c7f213c2bb0879a561aa071906 100644 (file)
@@ -129,7 +129,7 @@ point_conversion_form_t is an enum defined as follows:
 For POINT_CONVERSION_UNCOMPRESSED the point is encoded as an octet signifying the UNCOMPRESSED form has been used followed by
 the octets for x, followed by the octets for y.
 
-For any given x co-ordinate for a point on a curve it is possible to derive two possible y values. For
+For any given x coordinate for a point on a curve it is possible to derive two possible y values. For
 POINT_CONVERSION_COMPRESSED the point is encoded as an octet signifying that the COMPRESSED form has been used AND which of
 the two possible solutions for y has been used, followed by the octets for x.
 
index 98c9adc8ae3a3e6a0dad3539c775adb410b4fae2..3c152d0aadbab3194afd6978ece5d73cae4c0357 100644 (file)
@@ -128,7 +128,7 @@ EC_KEY_check_key() performs various sanity checks on the EC_KEY object to
 confirm that it is valid.
 
 EC_KEY_set_public_key_affine_coordinates() sets the public key for I<key> based
-on its affine co-ordinates; i.e., it constructs an EC_POINT object based on
+on its affine coordinates; i.e., it constructs an EC_POINT object based on
 the supplied I<x> and I<y> values and sets the public key to be this
 EC_POINT. It also performs certain sanity checks on the key to confirm
 that it is valid.
index 10036c9596a273b3e54ebd5e6f5fb3df68de7a24..57f1dd87d083ec031e5b4ca34083628abb8dcaf0 100644 (file)
@@ -44,7 +44,7 @@ EC_POINT_is_on_curve tests whether the supplied point is on the curve or not.
 EC_POINT_cmp compares the two supplied points and tests whether or not they are equal.
 
 The functions EC_POINT_make_affine and EC_POINTs_make_affine force the internal representation of the EC_POINT(s) into the affine
-co-ordinate system. In the case of EC_POINTs_make_affine the value B<num> provides the number of points in the array B<points> to be
+coordinate system. In the case of EC_POINTs_make_affine the value B<num> provides the number of points in the array B<points> to be
 forced. These functions were deprecated in OpenSSL 3.0 and should no longer be used.
 Modern versions automatically perform this conversion when needed.
 
index e2e2c129eb3d6f2daa6ac4646e793b2b651e1bd4..fc8643cd6084535e1ceba5a4920a07be592a768d 100644 (file)
@@ -124,9 +124,9 @@ public concept.
 A valid point on a curve is the special point at infinity. A point is set to
 be at infinity by calling EC_POINT_set_to_infinity().
 
-The affine co-ordinates for a point describe a point in terms of its x and y
+The affine coordinates for a point describe a point in terms of its x and y
 position. The function EC_POINT_set_affine_coordinates() sets the B<x> and B<y>
-co-ordinates for the point B<p> defined over the curve given in B<group>. The
+coordinates for the point B<p> defined over the curve given in B<group>. The
 function EC_POINT_get_affine_coordinates() sets B<x> and B<y>, either of which
 may be NULL, to the corresponding coordinates of B<p>.
 
@@ -140,27 +140,27 @@ EC_POINT_get_affine_coordinates_GF2m() are synonyms for
 EC_POINT_get_affine_coordinates(). They are defined for backwards compatibility
 only and should not be used.
 
-As well as the affine co-ordinates, a point can alternatively be described in
-terms of its Jacobian projective co-ordinates (for Fp curves only). Jacobian
-projective co-ordinates are expressed as three values x, y and z. Working in
-this co-ordinate system provides more efficient point multiplication
-operations.  A mapping exists between Jacobian projective co-ordinates and
-affine co-ordinates. A Jacobian projective co-ordinate (x, y, z) can be written
-as an affine co-ordinate as (x/(z^2), y/(z^3)). Conversion to Jacobian
-projective from affine co-ordinates is simple. The co-ordinate (x, y) is mapped
+As well as the affine coordinates, a point can alternatively be described in
+terms of its Jacobian projective coordinates (for Fp curves only). Jacobian
+projective coordinates are expressed as three values x, y and z. Working in
+this coordinate system provides more efficient point multiplication
+operations.  A mapping exists between Jacobian projective coordinates and
+affine coordinates. A Jacobian projective coordinate (x, y, z) can be written
+as an affine coordinate as (x/(z^2), y/(z^3)). Conversion to Jacobian
+projective from affine coordinates is simple. The coordinate (x, y) is mapped
 to (x, y, 1). Although deprecated in OpenSSL 3.0 and should no longer be used,
-to set or get the projective co-ordinates in older versions use
+to set or get the projective coordinates in older versions use
 EC_POINT_set_Jprojective_coordinates_GFp() and
 EC_POINT_get_Jprojective_coordinates_GFp() respectively.
 Modern versions should instead use EC_POINT_set_affine_coordinates() and
 EC_POINT_get_affine_coordinates(), performing the conversion manually using the
 above maps in such rare circumstances.
 
-Points can also be described in terms of their compressed co-ordinates. For a
+Points can also be described in terms of their compressed coordinates. For a
 point (x, y), for any given value for x such that the point is on the curve
 there will only ever be two possible values for y. Therefore, a point can be set
 using the EC_POINT_set_compressed_coordinates() function where B<x> is the x
-co-ordinate and B<y_bit> is a value 0 or 1 to identify which of the two
+coordinate and B<y_bit> is a value 0 or 1 to identify which of the two
 possible values for y should be used.
 
 The functions EC_POINT_set_compressed_coordinates_GFp() and
index 5984abe51b54867eb755fb1fc442eb8065d2c6f8..4add69c40da629cdeea4065b5b65f9b702fd267e 100644 (file)
@@ -68,7 +68,7 @@ may be NULL to select the defaults.
 In case the method is OSSL_CRMF_POPO_SIGNATURE the POPO is calculated
 using the private key I<pkey> and the digest method I<digest>,
 where the I<digest> argument is ignored if I<pkey> is of a type (such as
-Ed25519 and Ed448) that is implicitly associated with a digest alorithm.
+Ed25519 and Ed448) that is implicitly associated with a digest algorithm.
 
 I<meth> can be one of the following:
 
index db669c28ead91374ac278739b77ef952648968f5..a1a275e0921aeeb13a6f0c92a680701dc7495eef 100644 (file)
@@ -40,11 +40,11 @@ suitable form for the internal structure of the object.
 
 =item * Request parameters of some object
 
-The caller (the I<requestor>) sets up the B<OSSL_PARAM> array and
+The caller (the I<requester>) sets up the B<OSSL_PARAM> array and
 calls some function (the I<responder>) that has intimate knowledge
 about the object, which can take the internal data of the object and
 copy (possibly convert) that to the memory prepared by the
-I<requestor> and pointed at with the B<OSSL_PARAM> I<data>.
+I<requester> and pointed at with the B<OSSL_PARAM> I<data>.
 
 =item * Request parameter descriptors
 
@@ -111,7 +111,7 @@ size should be set to the size of the buffer to be populated, which
 should accommodate enough space for a terminating NUL byte.
 
 When I<requesting parameters>, it's acceptable for I<data> to be NULL.
-This can be used by the I<requestor> to figure out dynamically exactly
+This can be used by the I<requester> to figure out dynamically exactly
 how much buffer space is needed to store the parameter data.
 In this case, I<data_size> is ignored.
 
index ffe7c8c76a1852ffde49f37e5e9ad064edbb8378..091a9e9e367079cb77aaef0e119954dd41749196 100644 (file)
@@ -367,7 +367,7 @@ This example is for setting parameters on some object:
 =head2 Example 2
 
 This example is for requesting parameters on some object, and also
-demonstrates that the requestor isn't obligated to request all
+demonstrates that the requester isn't obligated to request all
 available parameters:
 
     const char *foo = NULL;
index b255ab61fedbd4ee43ab2c741b3022963a11ff79..3ad8cbf3391feabbeccbbe790ea2f1fecaf20ba2 100644 (file)
@@ -96,7 +96,7 @@ not be NULL.
 
 PKCS7_sign() is like PKCS7_sign_ex() except that it uses default values of
 NULL for the library context I<libctx> and the property query I<propq>.
-This is retained for API backward compatibiliy.
+This is retained for API backward compatibility.
 
 =head1 BUGS
 
index bed8c275a343280c3edddfcd716afa653b45b26b..c7170b160aa572820e8161e262cedc4cde9122f1 100644 (file)
@@ -221,7 +221,7 @@ description of the replay protection feature. Anti-replay measures are required
 to comply with the TLSv1.3 specification. Some applications may be able to
 mitigate the replay risks in other ways and in such cases the built in OpenSSL
 functionality is not required. Those applications can turn this feature off by
-setting this option. This is a server-side opton only. It is ignored by
+setting this option. This is a server-side option only. It is ignored by
 clients.
 
 =item SSL_OP_NO_TX_CERTIFICATE_COMPRESSION
index 7a347197678443ca1244d2755d4b6c28a686d555..d59599ed7b982162bbb65ef286ccc76397135bb2 100644 (file)
@@ -106,7 +106,7 @@ this can be also set indirectly using X509_STORE_CTX_set0_untrusted().
 X509_STORE_CTX_init_rpk() sets up I<ctx> for a subsequent verification
 operation for the I<target> raw public key.
 It behaves similarly to X509_STORE_CTX_init().
-The I<target> raw public key can aslo be supplied separately, via
+The I<target> raw public key can also be supplied separately, via
 X509_STORE_CTX_set0_rpk().
 The I<target> public key is not copied (its reference count is not updated),
 and the caller must not free it before verification is complete.
index ad426956b0a6c1e2632783173bc8c1e3b11c3c7a..f3d9f397ffedf37311ea8bb2858b57cb17274118 100644 (file)
@@ -53,7 +53,7 @@ value returned by the corresponding function above should be used.
 
 X509_get_default_cert_path_env() returns the environment variable name which is
 recommended to specify a nondefault value to be used instead of the value
-returned by X509_get_default_cert_dir(). This environment variable supercedes
+returned by X509_get_default_cert_dir(). This environment variable supersedes
 the deprecated environment variable whose name is returned by
 X509_get_default_cert_dir_env(). This environment variable was deprecated as its
 contents can be interpreted ambiguously; see NOTES.
index 9f50771b38f3df75b4c791677e6f2a1eefcad6d2..c015b549671233b5750fb53947fcb0c2d10f459c 100644 (file)
@@ -310,7 +310,7 @@ get_nonce() retrieves a nonce using the passed I<salt> parameter
 of length I<salt_len> and operating system specific information.
 The I<salt> should contain uniquely identifying information and this is
 included, in an unspecified manner, as part of the output.
-The output is stored in a buffer which contrains at least I<min_len> and at
+The output is stored in a buffer which contains at least I<min_len> and at
 most I<max_len> bytes.  The buffer address is stored in I<*pout> and the
 buffer length returned to the caller.  On error, zero is returned.