Re: JBD Documentation added in BK-current

From: Roger Gammans (
Date: Tue Oct 15 2002 - 16:38:45 EST

On Tue, Oct 15, 2002 at 08:16:48PM +0200, Sam Ravnborg wrote:
> On Mon, Oct 14, 2002 at 11:03:15PM +0100, Roger Gammans wrote:
> >
> > Well. I'm not surprised there are a few I couldn't find an SGML reference
> > for the linuxdoc dtd , or a tutorial when I wrote it, so I guessed by looking
> > at other documents and source code.
> >
> > > [I'm cleaning up the mess in the Makefile after JBD was added right now].
> >
> > Did I really make it that messy?
> The infrastructure in the docbook makefile has changed since 2.4.
> Took a look in the journal-api.sgml file, based on the comments you gave.
> I had to do a little more to crete .html without warnings.
> I've submitted this to Linus and trivial.. as well.
> Browsing the resulting file I wonder why there are references to several
> jbd files, but they do not include docgen comments.
> Are there some patches missing in 2.5 that updates the comments?

And in 2.4 AFAICT. There is a lot of documentation in the those
c and h files if you look.

The original patch didn;t two thing at once ( bad I know)
   1 ) split the internal algorithm and public api comments
   2 ) reformat the api comments for docgen.
This result in something like 40 extra ps/pdf pages of docs, two
things occur to that there may have been some conflict in the
the .c files when merge due to the time between diff and applying, also
it appears davej passed the file to linux so as small stuff so the docgen
changes prolly need to come throught the ext3 team rather than dave.

If the later is the case it'll prolly fix itself it the fullness as time
as the ext3 team are reviewing the docs.., arent they Andrew??


Master of Peng Shui.  (Ancient oriental art of Penguin Arranging)
GPG Key FPR: CFF1 F383 F854 4E6A 918D  5CFF A90D E73B 88DE 0B3E

- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to More majordomo info at Please read the FAQ at

This archive was generated by hypermail 2b29 : Tue Oct 15 2002 - 22:00:57 EST