DOC: retry-on can only be used with mode http
authorJerome Magnin <jmagnin@haproxy.com>
Wed, 13 May 2020 18:09:57 +0000 (20:09 +0200)
committerWilly Tarreau <w@1wt.eu>
Thu, 28 May 2020 06:38:59 +0000 (08:38 +0200)
The documentation for retry-on hints at it being meant to be used
in conjuction with mode http, but since we've a had bug report
involving mode tcp and retry-on, lets make it explicit in the
documentation that it only works with mode http and will be
ignored otherwise.

(cherry picked from commit 5ce3c14aa97396502fe68c6ce42a32ea99361046)
Signed-off-by: Willy Tarreau <w@1wt.eu>

doc/configuration.txt

index e4245bf..9226d29 100644 (file)
@@ -7895,7 +7895,9 @@ retries <value>
 
 
 retry-on [list of keywords]
-  Specify when to attempt to automatically retry a failed request
+  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 :