summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEmile Joubert <emile@rabbitmq.com>2011-08-26 17:45:16 +0100
committerEmile Joubert <emile@rabbitmq.com>2011-08-26 17:45:16 +0100
commit3607125be153616b1b98a0fe1a55018d9681877d (patch)
tree2f9a33e1630e4b31f15eb504f65ed6f606ff3df2 /docs
parentfbe1be958a0d034c139af0d8839d3f2149ac25cc (diff)
downloadrabbitmq-server-git-3607125be153616b1b98a0fe1a55018d9681877d.tar.gz
Move docs for rabbitmqctl set_vm_memory_high_watermark
and only modify state when necessary
Diffstat (limited to 'docs')
-rw-r--r--docs/rabbitmqctl.1.xml22
1 files changed, 2 insertions, 20 deletions
diff --git a/docs/rabbitmqctl.1.xml b/docs/rabbitmqctl.1.xml
index b45e9df54e..e5ec3eed7f 100644
--- a/docs/rabbitmqctl.1.xml
+++ b/docs/rabbitmqctl.1.xml
@@ -1377,28 +1377,10 @@
<variablelist>
<varlistentry>
<term>fraction</term>
- <listitem><para>The new memory threshhold fraction as a floating point number between
- 0.0 and 1.0 with a mandatory fractional part.</para></listitem>
+ <listitem><para>The new memory threshhold fraction at which flow control is triggered, as a
+ floating point number between 0.0 and 1.0 with a mandatory fractional part.</para></listitem>
</varlistentry>
</variablelist>
- <para>
- Sets the memory threshhold fraction at which memory-based flow control is
- triggered, until the broker restarts. The corresponding configuration
- setting should also be changed when the effects of this command should
- survive a broker restart. Use the <command>status</command> command to
- confirm the currently active memory threshhold. The command takes effect
- within the memory monitor polling interval.
- </para>
- <para>
- This command will update the memory threshhold as a fraction of the total RAM
- by querying the total RAM when the command is executed. Therefore the absolute
- threshhold may change on systems with hot-swappable RAM when this command is executed
- without altering the fraction.
- </para>
- <screen role="example">rabbitmqctl set_vm_memory_high_watermark 0.4</screen>
- <para role="example">
- This command sets the memory threshhold fraction to 40%.
- </para>
</listitem>
</varlistentry>
</variablelist>