Re: Documentation for libnetfilter_conntrack

Re: Documentation for libnetfilter_conntrack

[Pablo Neira Ayuso]

Hi James,

I've cc'ed the reply to netfilter-devel.

James D. Nurmi wrote:
> This isnt a request (specifically), so im not trying to give you work! =)
> 
> I've prepared some nominal (but far from complete) documentation via
> doxygen for libnetfilter_conntrack.  Is there a preferred way for me
> to offer this back to you or the netfilter.org group?  Send to the
> list?  File a bug and offer a patch?

just send a patch that applies to SVN to the mailing list, with carbon
copy to me. Then we can discuss about it.

> There's also a few spots where my documentation is spotty (for
> example, the relatively important expectations stuff, they just werent
> needed for my code, I want to track connections, not extend them =) ),
> and a few places where units are unclear.

Feel free to send me your questions.

-- 
Pablo

Re: Documentation for libnetfilter_conntrack

[James D. Nurmi]

On 3/27/06, Pablo Neira Ayuso <pablo@eurodev.net> wrote:
> Hi James,
>
> I've cc'ed the reply to netfilter-devel.
>
> James D. Nurmi wrote:
> > This isnt a request (specifically), so im not trying to give you work! =)
> >
> > I've prepared some nominal (but far from complete) documentation via
> > doxygen for libnetfilter_conntrack.  Is there a preferred way for me
> > to offer this back to you or the netfilter.org group?  Send to the
> > list?  File a bug and offer a patch?
>
> just send a patch that applies to SVN to the mailing list, with carbon
> copy to me. Then we can discuss about it.

[ no urls permanant, but they'll be around at least for a few weeks, I suspect ]

Since I suspect you'll tell me it needs to change (not a bad thing! =) )
http://machiavelli.qwe.cc/conntrack_docs/curdoc.patch

Full doxygenned html:
http://machiavelli.qwe.cc/conntrack_docs/

Still todo: everything listed in todo, everything marked as unknown
(happy to update as people either let me know what they are, or I
figure them out =) ).

I'm not a professional tech-writer, but I feel its a good start to
offer back, and will happily take criticism!

>
> > There's also a few spots where my documentation is spotty (for
> > example, the relatively important expectations stuff, they just werent
> > needed for my code, I want to track connections, not extend them =) ),
> > and a few places where units are unclear.
>
> Feel free to send me your questions.

Will do, though I feel like I should get this out to you before I
sweat the small stuff (and will gladly fix anything before its
submitted! [or after =) ]

>
> --
> Pablo
>

- James