From a231f3599e9b0aa918745e2c7de5ffc0b7a7aa01 Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain.pocentek@objectif-libre.com>
Date: Sat, 25 Apr 2015 07:15:21 +0200
Subject: [PATCH] config-ref: warn about mute_weight_value deprecation

The mute_weight_multiplier option must be used instead.

Change-Id: I2bd7933fd19250a9ce88e3de8e3d552cf7d9dc40
Closes-Bug: #1442581
---
 doc/config-reference/compute/section_compute-cells.xml    | 5 +++++
 .../compute/section_compute-scheduler.xml                 | 8 +++++---
 2 files changed, 10 insertions(+), 3 deletions(-)

diff --git a/doc/config-reference/compute/section_compute-cells.xml b/doc/config-reference/compute/section_compute-cells.xml
index 890534f908..99787d6f65 100644
--- a/doc/config-reference/compute/section_compute-cells.xml
+++ b/doc/config-reference/compute/section_compute-cells.xml
@@ -235,6 +235,11 @@ rabbit_virtual_host=cell1_vhost</programlisting></para>
                                    <option>mute_weight_value</option>
                                 (assigned to mute children; should be
                                 a positive value).</para>
+                                <warning><para>The
+                                   <option>mute_weight_value</option>  is
+                                   deprecated, use
+                                   <option>mute_weight_multiplier</option>
+                                   instead.</para></warning>
                         </listitem>
                         <listitem>
                             <para><literal>ram_by_instance_type</literal>.
diff --git a/doc/config-reference/compute/section_compute-scheduler.xml b/doc/config-reference/compute/section_compute-scheduler.xml
index 1d62c60107..8ca96eec5d 100644
--- a/doc/config-reference/compute/section_compute-scheduler.xml
+++ b/doc/config-reference/compute/section_compute-scheduler.xml
@@ -966,10 +966,13 @@ weight_of_unavailable = -10000.0</programlisting>
                 </tr>
                 <tr valign="top">
                     <td>[cells]</td>
-                    <td><literal>mute_weight_value</literal></td>
+                    <td><literal>mute_weight_value</literal> (deprecated)</td>
                     <td>Weight value assigned to mute children. Use a
                         positive, floating-point value with a maximum
-                        of '1.0'.</td>
+                        of '1.0'.
+                        This option is deprecated, use
+                        <literal>mute_weight_multiplier</literal> instead.
+                    </td>
                 </tr>
                 <tr valign="top">
                     <td>[cells]</td>
@@ -1003,7 +1006,6 @@ weight_of_unavailable = -10000.0</programlisting>
         <programlisting language="ini">[cells]
 scheduler_weight_classes = nova.cells.weights.all_weighers
 mute_weight_multiplier = -10.0
-mute_weight_value = 1000.0
 ram_weight_multiplier = 1.0
 offset_weight_multiplier = 1.0</programlisting>
     </section>