Skip to contentSkip to conversation

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

DISCUSSION Stephen Rothwell 3 participants 10 messages Feb 24, 2021 Linux-next tree

lore
Share & tools
lore
#0 lore raw

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")

Signature · 2 lines
Cheers,
Stephen Rothwell
#1 lore raw
Quoted 11 lines · Stephen Rothwell

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")

Thanks for reporting, I'll send a fix soon.

#2 lore raw
In reply to Stephen Rothwell

Stephen,

Quoted 5 lines · Stephen Rothwell

Hi all,

After merging the block tree, today's linux-next build (htmldocs) produced this warning:

Quoted 7 lines

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);

#3 lore raw

Hi Chaitanya,

Quoted 9 lines · On Wed, 24 Feb 2021 05:25:49 +0000 Chaitanya Kulkarni…
Quoted 7 lines · Stephen Rothwell

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'`

Quoted 7 lines
Quoted 5 lines

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

I presume it is the missing ':' after @rwbs in the comment.

Signature · 2 lines
Cheers,
Stephen Rothwell
#4 lore raw
Quoted 3 lines · Stephen Rothwell
Quoted 2 lines

I've failed to understand this warning as rwbs is present in the doc header and in the function parameter :-

I presume it is the missing ':' after @rwbs in the comment.

Thanks, I was looking at the wrong places all this time, will send a fix.

I'll setup doc generation using sphinx on my machine, is there a particular command line that you have used for these warnings ?

#5 lore raw

Hi Chaitanya,

Quoted 9 lines · On Wed, 24 Feb 2021 05:38:06 +0000 Chaitanya Kulkarni…
Quoted 3 lines · Stephen Rothwell
Quoted 2 lines

I've failed to understand this warning as rwbs is present in the doc header and in the function parameter :-

I presume it is the missing ':' after @rwbs in the comment.

Thanks, I was looking at the wrong places all this time, will send a fix.

I'll setup doc generation using sphinx on my machine, is there a particular command line that you have used for these warnings ?

I just do a "make htmldocs"

Signature · 2 lines
Cheers,
Stephen Rothwell
#6 lore raw
Quoted 3 lines · Stephen Rothwell
Quoted 2 lines

I'll setup doc generation using sphinx on my machine, is there a particular command line that you have used for these warnings ?

I just do a "make htmldocs"

I did that, please have a look at the test log.

#7 lore raw
Quoted 6 lines · Chaitanya Kulkarni
Quoted 3 lines · Stephen Rothwell
Quoted 2 lines

I'll setup doc generation using sphinx on my machine, is there a particular command line that you have used for these warnings ?

I just do a "make htmldocs"

I did that, please have a look at the test log.

Hi,

Where is the test log?

Signature · 1 line
~Randy
#8 lore raw

Randy,

Quoted 11 lines · Randy Dunlap
Quoted 6 lines · Chaitanya Kulkarni
Quoted 3 lines · Stephen Rothwell
Quoted 2 lines

I'll setup doc generation using sphinx on my machine, is there a particular command line that you have used for these warnings ?

I just do a "make htmldocs"

I did that, please have a look at the test log.

Hi,

Where is the test log?

I sent out the following patch yesterday @ 23:16 PST with Stephen in CC on linux-block :- https://marc.info/?l=linux-block&m=161415113122092&w=2

It has the test log.

#9 lore raw
In reply to Stephen Rothwell
Quoted 6 lines · Stephen Rothwell
Quoted 5 lines
Quoted 3 lines

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

I presume it is the missing ':' after @rwbs in the comment.

I've sent a fix with your reported by, it will be great if you can provide reviewed-by tag.

Quoted 1 line

-- Cheers, Stephen Rothwell