Commit 00f98619 authored by Iustin Pop's avatar Iustin Pop
Browse files

Update manpages with the kernel/initrd options

This patch modifes the ‘gnt-instance’ instance manpage with the new
‘--kernel’ and ‘--initrd’ options.

Reviewed-by: imsnah
parent 03abdbe8
......@@ -32,4 +32,7 @@ MAINTAINERCLEANFILES = $(maninput)
rm -rf "$$tmpdir"
%.7 %.8: %.in Makefile
sed -e 's#@LOCALSTATEDIR@#$(localstatedir)#g' < $< > $@
sed -e 's#@LOCALSTATEDIR@#$(localstatedir)#g' \
-e 's#@CUSTOM_XEN_KERNEL@#$(XEN_KERNEL)#g' \
-e 's#@CUSTOM_XEN_INITRD@#$(XEN_INITRD)#g' \
< $< > $@
......@@ -70,6 +70,17 @@
<arg>-b <replaceable>bridge</replaceable></arg>
<arg>--mac <replaceable>MAC-address</replaceable></arg>
<sbr>
<arg>--kernel <group choice="req">
<arg>default</arg>
<arg><replaceable>kernel_path</replaceable></arg>
</group></arg>
<sbr>
<arg>--initrd <group choice="req">
<arg>default</arg>
<arg>none</arg>
<arg><replaceable>initrd_path</replaceable></arg>
</group> </arg>
<sbr>
<arg choice="req">-t<group>
<arg>diskless</arg>
<arg>plain</arg>
......@@ -82,6 +93,7 @@
<arg choice="req">-n <replaceable>node<optional>:secondary-node</optional></replaceable></arg>
<arg choice="req"><replaceable>instance</replaceable></arg>
</cmdsynopsis>
<para>
Creates a new instance on the specified
host. <replaceable>instance</replaceable> must be in DNS and
......@@ -134,6 +146,27 @@
this cluster.
</para>
<para>
The <option>--kernel</option> options allows the instance to
use a custom kernel (if a filename is passed) or to use the
default kernel (<filename>@CUSTOM_XEN_KERNEL@</filename>), if the
string <constant>default</constant> is passed.
</para>
<para>
The <option>--initrd</option> option is similar: it allows
the instance to use a custom initrd (if a filename is
passed) or to use the default initrd
(<filename>@CUSTOM_XEN_INITRD@</filename>), if the string
<constant>default</constant> is passed, or to disable the
use of an initrd, if the string <constant>none</constant> is
passed. Note that in the case the instance is set to use the
default initrd and it doesn't exist, it will be silently
ignored; if the instance is set to use a custom initrd and
it doesn't exist, this will be treated as an error and will
prevent the startup of the instance.
</para>
<para>
The <option>-t</option> options specifies the disk layout type for
the instance. The available choices are:
......@@ -406,6 +439,18 @@
<arg choice="opt">-i <replaceable>ip</replaceable></arg>
<arg choice="opt">-b <replaceable>bridge</replaceable></arg>
<arg choice="opt">--mac <replaceable>MAC-address</replaceable></arg>
<sbr>
<arg>--kernel <group choice="req">
<arg>default</arg>
<arg><replaceable>kernel_path</replaceable></arg>
</group></arg>
<sbr>
<arg>--initrd <group choice="req">
<arg>default</arg>
<arg>none</arg>
<arg><replaceable>initrd_path</replaceable></arg>
</group> </arg>
<sbr>
<arg choice="req"><replaceable>instance</replaceable></arg>
</cmdsynopsis>
......@@ -420,6 +465,11 @@
complains.
</para>
<para>
The <option>--kernel</option> and <option>--initrd</option>
options are described in the <command>add</command> command.
</para>
<para>
All the changes take effect at the next restart. If the
instance is running, there is no effect on the instance.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment