[PATCH v1 12/19] docs: Add vhost-scsi to documentation

[Eric Farman <farman@xxxxxxxxxxxxxxxxxx>]

Add an example of the vhost-scsi hostdev tag, and its associated
definitions, to the domain XML helpfile.

Signed-off-by: Eric Farman <farman@xxxxxxxxxxxxxxxxxx>
Reviewed-by: Bjoern Walk <bwalk@xxxxxxxxxxxxxxxxxx>
Reviewed-by: Marc Hartmayer <mhartmay@xxxxxxxxxxxxxxxxxx>
Reviewed-by: Boris Fiuczynski <fiuczy@xxxxxxxxxxxxxxxxxx>
---
 docs/formatdomain.html.in | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
index 59a8bb9..2f2bbd0 100644
--- a/docs/formatdomain.html.in
+++ b/docs/formatdomain.html.in
@@ -3547,6 +3547,17 @@
   &lt;/devices&gt;
   ...</pre>
 
+    <p>or:</p>
+
+<pre>
+  ...
+  &lt;devices&gt;
+    &lt;hostdev mode='subsystem' type='scsi'&gt;
+      &lt;source protocol='vhost' wwpn='naa.50014057667280d8'/&gt;
+    &lt;/hostdev&gt;
+  &lt;/devices&gt;
+  ...</pre>
+
     <dl>
       <dt><code>hostdev</code></dt>
       <dd>The <code>hostdev</code> element is the main container for describing
@@ -3646,6 +3657,11 @@
             device using the same <code>name</code> attribute and optionally
             using the <code>auth</code> element to provide the authentication
             credentials to the iSCSI server.
+            <!-- FIXME as releases come and go -->
+            <span class="since">Since 2.1.0</span>, the <code>protocol</code>
+            attribute may be set to "vhost" and accept a <code>wwpn</code>
+            attribute that is the vhost_scsi wwpn (16 hexadecimal digits with
+            a prefix of "naa.") established in the host configfs.
             </p>
           </dd>
         </dl>
-- 
1.9.1

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list