]> git.kaiwu.me - haproxy.git/commitdiff
DOC: config: Fix documentation about dot character in variable names
authorChristopher Faulet <cfaulet@haproxy.com>
Tue, 27 Oct 2026 13:20:17 +0000 (14:20 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Tue, 27 Oct 2026 13:22:56 +0000 (14:22 +0100)
In the section 2.8 (Variables), the doc character ('.') was not listed in
the set of characters allowed in a variable name. However it is an
error. The dot character is allowed. It cannot be used in the scope. But it
is allowed in the name.

The bug was introduced with the commit b643fbb1a ("DOC: config: Add a
dedicated section about variables"), when the section 2.8 was added.

This patch could be backported as far as 2.8.

doc/configuration.txt

index 9d7537af3d76e05eb9bb39e91f3589d31343bade..d29631ef8a90f4892a79b05c44f33b311e490b7a 100644 (file)
@@ -1458,9 +1458,9 @@ amount of memory used by the variables by setting "tune.vars" global parameters.
 
 Variables must be designated using the format "<scope>.<name>". The <scope> is
 a single word indicating the life time of the variable. The <name> part, inside
-a scope, may only contain characters 'a-z', 'A-Z', '0-9' and '_'. It is unique
-in this scope but the same name in different scopes can be used and refers to
-different variables. Supported scopes are:
+a scope, may only contain characters 'a-z', 'A-Z', '0-9', '_' and '.'. It is
+unique in this scope but the same name in different scopes can be used and
+refers to different variables. Supported scopes are:
 
   * proc  : for variables known during the whole process lifespan and globally
             accessible. "proc" variables can be manipulated from the CLI using