From: Christopher Faulet <cfaulet@haproxy.com>
Date: Mon, 27 Nov 2023 17:27:47 +0000 (+0100)
Subject: DOC: config: Improve 'status' sample documentation
X-Git-Tag: v2.9-dev12~30
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=5d9c25bbea14fdc1a7caeb1d4b4164794b9e87c2;p=thirdparty%2Fhaproxy.git

DOC: config: Improve 'status' sample documentation

We clearly state the 'status' sample returns the status code the client will
receive, if no change happens on the HTTP response. This should avoid
ambiguities with the 'server-status' sample fetch.
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 76647e5e3c..b4827e00f5 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -22838,7 +22838,9 @@ set-cookie([<name>]) : string (deprecated)
 status : integer
   Returns an integer containing the HTTP status code in the HTTP response, for
   example, 302. It is mostly used within ACLs and integer ranges, for example,
-  to remove any Location header if the response is not a 3xx.
+  to remove any Location header if the response is not a 3xx. It will be the
+  status code received by the client if it is not changed, via a 'set-status'
+  action for instance.
 
   It may be used in tcp-check based expect rules.