]> git.ipfire.org Git - thirdparty/ccache.git/commitdiff
docs: Reconcile max-size suffixes in documentation (#1640)
authorAndrej <azhilenkov@gmail.com>
Mon, 6 Oct 2025 19:12:20 +0000 (21:12 +0200)
committerGitHub <noreply@github.com>
Mon, 6 Oct 2025 19:12:20 +0000 (21:12 +0200)
* Use explicit 'GB' suffix in example.
* Fix misleading `max_size` description. Default suffix is GiB, not GB. And default value is 5GiB also.
* `max_size` description - use explicit suffixes.

doc/manual.adoc

index e84142be24c0eb072387b7f3f31a0b581c6c18b8..16240a89320c958bfe33c5894fcb66137f969c0f 100644 (file)
@@ -410,7 +410,7 @@ is whitespace surrounding keys and values. Example:
 
 -------------------------------------------------------------------------------
 # Set maximum cache size to 10 GB:
-max_size = 10G
+max_size = 10GB
 -------------------------------------------------------------------------------
 
 === Boolean values
@@ -878,8 +878,8 @@ file in `/etc/rsyslog.d`:
 *max_size* (*CCACHE_MAXSIZE*)::
 
     This option specifies the maximum size of the cache. Use 0 for no limit. The
-    default value is 5G. Available suffixes: k, M, G, T (decimal) and Ki, Mi,
-    Gi, Ti (binary). The default suffix is G. See also
+    default value is 5GiB. Available suffixes: kB, MB, GB, TB (decimal) and KiB, MiB,
+    GiB, TiB (binary). The default suffix is GiB. See also
     _<<Cache size management>>_.
 
 [#config_msvc_dep_prefix]