[libvirt] [patch 5/5] nwfilter: Extend docs with information about the comment attribute

[Daniel Veillard]

On Wed, Oct 06, 2010 at 01:25:35PM -0400, Stefan Berger wrote:
> Daniel Veillard <veillard at redhat.com> wrote on 10/06/2010 12:02:39 PM:
> 
> > 
> > Please respond to veillard
> > 
> > On Fri, Oct 01, 2010 at 08:28:54PM -0400, Stefan Berger wrote:
> > > I am adding a row with information about the newly supported state
> > > attribute to each of the tables describing supported attributes 
> ofprotocols.
> > > 
> > > Signed-off-by: Stefan Berger <stefanb at us.ibm.com>
> > > 
> > > ---
> > >  docs/formatnwfilter.html.in |   30 ++++++++++++++++++++++++++++++
> > >  1 file changed, 30 insertions(+)
> > > 
> > > Index: libvirt-acl/docs/formatnwfilter.html.in
> > > ===================================================================
> > > --- libvirt-acl.orig/docs/formatnwfilter.html.in
> > > +++ libvirt-acl/docs/formatnwfilter.html.in
> > > @@ -748,6 +748,11 @@
> > >           <td>STRING</td>
> > >           <td>text with max. 256 characters</td>
> > >         </tr>
> > > +       <tr>
> > > +         <td>state <span class="since">(Since 0.8.5)</span></td>
> > > +         <td>STRING</td>
> > > +         <td>comma separated list of 
> > NEW,ESTABLISHED,RELATED,INVALID or NONE</td>
> > > +       </tr>
> > >        </table>
> > 
> >   Hum, I think the doc really ought to describe the semantic of the
> > values, not just the allowed values, so IMHO that need to be refined
> > explaining for example what "ESTABLISHED,RELATED" actually means would
> > be useful :-)
> 
> I have another patch that I could merge with this one here (or post 
> separately)
> that shows two solutions for an example filter having the requirement to 
> support an ftp connection's related data connection in ftp active mode.
> The two solutions make a lot of use of the state attribute and explain
> a little what it means - not a whole tutorial but the general idea of it.

  That would be really nicer, yes !
Commit and post separately, but I doubt anybody would object to more
documentation... at best trying to cleanup.

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/