summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmq.conf.example13
-rw-r--r--docs/rabbitmq.config.example16
-rw-r--r--docs/rabbitmqctl.86
3 files changed, 19 insertions, 16 deletions
diff --git a/docs/rabbitmq.conf.example b/docs/rabbitmq.conf.example
index d610f5bef5..988fb62467 100644
--- a/docs/rabbitmq.conf.example
+++ b/docs/rabbitmq.conf.example
@@ -307,11 +307,14 @@
##
# vm_memory_high_watermark.absolute = 2GB
##
-## Supported units suffixes:
-##
-## kb, KB: kibibytes (2^10 bytes)
-## mb, MB: mebibytes (2^20)
-## gb, GB: gibibytes (2^30)
+## Supported unit symbols:
+##
+## k, kiB: kibibytes (2^10 - 1,024 bytes)
+## M, MiB: mebibytes (2^20 - 1,048,576 bytes)
+## G, GiB: gibibytes (2^30 - 1,073,741,824 bytes)
+## kB: kilobytes (10^3 - 1,000 bytes)
+## MB: megabytes (10^6 - 1,000,000 bytes)
+## GB: gigabytes (10^9 - 1,000,000,000 bytes)
diff --git a/docs/rabbitmq.config.example b/docs/rabbitmq.config.example
index 9f56ba3f96..5970d39713 100644
--- a/docs/rabbitmq.config.example
+++ b/docs/rabbitmq.config.example
@@ -259,14 +259,14 @@
%%
%% {vm_memory_high_watermark, {absolute, "1024M"}},
%%
- %% Supported units suffixes:
- %%
- %% k, kiB: kibibytes (2^10 bytes)
- %% M, MiB: mebibytes (2^20)
- %% G, GiB: gibibytes (2^30)
- %% kB: kilobytes (10^3)
- %% MB: megabytes (10^6)
- %% GB: gigabytes (10^9)
+ %% Supported unit symbols:
+ %%
+ %% k, kiB: kibibytes (2^10 - 1,024 bytes)
+ %% M, MiB: mebibytes (2^20 - 1,048,576 bytes)
+ %% G, GiB: gibibytes (2^30 - 1,073,741,824 bytes)
+ %% kB: kilobytes (10^3 - 1,000 bytes)
+ %% MB: megabytes (10^6 - 1,000,000 bytes)
+ %% GB: gigabytes (10^9 - 1,000,000,000 bytes)
%% Fraction of the high watermark limit at which queues start to
%% page message out to disc in order to free up memory.
diff --git a/docs/rabbitmqctl.8 b/docs/rabbitmqctl.8
index 1ec06e8b30..25a5afc303 100644
--- a/docs/rabbitmqctl.8
+++ b/docs/rabbitmqctl.8
@@ -1836,8 +1836,8 @@ a floating point number greater than or equal to 0.
.It Ar memory_limit
The new memory limit at which flow control is triggered, expressed in
bytes as an integer number greater than or equal to 0 or as a string
-with memory units (e.g. 512M or 1G).
-Available units are:
+with memory unit symbol(e.g. 512M or 1G).
+Available unit symbols are:
.Bl -tag -width Ds
.It Cm k , Cm kiB
kibibytes (2^10 bytes)
@@ -1857,7 +1857,7 @@ gigabytes (10^9 bytes)
.It Cm set_disk_free_limit Ar disk_limit
.Bl -tag -width Ds
.It Ar disk_limit
-Lower bound limit as an integer in bytes or a string with memory units
+Lower bound limit as an integer in bytes or a string with memory unit symbols
(see vm_memory_high_watermark), e.g. 512M or 1G.
Once free disk space reaches the limit, a disk alarm will be set.
.El