[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 2/2] qemu-options.hx: Update virtfs command document
From: |
Aneesh Kumar K.V |
Subject: |
[Qemu-devel] [PATCH 2/2] qemu-options.hx: Update virtfs command documentation |
Date: |
Fri, 7 Oct 2011 12:16:07 +0530 |
Clarify the virtfs option better
Updates from:Sripathi Kodi <address@hidden>
Signed-off-by: Aneesh Kumar K.V <address@hidden>
---
qemu-options.hx | 119 ++++++++++++++++++++++++++++++++-----------------------
1 files changed, 69 insertions(+), 50 deletions(-)
diff --git a/qemu-options.hx b/qemu-options.hx
index 38f0aef..6c744e0 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -522,43 +522,61 @@ 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,
- "-fsdev local,id=id,path=path,security_model=[mapped|passthrough|none]\n"
+ "-fsdev
fsdriver,id=id,path=path,security_model=[mapped|passthrough|none]\n"
" [,cache=writethrough]\n",
QEMU_ARCH_ALL)
STEXI
-The general form of a File system device option is:
address@hidden @option
-
address@hidden -fsdev @var{fstype} ,address@hidden [,@var{options}]
address@hidden -fsdev
@var{fsdriver},address@hidden,address@hidden,address@hidden,address@hidden
@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.
-
address@hidden specifies the security model to be followed.
address@hidden is required.
-
address@hidden specifies whether to skip the host page cache.
address@hidden is an optional argument.
+Define a new file system device. Valid options are:
address@hidden @option
address@hidden @var{fsdriver}
+This option specifies the fs driver backend to use.
+Currently "local" and "handle" file system drivers are supported.
address@hidden address@hidden
+Specifies identifier for this device
address@hidden address@hidden
+Specifies the export path for the file system device. Files under
+this path will be available to the 9p client on the guest.
address@hidden address@hidden
+Specifies the security model to be used for this export path.
+Supported security models are "passthrough", "mapped" and "none".
+In "passthrough" security model, files are stored using the same
+credentials as they are created on the guest. This requires qemu
+to run as root. In "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 except the sever won't report failures if it fails to
+set file attributes like ownership.
address@hidden address@hidden
+This is an optional argument. The only supported value is "writethrough".
+This means that 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 table
+-fsdev option is used along with -device driver "virtio-9p-pci".
address@hidden -device virtio-9p-pci,address@hidden,address@hidden
+Options for virtio-9p-pci driver are:
address@hidden @option
address@hidden address@hidden
+Specifies the id value specified along with -fsdev option
address@hidden address@hidden
+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,
@@ -568,34 +586,35 @@ 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
@var{fsdriver},address@hidden,address@hidden,address@hidden,address@hidden
@findex -virtfs
-Fstype is one of:
address@hidden,
-The specific Fstype will determine the applicable options.
-
-Options to each backend are described below.
-
address@hidden -virtfs local ,address@hidden ,address@hidden
,address@hidden,address@hidden
-
-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 options are:
address@hidden @option
address@hidden @var{fsdriver}
+This option specifies the fs driver backend to use.
+Currently "local" and "handle" file system drivers are supported.
address@hidden address@hidden
+Specifies identifier for this device
address@hidden address@hidden
+Specifies the export path for the file system device. Files under
+this path will be available to the 9p client on the guest.
address@hidden address@hidden
+Specifies the security model to be used for this export path.
+Supported security models are "passthrough", "mapped" and "none".
+In "passthrough" security model, files are stored using the same
+credentials as they are created on the guest. This requires qemu
+to run as root. In "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 except the sever won't report failures if it fails to
+set file attributes like ownership.
address@hidden address@hidden
+This is an optional argument. The only supported value is "writethrough".
+This means that 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
- [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Aneesh Kumar K.V, 2011/10/07
- [Qemu-devel] [PATCH 2/2] qemu-options.hx: Update virtfs command documentation,
Aneesh Kumar K.V <=
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Stefan Hajnoczi, 2011/10/08
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Aneesh Kumar K.V, 2011/10/09
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Stefan Hajnoczi, 2011/10/09
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Aneesh Kumar K.V, 2011/10/09
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Stefan Hajnoczi, 2011/10/10
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Aneesh Kumar K.V, 2011/10/10
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Stefan Hajnoczi, 2011/10/12
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Aneesh Kumar K.V, 2011/10/12
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Stefan Hajnoczi, 2011/10/12
- Re: [Qemu-devel] [PATCH 1/2] hw/9pfs: Add new virtfs option cache=writethrough to skip host page cache, Aneesh Kumar K.V, 2011/10/12