]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: assorted typo fixes in the documentation and Makefile
authorIlya Shipitsin <chipitsine@gmail.com>
Fri, 6 Mar 2020 08:07:38 +0000 (13:07 +0500)
committerWilly Tarreau <w@1wt.eu>
Fri, 6 Mar 2020 09:49:55 +0000 (10:49 +0100)
This is another round of cleanups in various docs and comments in the
Makefile.

CONTRIBUTING
INSTALL
Makefile
doc/SPOE.txt
doc/architecture.txt
doc/coding-style.txt
doc/management.txt
doc/regression-testing.txt

index 201e122d44761b146fb24d9708ce978342083ae2..638a64603d4a0f8bcdb7b7400afe4a46104894b2 100644 (file)
@@ -234,7 +234,7 @@ do not think about them anymore after a few patches.
    indented code, which only proves that the person has no consideration for
    quality and/or has done it in a hurry (probably worse). Please note that most
    bugs were found in low-quality code. Reviewers know this and tend to be much
-   more reluctant to accept poorly formated code because by experience they
+   more reluctant to accept poorly formatted code because by experience they
    won't trust their author's ability to write correct code. It is also worth
    noting that poor quality code is painful to read and may result in nobody
    willing to waste their time even reviewing your work.
@@ -990,7 +990,7 @@ How to be sure to irritate everyone
 Among the best ways to quickly lose everyone's respect, there is this small
 selection, which should help you improve the way you work with others, if
 you notice you're already practising some of them:
-  - repeatedly send improperly formated commit messages, with no type or
+  - repeatedly send improperly formatted commit messages, with no type or
     severity, or with no commit message body. These ones require manual
     edition, maintainers will quickly learn to recognize your name.
 
diff --git a/INSTALL b/INSTALL
index fc0976af596db6448c631b56aea568c4415c22a7..78424ee3c7133f0b1cf49db696f89c2367d361e2 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -128,7 +128,7 @@ options involved.
 HAProxy in its basic form does not depend on anything beyond a working libc.
 However a number of options are enabled by default, or are highly recommended,
 and these options will typically involve some external components or libraries,
-depending on the targetted platform.
+depending on the targeted platform.
 
 Optional dependencies may be split into several categories :
 
@@ -286,7 +286,7 @@ can be downloaded http://libslz.org/ and is even easier to build.
 
 4.7) Lua
 --------
-Lua is an embedded programming langage supported by HAProxy to provide more
+Lua is an embedded programming language supported by HAProxy to provide more
 advanced scripting capabilities. Only versions 5.3 and above are supported.
 In order to enable Lua support, please specify "USE_LUA=1" on the command line.
 Some systems provide this library under various names to avoid conflicts with
@@ -523,7 +523,7 @@ Building on AIX 7.2 works fine using the "aix72-gcc" TARGET. It adds two
 special CFLAGS to prevent the loading of AIXs xmem.h and var.h. This is done
 by defining the corresponding include-guards _H_XMEM and _H_VAR. Without
 excluding those header-files the build fails because of redefinition errors.
-Futhermore, the atomic library is added to the LDFLAGS to allow for
+Furthermore, the atomic library is added to the LDFLAGS to allow for
 multithreading via USE_THREAD.
 
 You can easily define your own target with the GNU Makefile. Unknown targets
index 6c1d3ece129a1dd6f039883a87a1a5117f6afdae..4c823fa30c073ce69877d1ead12e265477912a20 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -40,7 +40,7 @@
 #   USE_LUA              : enable Lua support.
 #   USE_FUTEX            : enable use of futex on kernel 2.6. Automatic.
 #   USE_ACCEPT4          : enable use of accept4() on linux. Automatic.
-#   USE_MY_ACCEPT4       : use own implemention of accept4() if glibc < 2.10.
+#   USE_MY_ACCEPT4       : use own implementation of accept4() if glibc < 2.10.
 #   USE_PRCTL            : enable use of prctl(). Automatic.
 #   USE_ZLIB             : enable zlib library support.
 #   USE_SLZ              : enable slz library instead of zlib (pick at most one).
@@ -141,7 +141,7 @@ MANDIR = $(PREFIX)/share/man
 DOCDIR = $(PREFIX)/doc/haproxy
 
 #### TARGET system
-# Use TARGET=<target_name> to optimize for a specifc target OS among the
+# Use TARGET=<target_name> to optimize for a specific target OS among the
 # following list (use the default "generic" if uncertain) :
 #    linux-glibc, linux-glibc-legacy, solaris, freebsd, openbsd, netbsd,
 #    cygwin, haiku, aix51, aix52, aix72-gcc, osx, generic, custom
@@ -246,7 +246,7 @@ SILENT_DEFINE =
 # It's automatically appended depending on the targets.
 EXTRA =
 
-#### CPU dependant optimizations
+#### CPU dependent optimizations
 # Some CFLAGS are set by default depending on the target CPU. Those flags only
 # feed CPU_CFLAGS, which in turn feed CFLAGS, so it is not mandatory to use
 # them. You should not have to change these options. Better use CPU_CFLAGS or
@@ -260,7 +260,7 @@ CPU_CFLAGS.power8     = -O2 -mcpu=power8 -mtune=power8
 CPU_CFLAGS.power9     = -O2 -mcpu=power9 -mtune=power9
 CPU_CFLAGS            = $(CPU_CFLAGS.$(CPU))
 
