Subject: Re: linux-next: build warning after merge of the block tree

From: Chaitanya Kulkarni <[email-masked]>
Date: Wed, 24 Feb 2021 05:25:49 +0000

Stephen,

On 2/23/21 18:31, Stephen Rothwell wrote:
> Hi all,
>
> After merging the block tree, today's linux-next build (htmldocs)
> produced this warning:
>
> kernel/trace/blktrace.c:1878: warning: Function parameter or member 'rwbs' not described in 'blk_fill_rwbs'`
>
> Introduced by commit
>
>   1f83bb4b4914 ("blktrace: add blk_fill_rwbs documentation comment")
>
> -- Cheers, Stephen Rothwell
I've failed to understand this warning as rwbs is present in the doc header
and in the function parameter :-

/**                                                                                                   

 * blk_fill_rwbs - Fill the buffer rwbs by mapping op to character string.
 * @rwbs        buffer to be filled
 * @op:         REQ_OP_XXX for the tracepoint
 *
 * Description:
 *     Maps the REQ_OP_XXX to character and fills the buffer provided by the
 *     caller with resulting string.
 *
 **/
void blk_fill_rwbs(char *rwbs, unsigned int op)
{
        int i = 0;

        if (op & REQ_PREFLUSH)
                rwbs[i++] = 'F';

        switch (op & REQ_OP_MASK) {
        case REQ_OP_WRITE:
        case REQ_OP_WRITE_SAME:
                rwbs[i++] = 'W';
                break;
        case REQ_OP_DISCARD:
                rwbs[i++] = 'D';
                break;
        case REQ_OP_SECURE_ERASE:
                rwbs[i++] = 'D';
                rwbs[i++] = 'E';
                break;
        case REQ_OP_FLUSH:
                rwbs[i++] = 'F';
                break;
        case REQ_OP_READ:
                rwbs[i++] = 'R';
                break;
        default:
                rwbs[i++] = 'N';
        }

        if (op & REQ_FUA)
                rwbs[i++] = 'F';
        if (op & REQ_RAHEAD)
                rwbs[i++] = 'A';
        if (op & REQ_SYNC)
                rwbs[i++] = 'S';
        if (op & REQ_META)
                rwbs[i++] = 'M';

        rwbs[i] = '\0';
}
EXPORT_SYMBOL_GPL(blk_fill_rwbs);