]> git.ipfire.org Git - thirdparty/haproxy.git/commit
DOC: config: uniformize the naming and description of custom log format args
authorWilly Tarreau <w@1wt.eu>
Fri, 24 May 2024 14:18:20 +0000 (16:18 +0200)
committerWilly Tarreau <w@1wt.eu>
Fri, 24 May 2024 15:32:59 +0000 (17:32 +0200)
commitc02cefce235c17b7809832735d315db675ee69ba
treece277919219e8fa79792920aadf6882106d98595
parent474cbcf842ca95c93802840847603b5098864fde
DOC: config: uniformize the naming and description of custom log format args

A significant number of actions now take arguments that are evaluated as
log-format expressions. Some of them are called "fmt", others "string".
The description of the argument sometimes just says "the log-format
string" or "log format" or "custom log format" etc. Most of them do not
mention the section to visit, and section 8.2 speaking about log-format
is very centric on logs usage (the primary use case), making all of this
very confusing for newcomers.

Since section 8.2.6 is titled "Custom log format" and describes the syntax
to be used with the "log-format" (and other) directives, let's call this
"Custom log format" everywhere and mention section 8.2.6. When the field
was called "string", it was also renamed to "fmt".

It doesn't seem worth backporting this, unless it applies fine.
doc/configuration.txt