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

From: William Cohen
Date: Wed Jul 08 2009 - 08:46:56 EST


Li Zefan wrote:
> More CCed
>
> William Cohen wrote:
>> The following patch adds block IO tracepoint documentation to the tracepoint
>> docbook.
>>
>> Signed-off-by: William Cohen <wcohen@xxxxxxxxxx>
>
> Nice, thanks!
>
> Acked-by: Li Zefan <lizf@xxxxxxxxxxxxxx>
>
>> +/**
>> + * block_rq_abort - Abort Block Operation Request
>
> Is it necessary to uppercase the first letter of every word?

I was assuming that it was a title. However, lower case would be okay.

-Will
>
>> + * @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,
>>
>> TP_PROTO(struct request_queue *q, struct request *rq),
>
>

--
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/