From: Ilya Shipitsin Date: Sun, 20 Dec 2020 20:22:40 +0000 (+0500) Subject: DOC: assorted typo fixes in the documentation X-Git-Tag: v2.4-dev4~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2272d8aeea810669b56c70d58fd50311461ebce4;p=thirdparty%2Fhaproxy.git DOC: assorted typo fixes in the documentation This is another round of cleanups in various docs --- diff --git a/doc/coding-style.txt b/doc/coding-style.txt index 87cc47742a..59f0991fc6 100644 --- a/doc/coding-style.txt +++ b/doc/coding-style.txt @@ -1450,7 +1450,7 @@ calls on casted strings. Do not do that! It will inevitably lead to someone getting caught passing a constant string that will make the process crash (if lucky). Document the expectations, indicate that all arguments must be freeable and that the caller must be capable of strdup(), and make your function support -NULLs and docuemnt it (so that callers can deal with a failing strdup() on +NULLs and document it (so that callers can deal with a failing strdup() on allocation error). One valid alternative is to use a secondary channel to indicate whether the @@ -1549,7 +1549,7 @@ There are a few rules to respect in order to do this: in the early days of hparoxy, size_t is now heavily used and known to work everywhere. And do not perform the operations on the pointers, only on the integer types (and cast back again). Some compilers such as gcc are - extremely picky about this and wil often emit wrong code when they see + extremely picky about this and will often emit wrong code when they see equality conditions they believe is impossible and decide to optimize them away. diff --git a/doc/configuration.txt b/doc/configuration.txt index 023490f2da..1c78769d4b 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -606,7 +606,7 @@ own quotes. The keyword argument parser is exactly the same as the top-level one regarding quotes, except that is will not make special cases of backslashes. But what is -not always obvious is that the delimitors used inside must first be escaped or +not always obvious is that the delimiters used inside must first be escaped or quoted so that they are not resolved at the top level. Let's take this example making use of the "regsub" converter which takes 3 @@ -659,7 +659,7 @@ the second level: arg2=blah ___________/ / arg3=g _______________/ -Another approch consists in using single quotes outside the whole string and +Another approach consists in using single quotes outside the whole string and double quotes inside (so that the double quotes are not stripped again): http-request set-path '%[path,regsub("(foo|bar)",blah,g)]' @@ -683,7 +683,7 @@ thus single quotes are preferred (or double escaping). Example: arg2=my/\1 ________________/ / arg3 ______________________/ -Remember that backslahes are not escape characters withing single quotes and +Remember that backslahes are not escape characters within single quotes and that the whole word3 above is already protected against them using the single quotes. Conversely, if double quotes had been used around the whole expression, single the dollar character and the backslashes would have been resolved at top @@ -8639,7 +8639,7 @@ no option nolinger This option may be used both on frontends and backends, depending on the side where it is required. Use it on the frontend for clients, and on the backend for servers. While this option is technically supported in "defaults" - sections, it must really not be used there as it risks to accidently + sections, it must really not be used there as it risks to accidentally propagate to sections that must no use it and to cause problems there. If this option has been enabled in a "defaults" section, it can be disabled @@ -15488,7 +15488,7 @@ fix_is_valid - checks that all tag IDs and values are not empty and the tags IDs are well numeric - - checks the BeginString tag is the first tag with a valide FIX version + - checks the BeginString tag is the first tag with a valid FIX version - checks the BodyLength tag is the second one with the right body length - checks the MstType tag is the third tag. - checks that last tag in the message is the CheckSum tag with a valid @@ -17611,7 +17611,7 @@ ssl_c_chain_der : binary Returns the DER formatted chain certificate presented by the client when the incoming connection was made over an SSL/TLS transport layer. When used for an ACL, the value(s) to match against can be passed in hexadecimal form. One - can parse the result with any lib accepting ASN.1 DER data. It currentlly + can parse the result with any lib accepting ASN.1 DER data. It currently does not support resumed sessions. ssl_c_der : binary @@ -17987,7 +17987,7 @@ ssl_s_chain_der : binary Returns the DER formatted chain certificate presented by the server when the outgoing connection was made over an SSL/TLS transport layer. When used for an ACL, the value(s) to match against can be passed in hexadecimal form. One - can parse the result with any lib accepting ASN.1 DER data. It currentlly + can parse the result with any lib accepting ASN.1 DER data. It currently does not support resumed sessions. ssl_s_key_alg : string diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst index b6b9809e82..fb7eb0978c 100644 --- a/doc/lua-api/index.rst +++ b/doc/lua-api/index.rst @@ -2687,7 +2687,7 @@ StickTable class .. js:function:: StickTable.info() Returns stick table attributes as a Lua table. See HAProxy documentation for - "stick-table" for canonical info, or check out example bellow. + "stick-table" for canonical info, or check out example below. :returns: Lua table diff --git a/doc/management.txt b/doc/management.txt index b1ca95185b..36e47a405d 100644 --- a/doc/management.txt +++ b/doc/management.txt @@ -944,7 +944,7 @@ CSV output format for monitoring tools. The same format is provided on the Unix socket. Statistics are regroup in categories labelled as domains, corresponding to the -multiple components of HAProxy. There are two domains avaiable: proxy and dns. +multiple components of HAProxy. There are two domains available: proxy and dns. If not specified, the proxy domain is selected. Note that only the proxy statistics are printed on the HTTP page. @@ -1525,7 +1525,7 @@ commit ssl cert committed, it is destroyed. In the case of a new certificate (after a "new ssl cert" and in a "Unused" - state in "show ssl cert"), the certificate will be commited in a certificate + state in "show ssl cert"), the certificate will be committed in a certificate storage, but it won't be used anywhere in haproxy. To use it and generate its SNIs you will need to add it to a crt-list or a directory with "add ssl crt-list".