From: Willy Tarreau <w@1wt.eu>
Date: Thu, 4 Dec 2025 14:44:38 +0000 (+0100)
Subject: DOC: config: reorder the cache section's keywords
X-Git-Tag: v3.4-dev1~59
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=d2a1665af0450979d0a6d1bf43d0b8cd99e08d7b;p=thirdparty%2Fhaproxy.git

DOC: config: reorder the cache section's keywords

Probably due to historical accumulation, keywords were in a random
order that doesn't help when looking them up. Let's just reorder them
in alphabetical order like other sections. This can be backported.
---

diff --git a/doc/configuration.txt b/doc/configuration.txt
index b0fe209e0..98459c440 100644
--- a/doc/configuration.txt
+++ b/doc/configuration.txt
@@ -19673,15 +19673,6 @@ cache <name>
   Declare a cache section, allocate a shared cache memory named <name>, the
   size of cache is mandatory (see keyword "total-max-size" below).
 
-total-max-size <megabytes>
-  Define the size in RAM of the cache in megabytes. This size is split in
-  blocks of 1kB which are used by the cache entries. Its maximum value is 4095.
-
-max-object-size <bytes>
-  Define the maximum size of the objects to be cached. Must not be greater than
-  an half of "total-max-size". If not set, it equals to a 256th of the cache size.
-  All objects with sizes larger than "max-object-size" will not be cached.
-
 max-age <seconds>
   Define the maximum expiration duration. The expiration is set as the lowest
   value between the s-maxage or max-age (in this order) directive in the
@@ -19689,6 +19680,16 @@ max-age <seconds>
   seconds, which means that you can't cache an object more than 60 seconds by
   default.
 
+max-object-size <bytes>
+  Define the maximum size of the objects to be cached. Must not be greater than
+  an half of "total-max-size". If not set, it equals to a 256th of the cache size.
+  All objects with sizes larger than "max-object-size" will not be cached.
+
+max-secondary-entries <number>
+  Define the maximum number of simultaneous secondary entries with the same primary
+  key in the cache. This needs the vary support to be enabled. Its default value is 10
+  and should be passed a strictly positive integer.
+
 process-vary <on/off>
   Enable or disable the processing of the Vary header. When disabled, a response
   containing such a header will never be cached. When enabled, we need to calculate
@@ -19698,10 +19699,9 @@ process-vary <on/off>
   the contents of the 'accept-encoding', 'referer' and 'origin' headers for
   now. The default value is off (disabled).
 
-max-secondary-entries <number>
-  Define the maximum number of simultaneous secondary entries with the same primary
-  key in the cache. This needs the vary support to be enabled. Its default value is 10
-  and should be passed a strictly positive integer.
+total-max-size <megabytes>
+  Define the size in RAM of the cache in megabytes. This size is split in
+  blocks of 1kB which are used by the cache entries. Its maximum value is 4095.
 
 
 6.2.2. Proxy section