From c56f51ef2bba93c85810cc80be6fe26e016fd370 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ren=C3=A9=20Nussbaumer?= <rn@google.com>
Date: Tue, 9 Mar 2010 10:40:47 +0100
Subject: [PATCH] =?UTF-8?q?Adding=20documentation=20for=20=E2=80=9Cgnt-os?=
 =?UTF-8?q?=20modify=E2=80=9D?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This finishes the integration of per-os-hypervisor parameters by updating
the man page.

Signed-off-by: RenΓ© Nussbaumer <rn@google.com>
Signed-off-by: Michael Hanselmann <hansmi@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
---
 man/gnt-os.sgml | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

diff --git a/man/gnt-os.sgml b/man/gnt-os.sgml
index 3432a3d57..292239bf1 100644
--- a/man/gnt-os.sgml
+++ b/man/gnt-os.sgml
@@ -22,6 +22,7 @@
       <year>2007</year>
       <year>2008</year>
       <year>2009</year>
+      <year>2010</year>
       <holder>Google Inc.</holder>
     </copyright>
     &dhdate;
@@ -81,6 +82,28 @@
       of all the OSes and the reasons they are or are not valid.
     </para>
 
+    <cmdsynopsis>
+      <command>modify</command>
+      <arg>-H <replaceable>HYPERVISOR</replaceable><arg>:<arg choice="plain" rep="repeat">option=<replaceable>value</replaceable></arg></arg></arg>
+      <arg choice="req"><replaceable>OS</replaceable></arg>
+    </cmdsynopsis>
+
+    <para>
+      This command will allow you to modify OS parameters. At the moment
+      we just support per-os-hypervisor settings. You can run modify
+      <option>-H</option> with the same syntax as in
+      <command>gnt-cluster init</command> to override default hypervisor
+      parameters of the cluster for specified
+      <replaceable>OS</replaceable> argument.
+    </para>
+
+    <para>
+      Note: The <replaceable>OS</replaceable> doesn't have to exists.
+      This allows preseeding the settings for
+      <replaceable>OS</replaceable>es not yet known to
+      <command>gnt-os</command>.
+    </para>
+
   </refsect1>
 
   &footer;
-- 
GitLab