From e05ad5dd996123bff31218fed54995216416b712 Mon Sep 17 00:00:00 2001 From: Aleks Date: Fri, 18 May 2018 17:47:47 +0200 Subject: [PATCH] docs: mention HAproxy protocol "version 1" ...as there's also a version 2. Closes #2579 --- docs/cmdline-opts/haproxy-protocol.d | 4 ++-- docs/libcurl/curl_easy_setopt.3 | 2 +- docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3 | 8 ++++---- lib/urldata.h | 2 +- src/tool_cfgable.h | 2 +- src/tool_help.c | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/cmdline-opts/haproxy-protocol.d b/docs/cmdline-opts/haproxy-protocol.d index 52e156058..cc41c9c44 100644 --- a/docs/cmdline-opts/haproxy-protocol.d +++ b/docs/cmdline-opts/haproxy-protocol.d @@ -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. diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index 01fecec86..bdaf59f6c 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -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 diff --git a/docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3 b/docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3 index 01e667d16..679ab2360 100644 --- a/docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3 +++ b/docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, , 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 @@ -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 diff --git a/lib/urldata.h b/lib/urldata.h index 7fae00fd9..b8e9ddd9b 100644 --- a/lib/urldata.h +++ b/lib/urldata.h @@ -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; diff --git a/src/tool_cfgable.h b/src/tool_cfgable.h index 9abaa9d39..b4973c7fc 100644 --- a/src/tool_cfgable.h +++ b/src/tool_cfgable.h @@ -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 */ diff --git a/src/tool_help.c b/src/tool_help.c index 6f5ad08d4..71862511f 100644 --- a/src/tool_help.c +++ b/src/tool_help.c @@ -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
", "Pass custom header(s) to server"}, {"-h, --help", -- 2.40.0