[Qemu-devel] [PATCH 2/2] qemu-options.hx: Update virtfs command documentation

[Aneesh Kumar K.V]

Clarify the virtfs option better

Signed-off-by: Aneesh Kumar K.V <address@hidden>
---
 qemu-options.hx |  116 ++++++++++++++++++++++++++++++++++---------------------
 1 files changed, 72 insertions(+), 44 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 4789fe4..c6fb12c 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -483,6 +483,8 @@ possible drivers and properties, use @code{-device ?} and
 @code{-device @var{driver},?}.
 ETEXI
 
+DEFHEADING()
+
 DEFHEADING(File system options:)
 
 DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
@@ -492,34 +494,54 @@ DEF("fsdev", HAS_ARG, QEMU_OPTION_fsdev,
 
 STEXI
 
-The general form of a File system device option is:
address@hidden @option
-
 @item -fsdev @var{fstype} ,address@hidden [,@var{options}]
 @findex -fsdev
-Fstype is one of:
address@hidden,
-The specific Fstype will determine the applicable options.
-
-Options to each backend are described below.
-
address@hidden -fsdev local ,address@hidden ,address@hidden 
,address@hidden,address@hidden
-
-Create a file-system-"device" for local-filesystem.
 
address@hidden is only available on Linux.
-
address@hidden specifies the path to be exported. @option{path} is required.
+Define a new file system device. Valid options are
address@hidden @option
address@hidden local
+This option create a file-system-"device" for local-filesystem.
+Currently only local file system device is supported.
address@hidden address@hidden
+Identifier for this device
address@hidden address@hidden
+This option define the export path for the file system device.
+Files below this path will be available for 9p client on the
+guest.
address@hidden address@hidden
+This option define the security model to be used when exporting
+the files. The supported security models are passthrough, mapped
+and none. In passthrough security model, file are stored using
+the same credentials as they are created on the guest. This require
+qemu to run as root. In the mapped security model, some of the
+file attributes like uid, gid, mode bits and link target are
+stored as file attributes. Directories exported by this security
+model cannot interact with other unix tools. "none" security model
+is same as passthrough expect they won't report failures if
+the sever fails to set file attributes like ownership.
address@hidden address@hidden
+This is an optional argument. The support value is writethrough
+This means thatthe host page cache will be used to read and write
+data but write notification will be sent to the guest only when
+the data has been reported as written by the storage subsystem.
 
address@hidden specifies the security model to be followed.
address@hidden is required.
address@hidden table
 
address@hidden specifies whether to skip the host page cache.
address@hidden is an optional argument.
+-fsdev option is used along with -device driver "virtio-9p-pci"
+Option for virtio-9p-pci driver are
 
address@hidden @option
address@hidden address@hidden
+This option specify the @var{id} value specified along with -fsdev option
address@hidden address@hidden
+This option specifies the tag name to be used by the guest
+to mount this export point
 @end table
+
 ETEXI
 
+DEFHEADING()
+
 DEFHEADING(Virtual File system pass-through options:)
 
 DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
@@ -529,33 +551,39 @@ DEF("virtfs", HAS_ARG, QEMU_OPTION_virtfs,
 
 STEXI
 
-The general form of a Virtual File system pass-through option is:
address@hidden @option
-
address@hidden -virtfs @var{fstype} [,@var{options}]
address@hidden -virtfs
-Fstype is one of:
address@hidden,
-The specific Fstype will determine the applicable options.
-
-Options to each backend are described below.
-
 @item -virtfs local ,address@hidden ,address@hidden 
,address@hidden,address@hidden
address@hidden -virtfs
 
-Create a Virtual file-system-pass through for local-filesystem.
-
address@hidden is only available on Linux.
-
address@hidden specifies the path to be exported. @option{path} is required.
-
address@hidden specifies the security model to be followed.
address@hidden is required.
-
address@hidden specifies the tag with which the exported file is mounted.
address@hidden is required.
-
address@hidden specifies whether to skip the host page cache.
address@hidden is an optional argument.
+The general form of a Virtual File system pass-through option is:
address@hidden @option
address@hidden local
+This option create a file-system-"device" for local-filesystem.
+Currently only local file system device is supported.
address@hidden address@hidden
+Identifier for this device
address@hidden address@hidden
+This option define the export path for the file system device.
+Files below this path will be available for 9p client on the
+guest.
address@hidden address@hidden
+This option specifies the tag name to be used by the guest
+to mount this export point
address@hidden address@hidden
+This option define the security model to be used when exporting
+the files. The supported security models are passthrough, mapped
+and none. In passthrough security model, file are stored using
+the same credentials as they are created on the guest. This require
+qemu to run as root. In the mapped security model, some of the
+file attributes like uid, gid, mode bits and link target are
+stored as file attributes. Directories exported by this security
+model cannot interact with other unix tools. "none" security model
+is same as passthrough expect they won't report failures if
+the sever fails to set file attributes like ownership.
address@hidden address@hidden
+This is an optional argument. The support value is writethrough
+This means thatthe host page cache will be used to read and write
+data but write notification will be sent to the guest only when
+the data has been reported as written by the storage subsystem.
 
 @end table
 ETEXI
-- 
1.7.4.1