From 806a25167a2fe18e3044c96503a201ce6427cfe7 Mon Sep 17 00:00:00 2001 From: Johan Wikman Date: Mon, 23 Jan 2017 10:19:20 +0200 Subject: [PATCH] Add documentation on IEC and SI prefixes --- .../Getting-Started/Configuration-Guide.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index 6cf52a806..6970f9968 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -81,6 +81,32 @@ The values of the parameter that are not on the first line need to have at least one whitespace character before them in order for them to be recognized as a part of the multi-line parameter. +### Sizes + +Where _specifically noted_, a number denoting a size can be suffixed by a subset of +the IEC binary prefixes or the SI prefixes. In the former case the number will be +interpreted as a certain multiple of 1024 and in the latter case as a certain multiple +of 1000. The supported IEC binary suffixes are `Ki`, `Mi`, `Gi` and `Ti` and the +supported SI suffixes are `k`, `M`, `G` and `T`. In both cases, the matching is +case insensitive. + +For instance, the following entries +``` +max_size=1099511628000 +max_size=1073741824Ki +max_size=1048576Mi +max_size=1024Gi +max_size=1Ti +``` +are equivalent, as are the following +``` +max_size=1000000000000 +max_size=1000000000k +max_size=1000000M +max_size=1000G +max_size=1T +``` + ### Global Settings The global settings, in a section named `[MaxScale]`, allow various parameters