DOC: Improve documentation of the various hdr() fetches
authorTim Duesterhus <tim@bastelstu.be>
Sat, 23 Jan 2021 16:50:21 +0000 (17:50 +0100)
committerChristopher Faulet <cfaulet@haproxy.com>
Tue, 26 Jan 2021 08:22:43 +0000 (09:22 +0100)
commit27c70ae23c1f5b39c9757387559072a096c8aa8c
tree898d28a438b00439d1b385355b04850445990a9b
parent7704b0e1e1179a6e9730730bad6f35c0c6e7476f
DOC: Improve documentation of the various hdr() fetches

GitHub issue #796 notes that many administrators miss the fact that the `hdr()`
fetch (without the `f`) splits the header value at commas. This is only
mentioned at the end of a long paragraph.

This patch attempts to improve the documentation by:
- Explaning the "comma issue" as early as possible.
- Adding newlines to split the explanation into distinct sections.
- Reducing duplication by making the `res` siblings refer to their `req`
  counterparts.

This patch may be backported as long as it applies cleanly. During the
refactoring I needed to adjust several explanations for consistency and not all
of them might be available in older branches.
doc/configuration.txt