]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: Use gender neutral language
authorJackie Tapia <jackie.tapia@sproutsocial.com>
Wed, 22 Jul 2020 23:59:40 +0000 (18:59 -0500)
committerWilly Tarreau <w@1wt.eu>
Sun, 26 Jul 2020 20:35:43 +0000 (22:35 +0200)
This patch updates the documentation files and code comments to avoid
the use of gender specific phrasing in favor of "they" or "it".

CONTRIBUTING
doc/architecture.txt
doc/coding-style.txt
doc/configuration.txt
doc/lua.txt
doc/management.txt
doc/peers-v2.0.txt
doc/proxy-protocol.txt
src/cli.c
src/haproxy.c

index 638a64603d4a0f8bcdb7b7400afe4a46104894b2..88733e19e952e3fa4e25800a913bdd9788bf6658 100644 (file)
@@ -279,7 +279,7 @@ do not think about them anymore after a few patches.
      error handling roughly represents half of the code, and that's about 3/4 of
      the configuration parser. Take the time to do something you're proud of. A
      good rule of thumb is to keep in mind that your code talks to a human and
-     tries to teach him/her how to proceed. It must then speak like a human.
+     tries to teach them how to proceed. It must then speak like a human.
 
    - The third most important level is the code and its accompanying comments,
      including the commit message which is a complement to your code and
@@ -1002,7 +1002,7 @@ you notice you're already practising some of them:
     and removed in a future version.
 
   - send a new patch iteration without taking *all* comments from previous
-    review into consideration, so that the reviewer discovers he/she has to do
+    review into consideration, so that the reviewer discovers they have to do
     the exact same work again.
 
   - "hijack" an existing thread to discuss something different or promote your
index 8174b5d98e985e95a85b7a9d1788da642887cb93..f359dd7f11b6dff15ec0dae4b0c360d8528b6bf3 100644 (file)
@@ -703,7 +703,7 @@ Description :
  - if a request does not contain a cookie, it will be forwarded to a valid
    server
  - if a request contains a cookie for a failed server, haproxy will insist
-   on trying to reach the server anyway, to let the user finish what he was
+   on trying to reach the server anyway, to let the user finish what they were
    doing. ("persist" option)
  - if the server is totally stopped, the connection will fail and the proxy
    will rebalance the client to another server ("redispatch")
@@ -798,7 +798,7 @@ once you see that the server does not receive any traffic, simply stop it :
   # /etc/init.d/httpd stop
 
 The associated backup server will in turn fail, and if any client still tries
-to access this particular server, he will be redispatched to any other valid
+to access this particular server, they will be redispatched to any other valid
 server because of the "redispatch" option.
 
 This method has an advantage : you never touch the proxy when doing server
index d60a87675ca539816e3289dd4b2eed58550303d3..5f4faeeef6835d0a2648db70370490dfd09cbbb6 100644 (file)
@@ -986,7 +986,7 @@ Wrong :
 It is very common for macros to do the wrong thing when used in a way their
 author did not have in mind. For this reason, macros must always be named with
 uppercase letters only. This is the only way to catch the developer's eye when
-using them, so that he double-checks whether he's taking risks or not. First,
+using them, so that they double-check whether they are taking a risk or not. First,
 macros must never ever be terminated by a semi-colon, or they will close the
 wrong block once in a while. For instance, the following will cause a build
 error before the "else" due to the double semi-colon :
index 93137ca2c23d36d45a48ce14b1c2294f4e4df6d8..1c6c8468da8c392f889467dc3d10305c995c1c2d 100644 (file)
@@ -9868,7 +9868,7 @@ stats refresh <delay>
   This statement is useful on monitoring displays with a permanent page
   reporting the load balancer's activity. When set, the HTML report page will
   include a link "refresh"/"stop refresh" so that the user can select whether
-  he wants automatic refresh of the page or not.
+  they want automatic refresh of the page or not.
 
   Though this statement alone is enough to enable statistics reporting, it is
   recommended to set all other settings in order to avoid relying on default
index 743276d50b7cb657b49627b383428a54c0105b60..96c2043ef6900bfba68390099cf729acce7f3890 100644 (file)
@@ -381,7 +381,7 @@ In most cases, an HAProxy Lua object needs some private data. These are always
 set in the index [0] of the array. The metatable entry "__tostring" returns the
 object name.
 
-The Lua developer can add entries to the HAProxy object. He just works carefully
+The Lua developer can add entries to the HAProxy object. They just work carefully
 and prevent to modify the index [0].
 
 Common HAproxy objects are:
