A couple of doc updates
authorIustin Pop <iustin@google.com>
Tue, 24 Nov 2009 09:57:35 +0000 (10:57 +0100)
committerIustin Pop <iustin@google.com>
Wed, 25 Nov 2009 10:33:26 +0000 (11:33 +0100)
Clarify the fact that temporary HV/BE params in instance start override
and do not extend the configured parameters; and change the instance
list headers from HVM_* to * since many of the parameters apply to KVM
too. Also fix a typo in the rapi documention for '/2/nodes'.

Signed-off-by: Iustin Pop <iustin@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>

doc/rapi.rst
man/gnt-instance.sgml
scripts/gnt-instance

index 0fcfab2..61454d0 100644 (file)
@@ -599,11 +599,11 @@ Example::
     [
       {
         "id": "node1.example.com",
-        "uri": "\/instances\/node1.example.com"
+        "uri": "\/nodes\/node1.example.com"
       },
       {
         "id": "node2.example.com",
-        "uri": "\/instances\/node2.example.com"
+        "uri": "\/nodes\/node2.example.com"
       }
     ]
 
index 14f6c51..81d75b2 100644 (file)
@@ -1511,10 +1511,10 @@ instance5: 11225
 
         <para>
           The <option>-H</option> and <option>-B</option> options
-          specify extra, temporary hypervisor and backend parameters
-          that can be used to start an instance with modified
-          parameters. They can be useful for quick testing without
-          having to modify an instance back and forth, e.g.:
+          specify temporary hypervisor and backend parameters that can
+          be used to start an instance with modified parameters. They
+          can be useful for quick testing without having to modify an
+          instance back and forth, e.g.:
           <screen>
 # gnt-instance start -H root_args="single" instance1
 # gnt-instance start -B memory=2048 instance2
@@ -1523,7 +1523,11 @@ instance5: 11225
           <userinput>instance1</userinput> in single-user mode, and
           the instance <userinput>instance2</userinput> with 2GB of
           RAM (this time only, unless that is the actual instance
-          memory size already).
+          memory size already). Note that the values override the
+          instance parameters (and not extend them): an instance with
+          "root_args=ro" when started with <userinput>-H
+          root_args=single</userinput> will result in "single", not
+          "ro single".
         </para>
 
         <para>
index 711727b..ead004f 100755 (executable)
@@ -241,12 +241,12 @@ def ListInstances(opts, args):
       "network_port": "Network_port",
       "hv/kernel_path": "Kernel_path",
       "hv/initrd_path": "Initrd_path",
-      "hv/boot_order": "HVM_boot_order",
-      "hv/acpi": "HVM_ACPI",
-      "hv/pae": "HVM_PAE",
-      "hv/cdrom_image_path": "HVM_CDROM_image_path",
-      "hv/nic_type": "HVM_NIC_type",
-      "hv/disk_type": "HVM_Disk_type",
+      "hv/boot_order": "Boot_order",
+      "hv/acpi": "ACPI",
+      "hv/pae": "PAE",
+      "hv/cdrom_image_path": "CDROM_image_path",
+      "hv/nic_type": "NIC_type",
+      "hv/disk_type": "Disk_type",
       "hv/vnc_bind_address": "VNC_bind_address",
       "serial_no": "SerialNo", "hypervisor": "Hypervisor",
       "hvparams": "Hypervisor_parameters",