]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: missing information for the "description" keyword
authorBaptiste Assmann <bedis9@gmail.com>
Wed, 9 Oct 2013 04:51:49 +0000 (06:51 +0200)
committerWilly Tarreau <w@1wt.eu>
Thu, 10 Oct 2013 09:40:47 +0000 (11:40 +0200)
This keyword was not documented.

doc/configuration.txt

index bd4f851442f34fc8bb95f109d810b1e985b973e1..7aff1e6d8d0e6c47431a29b30b6daade0cc9957d 100644 (file)
@@ -2242,6 +2242,18 @@ default_backend <backend>
   See also : "use_backend", "reqsetbe", "reqisetbe"
 
 
+description <string>
+  Describe a listen, frontend or backend.
+  May be used in sections :   defaults | frontend | listen | backend
+                                 no    |    yes   |   yes  |   yes
+  Arguments : string
+
+  Allows to add a sentence to describe the related object in the HAProxy HTML
+  stats page. The description will be printed on the right of the object name
+  it describes.
+  No need to backslash spaces in the <string> arguments.
+
+
 disabled
   Disable a proxy, frontend or backend.
   May be used in sections :   defaults | frontend | listen | backend