From: Willy Tarreau <w@1wt.eu>
Date: Wed, 7 Aug 2024 11:51:52 +0000 (+0200)
Subject: DOC: configuration: fix alphabetical ordering of {bs,fs}.aborted
X-Git-Tag: v3.1-dev5~37
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b681a9e48813742850299fb5207766ac6f15007d;p=thirdparty%2Fhaproxy.git

DOC: configuration: fix alphabetical ordering of {bs,fs}.aborted

These must be before {bs,fs}.id, not after. Should be backported wherever
068ce2d5d2 ("MINOR: stconn: Add samples to retrieve about stream aborts")
is (normally 3.0).
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index abca224508..d5c6a0e86f 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -23965,13 +23965,13 @@ Summary of sample fetch methods in this section and their respective types:
 
   keyword                                             output type
 ----------------------------------------------------+-------------
-bs.id                                                 integer
 bs.aborted                                            boolean
+bs.id                                                 integer
 bs.rst_code                                           integer
 distcc_body(<token>[,<occ>])                          binary
 distcc_param(<token>[,<occ>])                         integer
-fs.id                                                 integer
 fs.aborted                                            boolean
+fs.id                                                 integer
 fs.rst_code                                           integer
 payload(<offset>,<length>)                            binary
 payload_lv(<offset1>,<length>[,<offset2>])            binary
@@ -24004,14 +24004,14 @@ wait_end                                              boolean
 
 Detailed list:
 
-bs.id : integer
-  Returns the multiplexer's stream ID on the server side. It is the
-  multiplexer's responsibility to return the appropriate information.
-
 bs.aborted: boolean
   Returns true is an abort was received from the server for the current
   stream. Otherwise false is returned.
 
+bs.id : integer
+  Returns the multiplexer's stream ID on the server side. It is the
+  multiplexer's responsibility to return the appropriate information.
+
 bs.rst_code: integer
   Returns the reset code received from the server for the current stream. The
   code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from
@@ -24044,15 +24044,15 @@ distcc_param(<token>[,<occ>]) : integer
       # send large files to the big farm
       use_backend big_farm if { distcc_param(DOTI) gt 1000000 }
 
+fs.aborted: boolean
+  Returns true is an abort was received from the client for the current
+  stream. Otherwise false is returned.
+
 fs.id : integer
   Returns the multiplexer's stream ID on the client side. It is the
   multiplexer's responsibility to return the appropriate information. For
   instance, on a raw TCP, 0 is always returned because there is no stream.
 
-fs.aborted: boolean
-  Returns true is an abort was received from the client for the current
-  stream. Otherwise false is returned.
-
 fs.rst_code: integer
   Returns the reset code received from the client for the current stream. The
   code of the H2 RST_STREAM frame or the QUIC STOP_SENDING frame received from