]> granicus.if.org Git - curl/commitdiff
docs: mention HAproxy protocol "version 1"
authorAleks <al-git001@none.at>
Fri, 18 May 2018 15:47:47 +0000 (17:47 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Fri, 18 May 2018 15:48:40 +0000 (17:48 +0200)
...as there's also a version 2.

Closes #2579

docs/cmdline-opts/haproxy-protocol.d
docs/libcurl/curl_easy_setopt.3
docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3
lib/urldata.h
src/tool_cfgable.h
src/tool_help.c

index 52e156058e288b8f691e32e29449c1b92e956cd8..cc41c9c447276fd99d86f07f1b5e05fc88b493df 100644 (file)
@@ -1,9 +1,9 @@
 Long: haproxy-protocol
-Help: Send HAProxy PROXY protocol header
+Help: Send HAProxy PROXY protocol v1 header
 Protocols: HTTP
 Added: 7.60.0
 ---
-Send a HAProxy PROXY protocol header at the beginning of the connection. This
+Send a HAProxy PROXY protocol v1 header at the beginning of the connection. This
 is used by some load balancers and reverse proxies to indicate the client's
 true IP address and port.
 
index 01fecec86ebf33ae7cd0dd3344ceea0fce942817..bdaf59f6c63007e2593b8112b394e89aa695c9b3 100644 (file)
@@ -186,7 +186,7 @@ Socks5 GSSAPI NEC mode. See \fICURLOPT_SOCKS5_GSSAPI_NEC(3)\fP
 .IP CURLOPT_PROXY_SERVICE_NAME
 Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
 .IP CURLOPT_HAPROXYPROTOCOL
-Send an HAProxy PROXY protocol header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP
+Send an HAProxy PROXY protocol v1 header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP
 .IP CURLOPT_SERVICE_NAME
 Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP
 .IP CURLOPT_INTERFACE
index 01e667d163c46b245e499050e11e61b119383684..679ab236026a94591e67f87a7595bb22059bf9bc 100644 (file)
@@ -5,7 +5,7 @@
 .\" *                            | (__| |_| |  _ <| |___
 .\" *                             \___|\___/|_| \_\_____|
 .\" *
-.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
 .\" *
 .\" * This software is licensed as described in the file COPYING, which
 .\" * you should have received as part of this distribution. The terms
@@ -22,7 +22,7 @@
 .\"
 .TH CURLOPT_HAPROXYPROTOCOL 3 "5 Feb 2018" "libcurl 7.60.0" "curl_easy_setopt options"
 .SH NAME
-CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol header
+CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol v1 header
 .SH SYNOPSIS
 #include <curl/curl.h>
 
@@ -30,7 +30,7 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
                           long haproxy_protocol);
 .SH DESCRIPTION
 A long parameter set to 1 tells the library to send an HAProxy PROXY
-protocol header at beginning of the connection. The default action is not to
+protocol v1 header at beginning of the connection. The default action is not to
 send this header.
 
 This option is primarily useful when sending test requests to a service that
@@ -38,7 +38,7 @@ expects this header.
 
 Most applications do not need this option.
 .SH DEFAULT
-0, do not send HAProxy PROXY protocol header
+0, do not send any HAProxy PROXY protocol header
 .SH PROTOCOLS
 HTTP
 .SH EXAMPLE
index 7fae00fd96a3017810596fe8eb54aa0575e5cfc3..b8e9ddd9b93ca8428ac1566e0acf3ad2f4ec0d7d 100644 (file)
@@ -1676,7 +1676,7 @@ struct UserDefined {
   bool stream_depends_e; /* set or don't set the Exclusive bit */
   int stream_weight;
 
-  bool haproxyprotocol; /* whether to send HAProxy PROXY protocol header */
+  bool haproxyprotocol; /* whether to send HAProxy PROXY protocol v1 header */
 
   struct Curl_http2_dep *stream_dependents;
 
index 9abaa9d394fedaa233d564735fa55e3ef8f5fb22..b4973c7fc9c219260cfa62ef00a971e6f0aae059 100644 (file)
@@ -252,7 +252,7 @@ struct OperationConfig {
   bool ssh_compression;           /* enable/disable SSH compression */
   long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
                                      0 is valid. default: CURL_HET_DEFAULT. */
-  bool haproxy_protocol;          /* whether to send HAProxy PROXY protocol */
+  bool haproxy_protocol;          /* whether to send HAProxy PROXY protocol v1 */
   struct GlobalConfig *global;
   struct OperationConfig *prev;
   struct OperationConfig *next;   /* Always last in the struct */
index 6f5ad08d4a29e926bb6896c3c1c3a3e5da2b4d95..71862511f2b6203b0be53be13b399b18a171a14a 100644 (file)
@@ -165,7 +165,7 @@ static const struct helptxt helptext[] = {
   {"-I, --head",
    "Show document info only"},
   {"    --haproxy-protocol",
-   "Send HAProxy PROXY protocol header"},
+   "Send HAProxy PROXY protocol v1 header"},
   {"-H, --header <header/@file>",
    "Pass custom header(s) to server"},
   {"-h, --help",