summaryrefslogtreecommitdiffstats
path: root/generator
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2012-10-05 11:03:03 +0100
committerRichard W.M. Jones <rjones@redhat.com>2012-10-06 23:15:48 +0100
commit1467ea00b850bec2722671a400adb2ffda533365 (patch)
tree5977e8ee60991d65bcd2a1bed6ad8bbcd41c81ed /generator
parent013fb91a6974dfcb493fb9ccffb23329788f4976 (diff)
downloadlibguestfs-1467ea00b850bec2722671a400adb2ffda533365.tar.gz
libguestfs-1467ea00b850bec2722671a400adb2ffda533365.tar.xz
libguestfs-1467ea00b850bec2722671a400adb2ffda533365.zip
docs: add_drive: Clean up documentation of the 'filename' parameter.
Also, remove duplicate documentation of using '/dev/null' as the filename.
Diffstat (limited to 'generator')
-rw-r--r--generator/actions.ml15
1 files changed, 6 insertions, 9 deletions
diff --git a/generator/actions.ml b/generator/actions.ml
index 4e138557..713c7162 100644
--- a/generator/actions.ml
+++ b/generator/actions.ml
@@ -1189,10 +1189,11 @@ not all belong to a single logical operating system
fish_alias = ["add"]; config_only = true;
shortdesc = "add an image to examine or modify";
longdesc = "\
-This function adds a virtual machine disk image C<filename> to
-libguestfs. The first time you call this function, the disk
-appears as C</dev/sda>, the second time as C</dev/sdb>, and
-so on.
+This function adds a disk image called C<filename> to the handle.
+C<filename> may be a regular host file or a host device.
+
+The first time you call this function, the disk appears as
+C</dev/sda>, the second time as C</dev/sdb>, and so on.
You don't necessarily need to be root when using libguestfs. However
you obviously do need sufficient permissions to access the filename
@@ -1237,11 +1238,7 @@ The name the drive had in the original guest, e.g. C</dev/sdb>.
This is used as a hint to the guest inspection process if
it is available.
-=back
-
-C<filename> can have the special value C</dev/null>, which means
-to add a null (zero length) raw format device. You can add C</dev/null>
-multiple times." };
+=back" };
{ defaults with
name = "inspect_get_windows_systemroot";