-#### ARCH dependant flags, may be overridden by CPU flags
+#### ARCH dependent flags, may be overridden by CPU flags
 ARCH_FLAGS.32     = -m32
 ARCH_FLAGS.64     = -m64
 ARCH_FLAGS.i386   = -m32 -march=i386
index 19f00ad98d51f155494b47e680f14d6973dd91bb..366160255a086473300c628e75e5eeb77cec3406 100644 (file)
@@ -115,7 +115,7 @@ If you specify an engine name on the SPOE filter line, then you need to define
 scope in the SPOE configuration with the same name. You can have several SPOE
 scope in the same file. In each scope, you must define one and only one
 "spoe-agent" section to configure the SPOA linked to your SPOE and several
-"spoe-message" and "spoe-group" sections to describe, respecively, messages and
+"spoe-message" and "spoe-group" sections to describe, respectively, messages and
 group of messages sent to servers mananged by your SPOA.
 
 A SPOE scope starts with this kind of line :
index 85d5219bcaed44cd945063f75650c8a6b444ae6c..8174b5d98e985e95a85b7a9d1788da642887cb93 100644 (file)
@@ -257,7 +257,7 @@ Description :
  - if a request does not contain a cookie, it will be forwarded to a valid
    server
  - in return, if a JESSIONID cookie is seen, the server name will be prefixed
-   into it, followed by a delimitor ('~')
+   into it, followed by a delimiter ('~')
  - when the client comes again with the cookie "JSESSIONID=A~xxx", LB1 will
    know that it must be forwarded to server A. The server name will then be
    extracted from cookie before it is sent to the server.
@@ -1265,7 +1265,7 @@ S2L2. So only initial users will load the inter-site link, not the new ones.
 ===================
 
 Sometimes it may reveal useful to access servers from a pool of IP addresses
-instead of only one or two. Some equipments (NAT firewalls, load-balancers)
+instead of only one or two. Some equipment (NAT firewalls, load-balancers)
 are sensible to source address, and often need many sources to distribute the
 load evenly amongst their internal hash buckets.
 
index 9f1bd79eee51353a63e73d93af95bd0b6ba29e6e..24550f1f5dbd721935d9fd209d573c2d5a37cc89 100644 (file)
@@ -111,7 +111,7 @@ with "#", we get this :
   | [-Tabs-][-Tabs-]ctx->del = len;
   | [-Tabs-]}
 
-It is worth noting that some editors tend to confuse indentations and aligment.
+It is worth noting that some editors tend to confuse indentations and alignment.
 Emacs is notoriously known for this brokenness, and is responsible for almost
 all of the alignment mess. The reason is that Emacs only counts spaces, tries
 to fill as many as possible with tabs and completes with spaces. Once you know
@@ -1218,7 +1218,7 @@ Wrong use of comments :
 
 Right use of comments :
 
-  | /* This function returns the positoin of the highest bit set in the lowest
+  | /* This function returns the position of the highest bit set in the lowest
   |  * byte of <x>, between 0 and 7. It only works if <x> is non-null. It uses
   |  * a 32-bit value as a lookup table to return one of 4 values for the
   |  * highest 16 possible 4-bit values.
index 24969be8870d98813bbb7c71cef8445a6c9a9bc2..6425c19ee0e730a688aa305c8e02d88d00ce088e 100644 (file)
@@ -1476,7 +1476,7 @@ commit ssl cert <filename>
   the previous ones. Replace in memory the previous SSL certificates
   everywhere the <filename> was used in the configuration.
   Upon failure it doesn't remove or insert anything. Once the temporary
-  transaction is commited, it is destroyed.
+  transaction is committed, it is destroyed.
 
   See also "ssl set cert" and "abort ssl cert".
 
@@ -1527,7 +1527,7 @@ disable agent <backend>/<server>
   level "admin".
 
 disable dynamic-cookie backend <backend>
-  Disable the generation of dynamic cookies fot the backend <backend>
+  Disable the generation of dynamic cookies for the backend <backend>
 
 disable frontend <frontend>
   Mark the frontend as temporarily stopped. This corresponds to the mode which
@@ -2509,8 +2509,8 @@ show stat [{<iid>|<proxy>} <type> <sid>] [typed|json] [desc]
     python -m json.tool
 
 show ssl cert [<filename>]
-  Display the list of certicates used on frontends. If a filename is prefixed
-  by an asterisk, it is a transaction which is not commited yet.  If a
+  Display the list of certificates used on frontends. If a filename is prefixed
+  by an asterisk, it is a transaction which is not committed yet.  If a
   filename is specified, it will show details about the certificate. This
   command can be useful to check if a certificate was well updated. You can
   also display details on a transaction by prefixing the filename by an
index 320c51cdd7897227e644c4d10b80b3b6722c5dbe..1b6c21d10bb71aa056023f36c7299756dd39f862 100644 (file)
@@ -131,7 +131,7 @@ instance.
     #   BUG/MINOR: spoe: Initialize variables used during conf parsing before any check
 
     #   Some initializations must be done at the beginning of parse_spoe_flt to avoid
-    #   segmentaion fault when first errors are caught, when the "filter spoe" line is
+    #   segmentation fault when first errors are caught, when the "filter spoe" line is
     #   parsed.
 
     haproxy h1 -conf-BAD {} {