From: Lukas Tribus <lukas@ltri.eu>
Date: Wed, 8 Dec 2021 10:33:01 +0000 (+0100)
Subject: DOC: config: retry-on list is space-delimited
X-Git-Tag: v2.6-dev1~296
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=de16008c298d87b212807b9bb42d27f675be732b;p=thirdparty%2Fhaproxy.git

DOC: config: retry-on list is space-delimited

We are using comma-delimited list for init-addr for example, let's
document that this is space-delimited to avoid the guessing game.
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index 1e049012be..c810fa918f 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -10124,17 +10124,18 @@ retries <value>
   See also : "option redispatch"
 
 
-retry-on [list of keywords]
+retry-on [space-delimited list of keywords]
   Specify when to attempt to automatically retry a failed request.
   This setting is only valid when "mode" is set to http and is silently ignored
   otherwise.
   May be used in sections:    defaults | frontend | listen | backend
                                  yes   |    no    |   yes  |   yes
   Arguments :
-    <keywords>  is a list of keywords or HTTP status codes, each representing a
-                type of failure event on which an attempt to retry the request
-                is desired. Please read the notes at the bottom before changing
-                this setting. The following keywords are supported :
+    <keywords>  is a space-delimited list of keywords or HTTP status codes, each
+                representing a type of failure event on which an attempt to
+                retry the request is desired. Please read the notes at the
+                bottom before changing this setting. The following keywords are
+                supported :
 
       none              never retry
 
@@ -10207,6 +10208,9 @@ retry-on [list of keywords]
 
   The default is "conn-failure".
 
+  Example:
+    retry-on 503 504
+
   See also: "retries", "option redispatch", "tune.bufsize"
 
 server <name> <address>[:[port]] [param*]