Browse Source

apps & al : Fix various typos, repeated words, align some spelling to LDP.
Mostly revamped from #16712
- fall thru -> fall through
- time stamp -> timestamp
- host name -> hostname
- ipv6 -> IPv6

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

FdaSilvaYY 1 year ago
parent
commit
9929c81702

+ 5 - 5
Configurations/README.md

@@ -145,7 +145,7 @@ In each table entry, the following keys are significant:
                            would then be 'OPENSSL_ABC_<version>' rather than
                            the default 'OPENSSL_<version>'. The string inserted
                            into symbol versions is obtained by mapping all
-                           letters in the "variant" identifier to upper case
+                           letters in the "variant" identifier to uppercase
                            and all non-alphanumeric characters to '_'.
 
         thread_scheme   => The type of threads is used on the
@@ -555,7 +555,7 @@ They are all expected to return a string with the lines they produce.
                         obj2lib(lib => "PATH/TO/libfile",
                                 objs => [ "PATH/TO/objectfile", ... ]);
 
-                  'lib' has the intended library file name *without*
+                  'lib' has the intended library filename *without*
                   extension, obj2lib is expected to add that.  'objs'
                   has the list of object files to build this library.
 
@@ -578,7 +578,7 @@ They are all expected to return a string with the lines they produce.
                                   objs => [ "PATH/TO/objectfile", ... ],
                                   deps => [ "PATH/TO/otherlibfile", ... ]);
 
-                  'lib' has the base (static) library ffile name
+                  'lib' has the base (static) library filename
                   *without* extension.  This is useful in case
                   supporting files are needed (such as import
                   libraries on Windows).
@@ -611,7 +611,7 @@ They are all expected to return a string with the lines they produce.
                                 objs => [ "PATH/TO/objectfile", ... ],
                                 deps => [ "PATH/TO/libfile", ... ]);
 
-                  'bin' has the intended executable file name
+                  'bin' has the intended executable filename
                   *without* extension, obj2bin is expected to add
                   that.  'objs' has the list of object files to build
                   this library.  'deps' has the list of library files
@@ -626,7 +626,7 @@ They are all expected to return a string with the lines they produce.
                         in2script(script => "PATH/TO/scriptfile",
                                   sources => [ "PATH/TO/infile", ... ]);
 
-                  'script' has the intended script file name.
+                  'script' has the intended script filename.
                   'sources' has the list of source files to build the
                   resulting script from.
 

+ 1 - 1
apps/demoSRP/srp_verifier.txt

@@ -1,6 +1,6 @@
 # This is a file that will be filled by the openssl srp routine.
 # You can initialize the file with additional groups, these are
-# records starting with a I followed by the g and N values and the id.
+# records starting with an I followed by the g and N values and the id.
 # The exact values ... you have to dig this out from the source of srp.c
 # or srp_vfy.c
 # The last value of an I is used as the default group for new users.

+ 2 - 2
apps/dhparam.c

@@ -283,7 +283,7 @@ int dhparam_main(int argc, char **argv)
                 * because, unlike PEM, there is no header to declare what
                 * the contents of the DER file are. The decoders just try
                 * and guess. Unfortunately with DHX key types they may guess
-                * wrong and think we have a DSA keytype. Therefore we try
+                * wrong and think we have a DSA keytype. Therefore, we try
                 * both DH and DHX sequentially.
                 */
                 keytype = "DHX";
@@ -365,7 +365,7 @@ int dhparam_main(int argc, char **argv)
 }
 
 /*
- * Historically we had the low level call DSA_dup_DH() to do this.
+ * Historically we had the low-level call DSA_dup_DH() to do this.
  * That is now deprecated with no replacement. Since we still need to do this
  * for backwards compatibility reasons, we do it "manually".
  */

+ 1 - 1
apps/engine.c

@@ -347,7 +347,7 @@ int engine_main(int argc, char **argv)
             break;
         case OPT_TT:
             test_avail_noise++;
-            /* fall thru */
+            /* fall through */
         case OPT_T:
             test_avail++;
             break;

+ 1 - 1
apps/lib/apps.c

