[libvirt] [RFC PATCH v2 REBASE 17/18] docs: Document the new hostdev and address type 'mdev'

[Erik Skultety]

On Wed, Feb 22, 2017 at 08:20:06PM +0530, Kirti Wankhede wrote:
> 
> 
> On 2/20/2017 7:58 PM, Erik Skultety wrote:
> > Signed-off-by: Erik Skultety <eskultet at redhat.com>
> > ---
> >  docs/formatdomain.html.in | 48 +++++++++++++++++++++++++++++++++++++++++++----
> >  1 file changed, 44 insertions(+), 4 deletions(-)
> > 
> > diff --git a/docs/formatdomain.html.in b/docs/formatdomain.html.in
> > index b69bd4c..13cb767 100644
> > --- a/docs/formatdomain.html.in
> > +++ b/docs/formatdomain.html.in
> > @@ -3277,8 +3277,20 @@
> >          attributes: <code>iobase</code> and <code>irq</code>.
> >          <span class="since">Since 1.2.1</span>
> >        </dd>
> > +      <dt><code>mdev</code></dt>
> > +      <dd>Mediated devices' addresses have so far only one mandatory attribute
> > +        <code>uuid</code> (<span class="since">since 3.1.0</span>) which
> > +        uniquely identifies a mediated device under the syfs file system.
> > +      </dd>
> >      </dl>
> >  
> > +    <p>
> > +        Note: Due to nature of mediated devices, being only software devices
> > +        defining an allocation of resources on the physical parent device, the
> > +        address type <code>mdev</code> is supposed to be used to identify a
> > +        device on the host only, rather than identifying it in the guest.
> > +    </p>
> > +
> >      <h4><a name="elementsControllers">Controllers</a></h4>
> >  
> >      <p>
> > @@ -3774,6 +3786,19 @@
> >    </devices>
> >    ...</pre>
> >  
> > +    <p>or:</p>
> > +
> > +<pre>
> > +  ...
> > +  <devices>
> > +    <hostdev mode='subsystem' type='mdev' model='vfio-pci'>
> > +    <source>
> > +      <address type='mdev' uuid='c2177883-f1bb-47f0-914d-32a22e3a8804'>
> > +    </source>
> > +    </hostdev>
> > +  </devices>
> > +  ...</pre>
> > +
> 
> Hi Erik,
> 
> Changes looks good so far. I did some basic testing with these patches.
> I used above example snippet of hostdev element and it throws below
> error. Add a '/' before '&gt' and after uuid in address line.
> 
> error: (domain_definition):74: Opening and ending tag mismatch: address
> line 73 and source
>       </source>
> ---------------^
> Failed. Try again? [y,n,i,f,?]:
> 
> Thanks,
> Kirti
> 

Oh, right, good catch.

Thanks,
Erik