Re: ext4 tracepoints documentation

Re: ext4 tracepoints documentation

[Theodore Tso]

On Fri, Oct 16, 2009 at 09:55:03AM -0400, Jason Baron wrote:
> 
> I'm trying to improve the documentation around kernel tracepoints. I
> started a docbook for tracepoints, see:
> http://www.kernel.org/doc/htmldocs/tracepoint/
> 
> The initial lkml postings were:
> 
> 1) http://lkml.indiana.edu/hypermail/linux/kernel/0904.3/02647.html
> 2) http://lkml.indiana.edu/hypermail/linux/kernel/0904.3/02650.html
> 3) http://lkml.indiana.edu/hypermail/linux/kernel/0904.3/02648.html
> 4) http://lkml.indiana.edu/hypermail/linux/kernel/0904.3/02651.html
> 
> I was hoping you could add an ext4 chapter to the book and docbook style
> comments as in patch #4 referenced above.

I'll add it to be todo list and I'm certainly supportative, but at the
moment I'm pretty overwhelmed with other tasks, such as a
filesystem/data corruption regression bug that _has_ to be higher
priority (kernel BZ 14354).  Then there are bugs filed where a
corrupted filesystem can cause a crash (BZ 14286 and BZ 14287).  I
don't think personally they are that much of a big deal, but the Red
Hat security team has a tendency to hyperventilate and call these
things DoS bugs, even though if you can insert a USB stick with a
corrupted file system image, you usually can reach the power switch.  :-)

Anyway, documentation is important, but unfortunately it has a
tendency to take a back seat to other issues which we have stacked on
our plate.

Maybe some other ext4 developer may be interested in tackling this.
I've cc'ed the linux-ext4 list.  If someone is willing to take a crack
at creating a patch with the documentation, I'll commit to finding the
time somehow to verify and fix up the documentation patch.

Best regards,

					- Ted