Re: [PATCH] add block IO documentation to tracepoint docbook

[Christoph Hellwig]

On Wed, Jul 01, 2009 at 03:53:49PM -0400, William Cohen wrote:
> +/**
> + * block_rq_abort - Abort Block Operation Request
> + * @q: queue containing the block operation request
> + * @rq: block IO operation request
> + *
> + * Called immediately after pending block IO operation request @rq in
> + * queue @q is aborted. The fields in the operation request @rq
> + * can be examined to determine which device and sectors the pending
> + * operation would access.
> + */
>  TRACE_EVENT(block_rq_abort,

Um, what's the point?  These are not function, but rather trace points.
The paramters don't actually get exported in the trace files, but the
printk ring buffer format and the format string do.  So please document
the formats, and if possible make sure this documentation actually
appears in debugfs in the trace subdirectory so people get it very easily.

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/