| Message ID | 20231206023636.30460-1-rdunlap@infradead.org (mailing list archive) |
|---|---|
| State | New |
| Headers | show |
| Series | gfs2: rgrp: fix kernel-doc warnings | expand |
Hi Randy, thanks, I've pushed this to for-next. On Wed, Dec 6, 2023 at 3:46 AM Randy Dunlap <rdunlap@infradead.org> wrote: > Fix kernel-doc warnings found when using "W=1". > > rgrp.c:162: warning: missing initial short description on line: > * gfs2_bit_search > rgrp.c:1200: warning: Function parameter or member 'gl' not described in 'gfs2_rgrp_go_instantiate' > rgrp.c:1200: warning: Excess function parameter 'gh' description in 'gfs2_rgrp_go_instantiate' > rgrp.c:1970: warning: missing initial short description on line: > * gfs2_rgrp_used_recently > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Cc: Andreas Gruenbacher <agruenba@redhat.com> > Cc: gfs2@lists.linux.dev > --- > fs/gfs2/rgrp.c | 10 +++++----- > 1 file changed, 5 insertions(+), 5 deletions(-) > > diff -- a/fs/gfs2/rgrp.c b/fs/gfs2/rgrp.c > --- a/fs/gfs2/rgrp.c > +++ b/fs/gfs2/rgrp.c > @@ -159,13 +159,13 @@ static inline u8 gfs2_testbit(const stru > } > > /** > - * gfs2_bit_search > + * gfs2_bit_search - search bitmap for a state > * @ptr: Pointer to bitmap data > * @mask: Mask to use (normally 0x55555.... but adjusted for search start) > * @state: The state we are searching for > * > - * We xor the bitmap data with a patter which is the bitwise opposite > - * of what we are looking for, this gives rise to a pattern of ones > + * We xor the bitmap data with a pattern which is the bitwise opposite > + * of what we are looking for. This gives rise to a pattern of ones > * wherever there is a match. Since we have two bits per entry, we > * take this pattern, shift it down by one place and then and it with > * the original. All the even bit positions (0,2,4, etc) then represent > @@ -1188,7 +1188,7 @@ static void rgrp_set_bitmap_flags(struct > > /** > * gfs2_rgrp_go_instantiate - Read in a RG's header and bitmaps > - * @gh: the glock holder representing the rgrpd to read in > + * @gl: the glock holder representing the rgrpd to read in So it's a glock, not a glock holder. I've fixed up the description. > * > * Read in all of a Resource Group's header and bitmap blocks. > * Caller must eventually call gfs2_rgrp_brelse() to free the bitmaps. > @@ -1967,7 +1967,7 @@ static bool gfs2_rgrp_congested(const st > } > > /** > - * gfs2_rgrp_used_recently > + * gfs2_rgrp_used_recently - test if an rgrp has been used recently > * @rs: The block reservation with the rgrp to test > * @msecs: The time limit in milliseconds > * > Thanks, Andreas
diff -- a/fs/gfs2/rgrp.c b/fs/gfs2/rgrp.c --- a/fs/gfs2/rgrp.c +++ b/fs/gfs2/rgrp.c @@ -159,13 +159,13 @@ static inline u8 gfs2_testbit(const stru } /** - * gfs2_bit_search + * gfs2_bit_search - search bitmap for a state * @ptr: Pointer to bitmap data * @mask: Mask to use (normally 0x55555.... but adjusted for search start) * @state: The state we are searching for * - * We xor the bitmap data with a patter which is the bitwise opposite - * of what we are looking for, this gives rise to a pattern of ones + * We xor the bitmap data with a pattern which is the bitwise opposite + * of what we are looking for. This gives rise to a pattern of ones * wherever there is a match. Since we have two bits per entry, we * take this pattern, shift it down by one place and then and it with * the original. All the even bit positions (0,2,4, etc) then represent @@ -1188,7 +1188,7 @@ static void rgrp_set_bitmap_flags(struct /** * gfs2_rgrp_go_instantiate - Read in a RG's header and bitmaps - * @gh: the glock holder representing the rgrpd to read in + * @gl: the glock holder representing the rgrpd to read in * * Read in all of a Resource Group's header and bitmap blocks. * Caller must eventually call gfs2_rgrp_brelse() to free the bitmaps. @@ -1967,7 +1967,7 @@ static bool gfs2_rgrp_congested(const st } /** - * gfs2_rgrp_used_recently + * gfs2_rgrp_used_recently - test if an rgrp has been used recently * @rs: The block reservation with the rgrp to test * @msecs: The time limit in milliseconds *
Fix kernel-doc warnings found when using "W=1". rgrp.c:162: warning: missing initial short description on line: * gfs2_bit_search rgrp.c:1200: warning: Function parameter or member 'gl' not described in 'gfs2_rgrp_go_instantiate' rgrp.c:1200: warning: Excess function parameter 'gh' description in 'gfs2_rgrp_go_instantiate' rgrp.c:1970: warning: missing initial short description on line: * gfs2_rgrp_used_recently Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Cc: Andreas Gruenbacher <agruenba@redhat.com> Cc: gfs2@lists.linux.dev --- fs/gfs2/rgrp.c | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)