index 7346d63013c811aada90b027b15645bc7166cf04..adbad95d346d4bf46c80a27cad9b88038da4e9b8 100644 (file)
@@ -467,7 +467,7 @@ To understand better how these signals are used, it is important to understand
 the whole restart mechanism.
 
 First, an existing haproxy process is running. The administrator uses a system
-specific command such as "/etc/init.d/haproxy reload" to indicate he wants to
+specific command such as "/etc/init.d/haproxy reload" to indicate they want to
 take the new configuration file into effect. What happens then is the following.
 First, the service script (/etc/init.d/haproxy or equivalent) will verify that
 the configuration file parses correctly using "haproxy -c". After that it will
index 344cb5609176202ebc0c9499c701ce92f819e9ee..af2bc37886ca2e17e087e2bad4afadfc7ce20ba4 100644 (file)
@@ -250,7 +250,7 @@ Encoded Remote Table Id | Update Id
 Remote Table Id is the numeric identifier of the table on the remote side.
 Update Id is the id of the last update locally committed.
 
-If a re-connection occurred, the sender should know he will have to restart the push of updates from this point.
+If a re-connection occurred, the sender should know they will have to restart the push of updates from this point.
 
 III) Initial full resync process.
 
@@ -261,7 +261,7 @@ An old soft-stopped process will close all established sessions with remote peer
 local process to push all known ending with a Resync Finished Message or a Resync Partial Message (if it it does not consider itself as full updated).
 
 A new process will wait for a an incoming connection from a local process during 5 seconds. It will learn the updates from this
-process until he will receive a Resync Finished Message or a Resync Partial Message. If it receive a  Resync Finished Message it will consider itself
+process until it receives a Resync Finished Message or a Resync Partial Message. If it receive a  Resync Finished Message it will consider itself
 as fully updated and stops to ask for resync. If it receive a Resync Partial Message it will wait once again for 5 seconds for an other incoming connection from a local process.
 Same thing if the session was broken before receiving any "Resync Partial Message" or "Resync Finished Message".
 
index fc1ca4a0445bba1e142885c4be116746fabaf9fc..0208afc9df2961b35bd3e216ce2f2b310bdf8bd2 100644 (file)
@@ -529,8 +529,8 @@ bytes specified by the length.
             uint8_t value[0];
         };
 
-A receiver may choose to skip over and ignore the TLVs he is not interested in
-or he does not understand. Senders can generate the TLVs only for
+A receiver may choose to skip over and ignore the TLVs it is not interested in
+or it does not understand. Senders can generate the TLVs only for
 the information they choose to publish.
 
 The following types have already been registered for the <type> field :
@@ -854,8 +854,8 @@ time, it ensures that improperly configured servers are quickly detected.
 Implementers should be very careful about not trying to automatically detect
 whether they have to decode the header or not, but rather they must only rely
 on a configuration parameter. Indeed, if the opportunity is left to a normal
-client to use the protocol, he will be able to hide his activities or make them
-appear as coming from someone else. However, accepting the header only from a
+client to use the protocol, it will be able to hide its activities or make them
+appear as coming from somewhere else. However, accepting the header only from a
 number of known sources should be safe.
 
 
index c1964df72bd3b51132550ec395c25e4ff33d5a75..da6932f1383955cb27e5115b661d8b061cc10dfb 100644 (file)
--- a/src/cli.c
+++ b/src/cli.c
@@ -1725,7 +1725,7 @@ static int _getsocks(char **args, char *payload, struct appctx *appctx, void *pr
        memset(&msghdr, 0, sizeof(msghdr));
        /*
         * First, calculates the total number of FD, so that we can let
-        * the caller know how much he should expects.
+        * the caller know how much it should expect.
         */
        px = proxies_list;
        while (px) {
index c3bc1f0e5cc86a2a8e45f156385a07678301a28e..c6f7394269c9dd216b1d429a18d1ecdd6e0e9564 100644 (file)
@@ -3370,8 +3370,8 @@ int main(int argc, char **argv)
                exit(1);
        }
 
-       /* If the user is not root, we'll still let him try the configuration
-        * but we inform him that unexpected behaviour may occur.
+       /* If the user is not root, we'll still let them try the configuration
+        * but we inform them that unexpected behaviour may occur.
         */
        if ((global.last_checks & LSTCHK_NETADM) && getuid())
                ha_warning("[%s.main()] Some options which require full privileges"