[libvirt] [PATCH] docs: describe new virtual switch configuration in network XML docs

[Daniel Veillard]

On Wed, Aug 10, 2011 at 12:20:15PM -0400, Laine Stump wrote:
> On 08/10/2011 11:05 AM, Eric Blake wrote:
> >On 08/09/2011 11:45 PM, Laine Stump wrote:
> >>This should have been done with the rest of the patch for virtual
> >>switch / network device abstraction.
> >
> >And I should have called you on this before the 0.9.4 release - oh
> >well :)
> 
> 
> A long time ago I used to like writing documentation. I think the
> language center of my brain has atrophied in the last 20 years,
> though...
> 
> 
> >
> >>+      A portgroup provides a method of easily putting guest
> >>+      connections to the network into different classes, with each
> >>+      class potentially having a different level/type of service. Each
> >>+      network can have multiple portgroup elements (and one of those
> >>+      can optionally be designated as the 'default' portgroup for the
> >>+      network), and each portgroup has a name, as well as various
> >>+      subelements associated with it. The currently supported
> >>+      subelements are<code><bandwidth></code>
> >>+      and<code><virtualport></code>, which are both fully
> >>+      described in the domain XML documentation.
> >
> >Is there any way to make cross-page relative links, so that you
> >can make this a link to the right section in the domain XML page?
> 
> 
> I did this up earlier in my patch, and it seems to work:
> 
> (see<a href="formatdomain.html#elementsNICSDirect">Direct attachment to physical interface</a>  for descriptions of the various macvtap modes)

  yes, that should work safely,

> But I didn't think to put a link here too. I did that, tested it,
> fixed a couple of formatting problems I didn't notice last night
> (missing ";" and pushed the result.
> 
> 
> >But not a show-stopper to this patch if you aren't sure how.
> >
> >ACK.
> >

Daniel

-- 
Daniel Veillard      | libxml Gnome XML XSLT toolkit  http://xmlsoft.org/
daniel at veillard.com  | Rpmfind RPM search engine http://rpmfind.net/
http://veillard.com/ | virtualization library  http://libvirt.org/