RepoMirrors/haproxy
1
0
Fork 0
mirror of http://git.haproxy.org/git/haproxy.git/ synced 2025-02-16 10:36:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOC: assorted typo fixes in the documentation and Makefile

Browse Source 
This is another round of cleanups in various docs and comments in the
Makefile.
This commit is contained in:
Ilya Shipitsin 2020-03-06 13:07:38 +05:00 committed by Willy Tarreau
parent 8525fd95b2
commit 2a950d02a9
8 changed files with 19 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING
View 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 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 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 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 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 noting that poor quality code is painful to read and may result in nobody
willing to waste their time even reviewing your work. 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 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 selection, which should help you improve the way you work with others, if
you notice you're already practising some of them: 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 severity, or with no commit message body. These ones require manual
edition, maintainers will quickly learn to recognize your name. edition, maintainers will quickly learn to recognize your name.

6
INSTALL
View File

@ -128,7 +128,7 @@ options involved.
HAProxy in its basic form does not depend on anything beyond a working libc. 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, However a number of options are enabled by default, or are highly recommended,
and these options will typically involve some external components or libraries, 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 : 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 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. 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. 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 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 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 by defining the corresponding include-guards _H_XMEM and _H_VAR. Without
excluding those header-files the build fails because of redefinition errors. 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. multithreading via USE_THREAD.
You can easily define your own target with the GNU Makefile. Unknown targets You can easily define your own target with the GNU Makefile. Unknown targets

8
Makefile
View File

@ -40,7 +40,7 @@
# USE_LUA : enable Lua support. # USE_LUA : enable Lua support.
# USE_FUTEX : enable use of futex on kernel 2.6. Automatic. # USE_FUTEX : enable use of futex on kernel 2.6. Automatic.
# USE_ACCEPT4 : enable use of accept4() on linux. 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_PRCTL : enable use of prctl(). Automatic.
# USE_ZLIB : enable zlib library support. # USE_ZLIB : enable zlib library support.
# USE_SLZ : enable slz library instead of zlib (pick at most one). # USE_SLZ : enable slz library instead of zlib (pick at most one).
@ -141,7 +141,7 @@ MANDIR = $(PREFIX)/share/man
DOCDIR = $(PREFIX)/doc/haproxy DOCDIR = $(PREFIX)/doc/haproxy
#### TARGET system #### 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) : # following list (use the default "generic" if uncertain) :
# linux-glibc, linux-glibc-legacy, solaris, freebsd, openbsd, netbsd, # linux-glibc, linux-glibc-legacy, solaris, freebsd, openbsd, netbsd,
# cygwin, haiku, aix51, aix52, aix72-gcc, osx, generic, custom # cygwin, haiku, aix51, aix52, aix72-gcc, osx, generic, custom
@ -246,7 +246,7 @@ SILENT_DEFINE =
# It's automatically appended depending on the targets. # It's automatically appended depending on the targets.
EXTRA = EXTRA =
#### CPU dependant optimizations #### CPU dependent optimizations
# Some CFLAGS are set by default depending on the target CPU. Those flags only # 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 # 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 # 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.power9 = -O2 -mcpu=power9 -mtune=power9
CPU_CFLAGS = $(CPU_CFLAGS.$(CPU)) 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.32 = -m32
ARCH_FLAGS.64 = -m64 ARCH_FLAGS.64 = -m64
ARCH_FLAGS.i386 = -m32 -march=i386 ARCH_FLAGS.i386 = -m32 -march=i386

2
doc/SPOE.txt
View 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 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 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-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. group of messages sent to servers mananged by your SPOA.
A SPOE scope starts with this kind of line : A SPOE scope starts with this kind of line :

4
doc/architecture.txt
View File

@ -257,7 +257,7 @@ Description :
- if a request does not contain a cookie, it will be forwarded to a valid - if a request does not contain a cookie, it will be forwarded to a valid
server server
- in return, if a JESSIONID cookie is seen, the server name will be prefixed - 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 - 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 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. 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 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 are sensible to source address, and often need many sources to distribute the
load evenly amongst their internal hash buckets. load evenly amongst their internal hash buckets.

4
doc/coding-style.txt
View File

@ -111,7 +111,7 @@ with "#", we get this :
| [-Tabs-][-Tabs-]ctx->del = len; | [-Tabs-][-Tabs-]ctx->del = len;
| [-Tabs-]} | [-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 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 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 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 : 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 | * 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 | * a 32-bit value as a lookup table to return one of 4 values for the
| * highest 16 possible 4-bit values. | * highest 16 possible 4-bit values.

8
doc/management.txt
View File

@ -1476,7 +1476,7 @@ commit ssl cert <filename>
the previous ones. Replace in memory the previous SSL certificates the previous ones. Replace in memory the previous SSL certificates
everywhere the <filename> was used in the configuration. everywhere the <filename> was used in the configuration.
Upon failure it doesn't remove or insert anything. Once the temporary 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". See also "ssl set cert" and "abort ssl cert".
@ -1527,7 +1527,7 @@ disable agent <backend>/<server>
level "admin". level "admin".
disable dynamic-cookie backend <backend> 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> disable frontend <frontend>
Mark the frontend as temporarily stopped. This corresponds to the mode which 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 python -m json.tool
show ssl cert [<filename>] show ssl cert [<filename>]
Display the list of certicates used on frontends. If a filename is prefixed Display the list of certificates used on frontends. If a filename is prefixed
by an asterisk, it is a transaction which is not commited yet. If a 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 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 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 also display details on a transaction by prefixing the filename by an

2
doc/regression-testing.txt
View File

@ -131,7 +131,7 @@ instance.
# BUG/MINOR: spoe: Initialize variables used during conf parsing before any check # 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 # 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. # parsed.
haproxy h1 -conf-BAD {} { haproxy h1 -conf-BAD {} {