@@ -1012,7 +1012,7 @@ int load_key_certs_crls(const char *uri, int format, int maybe_stdin,
              * so if the caller asked for a public key, and we got a private
              * key, we can still pass it back.
              */
-            /* fall thru */
+            /* fall through */
         case OSSL_STORE_INFO_PUBKEY:
             if (ppubkey != NULL) {
                 ok = (*ppubkey = OSSL_STORE_INFO_get1_PUBKEY(info)) != NULL;

+ 2 - 2
apps/lib/s_socket.c

@@ -56,7 +56,7 @@ BIO_ADDR *ourpeer = NULL;
 /*
  * init_client - helper routine to set up socket communication
  * @sock: pointer to storage of resulting socket.
- * @host: the host name or path (for AF_UNIX) to connect to.
+ * @host: the hostname or path (for AF_UNIX) to connect to.
  * @port: the port to connect to (ignored for AF_UNIX).
  * @bindhost: source host or path (for AF_UNIX).
  * @bindport: source port (ignored for AF_UNIX).
@@ -274,7 +274,7 @@ int report_server_accept(BIO *out, int asock, int with_address, int with_pid)
 /*
  * do_server - helper routine to perform a server operation
  * @accept_sock: pointer to storage of resulting socket.
- * @host: the host name or path (for AF_UNIX) to connect to.
+ * @host: the hostname or path (for AF_UNIX) to connect to.
  * @port: the port to connect to (ignored for AF_UNIX).
  * @family: desired socket family, may be AF_INET, AF_INET6, AF_UNIX or
  *  AF_UNSPEC

+ 1 - 1
apps/verify.c

@@ -352,7 +352,7 @@ static int cb(int ok, X509_STORE_CTX *ctx)
         switch (cert_error) {
         case X509_V_ERR_NO_EXPLICIT_POLICY:
             policies_print(ctx);
-            /* fall thru */
+            /* fall through */
         case X509_V_ERR_CERT_HAS_EXPIRED:
             /* Continue even if the leaf is a self-signed cert */
         case X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT:

+ 1 - 1
demos/sslecho/main.c

@@ -273,7 +273,7 @@ int main(int argc, char **argv)
         /* Create client SSL structure using dedicated client socket */
         ssl = SSL_new(ssl_ctx);
         SSL_set_fd(ssl, client_skt);
-        /* Set host name for SNI */
+        /* Set hostname for SNI */
         SSL_set_tlsext_host_name(ssl, rem_server_ip);
         /* Configure server hostname check */
         SSL_set1_host(ssl, rem_server_ip);

+ 2 - 2
doc/internal/man3/ossl_punycode_decode.pod

@@ -19,8 +19,8 @@ ossl_punycode_decode, ossl_a2ulabel, ossl_a2ucompare
 =head1 DESCRIPTION
 
 PUNYCODE encoding introduced in RFCs 3490-3492 is widely used for
-representation of host names in ASCII-only format. Some specifications,
-such as RFC 8398, require comparison of host names encoded in UTF-8 charset.
+representation of hostnames in ASCII-only format. Some specifications,
+such as RFC 8398, require comparison of hostnames encoded in UTF-8 charset.
 
 ossl_a2ulabel() decodes NUL-terminated hostname from PUNYCODE to UTF-8,
 using a provided buffer for output.

+ 2 - 2
engines/e_loader_attic.c

@@ -223,7 +223,7 @@ static OSSL_STORE_INFO *new_EMBEDDED(const char *new_pem_name,
 /*-
  * The try_decode function is called to check if the blob of data can
  * be used by this handler, and if it can, decodes it into a supported
- * OpenSSL type and returns a OSSL_STORE_INFO with the decoded data.
+ * OpenSSL type and returns an OSSL_STORE_INFO with the decoded data.
  * Input:
  *    pem_name:     If this blob comes from a PEM file, this holds
  *                  the PEM name.  If it comes from another type of
@@ -251,7 +251,7 @@ static OSSL_STORE_INFO *new_EMBEDDED(const char *new_pem_name,
  *    libctx:       The library context to be used if applicable
  *    propq:        The property query string for any algorithm fetches
  * Output:
- *    a OSSL_STORE_INFO
+ *    an OSSL_STORE_INFO
  */
 typedef OSSL_STORE_INFO *(*file_try_decode_fn)(const char *pem_name,
                                                const char *pem_header,

+ 2 - 2
include/openssl/engine.h

@@ -612,7 +612,7 @@ OSSL_DEPRECATEDIN_3_0 int ENGINE_get_flags(const ENGINE *e);
  */
 
 /*
- * Initialise a engine type for use (or up its reference count if it's
+ * Initialise an engine type for use (or up its reference count if it's
  * already in use). This will fail if the engine is not currently operational
  * and cannot initialise.
  */
@@ -620,7 +620,7 @@ OSSL_DEPRECATEDIN_3_0 int ENGINE_get_flags(const ENGINE *e);
 OSSL_DEPRECATEDIN_3_0 int ENGINE_init(ENGINE *e);
 #  endif
 /*
- * Free a functional reference to a engine type. This does not require a
+ * Free a functional reference to an engine type. This does not require a
  * corresponding call to ENGINE_free as it also releases a structural
  * reference.
  */

+ 1 - 1
ssl/ssl_lib.c

@@ -1151,7 +1151,7 @@ int SSL_dane_enable(SSL *s, const char *basedomain)
 
     /*
      * Default SNI name.  This rejects empty names, while set1_host below
-     * accepts them and disables host name checks.  To avoid side-effects with
+     * accepts them and disables hostname checks.  To avoid side-effects with
      * invalid input, set the SNI name first.
      */
     if (sc->ext.hostname == NULL) {

+ 1 - 1
test/cmp_protect_test.c

@@ -95,7 +95,7 @@ static int execute_calc_protection_pbmac_test(CMP_PROTECT_TEST_FIXTURE *fixture)
 
 /*
  * This function works similarly to parts of CMP_verify_signature in cmp_vfy.c,
- * but without the need for a OSSL_CMP_CTX or a X509 certificate
+ * but without the need for an OSSL_CMP_CTX or a X509 certificate
  */
 static int verify_signature(OSSL_CMP_MSG *msg,
                             ASN1_BIT_STRING *protection,

+ 1 - 1
test/recipes/80-test_cmp_http.t

@@ -52,7 +52,7 @@ my @app = qw(openssl cmp);
 # the CMP server configuration consists of:
 my $ca_dn;      # The CA's Distinguished Name
 my $server_dn;  # The server's Distinguished Name
-my $server_host;# The server's host name or IP address
+my $server_host;# The server's hostname or IP address
 my $server_port;# The server's port
 my $server_tls; # The server's TLS port, if any, or 0
 my $server_path;# The server's CMP alias

+ 4 - 4
test/x509_time_test.c

@@ -72,7 +72,7 @@ static TESTDATA_FORMAT x509_format_tests[] = {
         "20170217180105.001Z", 0, 0, -1, NULL,
     },
     {
-        /* time zone, check only */
+        /* timezone, check only */
         "20170217180105+0800", 0, 0, -1, NULL,
     },
     {
@@ -84,7 +84,7 @@ static TESTDATA_FORMAT x509_format_tests[] = {
         "20170217180105.001Z", 1, 0, -1, NULL,
     },
     {
-        /* time zone, set string */
+        /* timezone, set string */
         "20170217180105+0800", 1, 0, -1, NULL,
     },
     {
@@ -113,7 +113,7 @@ static TESTDATA_FORMAT x509_format_tests[] = {
         "040229180101Z", 0, 1, -1, NULL,
     },
     {
-        /* time zone, check only */
+        /* timezone, check only */
         "170217180154+0800", 0, 0, -1, NULL,
     },
     {
@@ -121,7 +121,7 @@ static TESTDATA_FORMAT x509_format_tests[] = {
         "1702171801Z", 1, 0, -1, NULL,
     },
     {
-        /* time zone, set string */
+        /* timezone, set string */
         "170217180154+0800", 1, 0, -1, NULL,
     },
     {