From: Willy Tarreau <w@1wt.eu>
Date: Fri, 6 Sep 2024 05:39:59 +0000 (+0200)
Subject: DOC: configuration: place the HAPROXY_HTTP_LOG_FMT example on the correct line
X-Git-Tag: v3.1-dev8~50
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=c22fc591d428c55d76b2e18799fca804fafaf558;p=thirdparty%2Fhaproxy.git

DOC: configuration: place the HAPROXY_HTTP_LOG_FMT example on the correct line

When HAPROXY_HTTP_LOG_FMT was added by commit 537b9e7f36 ("MINOR: config:
add environment variables for default log format"), the example was placed
by accident after the clf log format instead of the HTTP log format,
causing a bit of confusion.

This can be backported to 2.8.
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index aa6821683f..fd7ea4329a 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -25877,6 +25877,8 @@ instead. Refer to section 8.2.6 "Custom log format" to see how to use this:
     # strict equivalent of "option httplog"
     log-format "%ci:%cp [%tr] %ft %b/%s %TR/%Tw/%Tc/%Tr/%Ta %ST %B %CC \
                 %CS %tsc %ac/%fc/%bc/%sc/%rc %sq/%bq %hr %hs %{+Q}r"
+    # or using the HAPROXY_HTTP_LOG_FMT variable
+    log-format "${HAPROXY_HTTP_LOG_FMT}"
 
 And the CLF log format is internally declared as a custom log format based on
 this exact string:
@@ -25885,8 +25887,6 @@ this exact string:
     log-format "%{+Q}o %{-Q}ci - - [%trg] %r %ST %B \"\" \"\" %cp \
                 %ms %ft %b %s %TR %Tw %Tc %Tr %Ta %tsc %ac %fc \
                 %bc %sc %rc %sq %bq %CC %CS %hrl %hsl"
-    # or using the HAPROXY_HTTP_LOG_FMT variable
-    log-format "${HAPROXY_HTTP_LOG_FMT}"
 
 Most fields are shared with the TCP log, some being different. A few fields may
 slightly vary depending on some configuration options. Those ones are marked