Hello and welcome!
Thanks for sending a patch to the part of documentation that has not
been touched for over 3 years.
Can you set your name in git to your full name? We prefer using those
instead of nicknames.
Since this patch is against the libvirt-cmdref.git repo, not the
libvirt.git repo, using --subject-prefix 'libvirt-cmdref PATCH' makes it
easier for reviewers - it took me a while to figure it out.
Jan
On Sun, Mar 15, 2015 at 10:45:46PM +0530, swat wrote:
Updated the documentation for command cd
The documentation for command cd did not have information about the command. Added the
required information.
---
source/cd.xml | 36 +++++++++++++++++++++++++++++++++---
1 file changed, 33 insertions(+), 3 deletions(-)
diff --git a/source/cd.xml b/source/cd.xml
index 78a13df..d4afbc9 100644
--- a/source/cd.xml
+++ b/source/cd.xml
@@ -9,16 +9,46 @@
</text>
</description>
- <options />
+ <options>
+ <parameter requirement="optional">
+ <keyword requirement="optional">--dir</keyword>
+ <value type="string"
requirement="optional">path</value>
+ <description>
+ <text>
+ directory to switch to (default: home or else root)
+ </text>
+ <text>
+ --dir itself is optional
+ </text>
+ </description>
+ </parameter>
+ </options>
<availability from="0.7.0" />
<notes />
- <examples type="usage" />
+ <examples type="usage" >
+ <example>
+ <terminal>
+virsh # <bold> cd </bold> <value>/tmp</value> </terminal>
+ <text>
+ Changes the current working directory to <value> /tmp </tmp>
+ </text>
+ </example>
+ </examples>
<examples type="fullcontext" />
<reference type="seealso" />
-
+ <item>
+ <link type="internal" href="pwd"/>
+ <name>
+ pwd
+ </name>
+ <description>
+ Displays the current directory
+ </description>
+ </item>
+ </reference>
</command>
--
1.9.1
--
libvir-list mailing list
libvir-list(a)redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list