From 714f34580ed31a2fd0604b2bfe2694d15aa04caf Mon Sep 17 00:00:00 2001 From: Willy Tarreau Date: Sun, 9 May 2021 06:47:26 +0200 Subject: [PATCH] DOC: fix a few remainig cases of "Haproxy" and "HAproxy" in doc and comments Some of the Lua doc and a few places still used "Haproxy" or "HAproxy". There was even one "HA proxy". A few of them were in an example of VTest output, indicating that VTest ought to be fixed as well. No big deal but better address all the remaining ones so that these inconsistencies stop spreading around. --- admin/syntax-highlight/haproxy.vim | 2 +- doc/SPOE.txt | 2 +- doc/architecture.txt | 4 ++-- doc/coding-style.txt | 2 +- doc/internals/hashing.txt | 4 ++-- doc/internals/htx-api.txt | 2 +- doc/lua-api/index.rst | 8 ++++---- doc/lua.txt | 6 +++--- doc/proxy-protocol.txt | 8 ++++---- doc/regression-testing.txt | 10 +++++----- include/haproxy/dns.h | 2 +- include/haproxy/filters-t.h | 2 +- src/dns.c | 2 +- src/mux_fcgi.c | 2 +- 14 files changed, 28 insertions(+), 28 deletions(-) diff --git a/admin/syntax-highlight/haproxy.vim b/admin/syntax-highlight/haproxy.vim index 48fd78c63..02c323255 100644 --- a/admin/syntax-highlight/haproxy.vim +++ b/admin/syntax-highlight/haproxy.vim @@ -1,5 +1,5 @@ " Vim syntax file -" Language: HAproxy +" Language: HAProxy " Maintainer: Bruno Michel " Last Change: Mar 30, 2007 " Version: 0.3 diff --git a/doc/SPOE.txt b/doc/SPOE.txt index 2ed7878be..ba7aca016 100644 --- a/doc/SPOE.txt +++ b/doc/SPOE.txt @@ -753,7 +753,7 @@ Here are the list of official capabilities that HAProxy and agents can support: * pipelining: This is the ability for a peer to decouple NOTIFY and ACK frames. This is a symmectical capability. To be used, it must - be supported by HAproxy and agents. Unlike HTTP pipelining, the + be supported by HAProxy and agents. Unlike HTTP pipelining, the ACK frames can be send in any order, but always on the same TCP connection used for the corresponding NOTIFY frame. diff --git a/doc/architecture.txt b/doc/architecture.txt index f359dd7f1..c37632f37 100644 --- a/doc/architecture.txt +++ b/doc/architecture.txt @@ -665,7 +665,7 @@ Description : When an application is spread across several servers, the time to update all instances increases, so the application seems jerky for a longer period. -HAproxy offers several solutions for this. Although it cannot be reconfigured +HAProxy offers several solutions for this. Although it cannot be reconfigured without being stopped, nor does it offer any external command, there are other working solutions. @@ -1342,7 +1342,7 @@ This ensures five essential principles : Example : --------- -Haproxy is installed in front of an application servers farm. It will limit +HAProxy is installed in front of an application servers farm. It will limit the concurrent connections to 4 per server (one thread per CPU), thus ensuring very fast response times. diff --git a/doc/coding-style.txt b/doc/coding-style.txt index 59f0991fc..02a55f513 100644 --- a/doc/coding-style.txt +++ b/doc/coding-style.txt @@ -1165,7 +1165,7 @@ obvious where to look for it and where to add it. All files should include because this is where build options are prepared. -Haproxy header files are split in two, those exporting the types only (named +HAProxy header files are split in two, those exporting the types only (named with a trailing "-t") and those exporting variables, functions and inline functions. Types, structures, enums and #defines must go into the types files which are the only ones that may be included by othertype files. Function diff --git a/doc/internals/hashing.txt b/doc/internals/hashing.txt index da358b04b..1541b610f 100644 --- a/doc/internals/hashing.txt +++ b/doc/internals/hashing.txt @@ -1,6 +1,6 @@ 2013/11/20 - How hashing works internally in haproxy - maddalab@gmail.com -This document describes how Haproxy implements hashing both map-based and +This document describes how HAProxy implements hashing both map-based and consistent hashing, both prior to versions 1.5 and the motivation and tests that were done when providing additional options starting in version 2.2 @@ -28,7 +28,7 @@ is quite suited to fit over a 32-bit space with enough variations so that a randomly picked number falls equally before any server position, which is ideal for consistently hashed backends, a common use case for caches. -In all versions 1.4 and prior Haproxy implements the SDBM hashing function. +In all versions 1.4 and prior HAProxy implements the SDBM hashing function. However tests show that alternatives to SDBM have a better cache distribution on different hashing criteria. Additional tests involving alternatives for hash input and an option to trigger avalanche, we found diff --git a/doc/internals/htx-api.txt b/doc/internals/htx-api.txt index 516cd67a3..971328bb9 100644 --- a/doc/internals/htx-api.txt +++ b/doc/internals/htx-api.txt @@ -299,7 +299,7 @@ buffer. There are 2 functions to do so, the second one relying on the first : Both functions return a "zero-sized" HTX message if the buffer is null. This way, the HTX message is always valid. The first function is the default function to use. The second one is only useful when some content will be added. For -instance, it used by the HTX analyzers when HAproxy generates a response. Thus, +instance, it used by the HTX analyzers when HAProxy generates a response. Thus, the buffer is in a right state. Once the processing done, if the HTX message has been modified, the underlying diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst index fb7eb0978..e0bda2dc8 100644 --- a/doc/lua-api/index.rst +++ b/doc/lua-api/index.rst @@ -488,7 +488,7 @@ Core class end) .. - This example code is used in HAproxy configuration like this: + This example code is used in HAProxy configuration like this: :: @@ -511,7 +511,7 @@ Core class core.register_action("hello-world", { "tcp-req", "http-req" }, hello_world, 2) .. - This example code is used in HAproxy configuration like this: + This example code is used in HAProxy configuration like this: :: @@ -635,7 +635,7 @@ Core class end) .. - This example code is used in HAproxy configuration like this: + This example code is used in HAProxy configuration like this: :: @@ -2808,7 +2808,7 @@ Action class This attribute is an integer (6). It aborts the current message. The message processing is stopped and the transaction is terminated. For HTTP streams, - HAproxy assumes a response was already sent to the client. From the Lua + HAProxy assumes a response was already sent to the client. From the Lua actions point of view, when this code is used, the transaction is terminated with no reply. diff --git a/doc/lua.txt b/doc/lua.txt index d05ff1de1..1535e5974 100644 --- a/doc/lua.txt +++ b/doc/lua.txt @@ -384,7 +384,7 @@ object name. 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: +Common HAProxy objects are: - TXN : manipulates the transaction between the client and the server - Channel : manipulates proxified data between the client and the server @@ -488,7 +488,7 @@ yield must be jump to the root of execution. The intermediate setjmp() avoids this behaviour. - HAproxy start Lua execution + HAProxy start Lua execution + Lua puts a setjmp() + Lua executes code + Some code is executed in a pcall() @@ -515,7 +515,7 @@ after a yield. These parts are the sample fetches and the sample converters. So, the Lua code written in these parts of HAProxy must be quickly executed, and can not do actions which require yield like TCP connection or simple sleep. -HAproxy socket object +HAProxy socket object --------------------- The HAProxy design is optimized for the data transfers between a client and a diff --git a/doc/proxy-protocol.txt b/doc/proxy-protocol.txt index 0208afc9d..4d49d5cd1 100644 --- a/doc/proxy-protocol.txt +++ b/doc/proxy-protocol.txt @@ -49,13 +49,13 @@ Then comes a new class of products which we'll call "dumb proxies", not because they don't do anything, but because they're processing protocol-agnostic data. Both Stunnel[3] and Stud[4] are examples of such "dumb proxies". They talk raw TCP on one side, and raw SSL on the other one, and do that reliably, without -any knowledge of what protocol is transported on top of the connection. Haproxy +any knowledge of what protocol is transported on top of the connection. HAProxy running in pure TCP mode obviously falls into that category as well. The problem with such a proxy when it is combined with another one such as haproxy, is to adapt it to talk the higher level protocol. A patch is available for Stunnel to make it capable of inserting an X-Forwarded-For header in the -first HTTP request of each incoming connection. Haproxy is able not to add +first HTTP request of each incoming connection. HAProxy is able not to add another one when the connection comes from Stunnel, so that it's possible to hide it from the servers. @@ -698,7 +698,7 @@ extend the protocol with multibyte type values. 3. Implementations -Haproxy 1.5 implements version 1 of the PROXY protocol on both sides : +HAProxy 1.5 implements version 1 of the PROXY protocol on both sides : - the listening sockets accept the protocol when the "accept-proxy" setting is passed to the "bind" keyword. Connections accepted on such listeners will behave just as if the source really was the one advertised in the @@ -712,7 +712,7 @@ Haproxy 1.5 implements version 1 of the PROXY protocol on both sides : "accept-proxy", then the relayed information is the one advertised in this connection's PROXY line. - - Haproxy 1.5 also implements version 2 of the PROXY protocol as a sender. In + - HAProxy 1.5 also implements version 2 of the PROXY protocol as a sender. In addition, a TLV with limited, optional, SSL information has been added. Stunnel added support for version 1 of the protocol for outgoing connections in diff --git a/doc/regression-testing.txt b/doc/regression-testing.txt index aac312cde..d8d71b530 100644 --- a/doc/regression-testing.txt +++ b/doc/regression-testing.txt @@ -179,7 +179,7 @@ status. Here is the output when running this VTC file: **** h1 0.0 macro def h1_pid=6395 **** h1 0.0 macro def h1_name=/tmp/vtc.6377.64329194/h1 ** h1 0.0 Wait - ** h1 0.0 Stop HAproxy pid=6395 + ** h1 0.0 Stop HAProxy pid=6395 **** h1 0.0 STDOUT poll 0x10 ** h1 0.0 WAIT4 pid=6395 status=0x008b (user 0.000000 sys 0.000000) * h1 0.0 Expected exit: 0x1 signal: 0 core: 0 @@ -227,7 +227,7 @@ as expected (verbose mode execution): **** h1 0.0 macro def h1_pid=25558 **** h1 0.0 macro def h1_name=/tmp/vtc.25540.59b6ec5d/h1 ** h1 0.0 Wait - ** h1 0.0 Stop HAproxy pid=25558 + ** h1 0.0 Stop HAProxy pid=25558 *** h1 0.0 debug|[ALERT] (25558) : parsing [/tmp/vtc.25540.59b6ec5d/h1/cfg:10] : 'filter' : ''spoe' : missing config file' *** h1 0.0 debug|[ALERT] (25558) : Error(s) found in configuration file : /tmp/vtc.25540.59b6ec5d/h1/cfg *** h1 0.0 debug|[ALERT] (25558) : Fatal errors found in configuration. @@ -318,7 +318,7 @@ client and 's1' server with 'http1' as haproxy frontend. This frontend listen on TCP socket with 'my_frontend_fd' as file descriptor. # Mandatory line - varnishtest "Basic HAproxy test" + varnishtest "Basic HAProxy test" # As some macros for haproxy are used in this file, this line is mandatory. feature ignore_unknown_macro @@ -558,7 +558,7 @@ Here is the output produced by varnishtest with the latter VTC file: * top 0.0 RESETTING after /home/fred/src/varnish-cache-haproxy/d02286d.vtc ** h1 0.0 Reset and free h1 haproxy 15787 ** h1 0.0 Wait - ** h1 0.0 Stop HAproxy pid=15787 + ** h1 0.0 Stop HAProxy pid=15787 **** h1 0.0 Kill(2)=0: Success **** h1 0.0 STDOUT poll 0x10 ** h1 0.1 WAIT4 pid=15787 status=0x0002 (user 0.000000 sys 0.004000) @@ -693,7 +693,7 @@ of the "syslog" "expect" command: * top 0.0 RESETTING after /home/fred/src/varnish-cache-haproxy/d02286d.vtc ** h1 0.0 Reset and free h1 haproxy 12728 ** h1 0.0 Wait - ** h1 0.0 Stop HAproxy pid=12728 + ** h1 0.0 Stop HAProxy pid=12728 **** h1 0.0 Kill(2)=0: Success **** h1 0.0 STDOUT poll 0x10 ** h1 0.1 WAIT4 pid=12728 status=0x0002 (user 0.000000 sys 0.004000) diff --git a/include/haproxy/dns.h b/include/haproxy/dns.h index 00bfee0a8..84181c43d 100644 --- a/include/haproxy/dns.h +++ b/include/haproxy/dns.h @@ -2,7 +2,7 @@ * include/haproxy/dns.h * This file provides functions related to DNS protocol * - * Copyright (C) 2020 Haproxy Technologies + * Copyright (C) 2020 HAProxy Technologies * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public diff --git a/include/haproxy/filters-t.h b/include/haproxy/filters-t.h index 73fe574da..c86ef6f3d 100644 --- a/include/haproxy/filters-t.h +++ b/include/haproxy/filters-t.h @@ -145,7 +145,7 @@ struct flt_kw_list { * that can be detected if s->txn->status is 10X, or * if we're attempting a L7 retry. * Returns nothing. - * - http_reply : Called when, at any time, HA proxy decides to stop + * - http_reply : Called when, at any time, HAProxy decides to stop * the HTTP message's processing and to send a message * to the client (mainly, when an error or a redirect * occur). diff --git a/src/dns.c b/src/dns.c index 083850d95..6e0ae2600 100644 --- a/src/dns.c +++ b/src/dns.c @@ -1,7 +1,7 @@ /* * Name server resolution * - * Copyright 2020 Haproxy Technologies + * Copyright 2020 HAProxy Technologies * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License diff --git a/src/mux_fcgi.c b/src/mux_fcgi.c index c997c5692..14fc8b2e1 100644 --- a/src/mux_fcgi.c +++ b/src/mux_fcgi.c @@ -60,7 +60,7 @@ #define FCGI_CF_ABRTS_SENT 0x00000200 /* a record ABORT was successfully sent to all active streams */ #define FCGI_CF_ABRTS_FAILED 0x00000400 /* failed to abort processing of all streams */ #define FCGI_CF_WAIT_FOR_HS 0x00000800 /* We did check that at least a stream was waiting for handshake */ -#define FCGI_CF_KEEP_CONN 0x00001000 /* HAproxy is responsible to close the connection */ +#define FCGI_CF_KEEP_CONN 0x00001000 /* HAProxy is responsible to close the connection */ #define FCGI_CF_GET_VALUES 0x00002000 /* retrieve settings */ /* FCGI connection state (fcgi_conn->state) */