jbd2: fix kernel-doc notation warning
diff mbox series

Message ID 53e3ce27-ceae-560d-0fd4-f95728a33e12@infradead.org
State New
Headers show
Series
  • jbd2: fix kernel-doc notation warning
Related show

Commit Message

Randy Dunlap Dec. 9, 2019, 4:31 a.m. UTC
From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning by inserting a beginning '*' character
for the kernel-doc line.

../include/linux/jbd2.h:461: warning: bad line:         journal. These are dirty buffers and revoke descriptor blocks.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "Theodore Ts'o" <tytso@mit.edu>
Cc: Jan Kara <jack@suse.com>
Cc: linux-ext4@vger.kernel.org
---
 include/linux/jbd2.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Jan Kara Dec. 10, 2019, 9:16 a.m. UTC | #1
On Sun 08-12-19 20:31:32, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning by inserting a beginning '*' character
> for the kernel-doc line.
> 
> ../include/linux/jbd2.h:461: warning: bad line:         journal. These are dirty buffers and revoke descriptor blocks.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: "Theodore Ts'o" <tytso@mit.edu>
> Cc: Jan Kara <jack@suse.com>
> Cc: linux-ext4@vger.kernel.org

Looks good to me. You can add:

Reviewed-by: Jan Kara <jack@suse.cz>

								Honza

> ---
>  include/linux/jbd2.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linux-next-20191209.orig/include/linux/jbd2.h
> +++ linux-next-20191209/include/linux/jbd2.h
> @@ -457,7 +457,7 @@ struct jbd2_revoke_table_s;
>   * @h_journal: Which journal handle belongs to - used iff h_reserved set.
>   * @h_rsv_handle: Handle reserved for finishing the logical operation.
>   * @h_total_credits: Number of remaining buffers we are allowed to add to
> -	journal. These are dirty buffers and revoke descriptor blocks.
> + *	journal. These are dirty buffers and revoke descriptor blocks.
>   * @h_revoke_credits: Number of remaining revoke records available for handle
>   * @h_ref: Reference count on this handle.
>   * @h_err: Field for caller's use to track errors through large fs operations.
>
Theodore Y. Ts'o Dec. 16, 2019, 2:45 a.m. UTC | #2
On Sun, Dec 08, 2019 at 08:31:32PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning by inserting a beginning '*' character
> for the kernel-doc line.
> 
> ../include/linux/jbd2.h:461: warning: bad line:         journal. These are dirty buffers and revoke descriptor blocks.
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Applied, thanks.

						- Ted

Patch
diff mbox series

--- linux-next-20191209.orig/include/linux/jbd2.h
+++ linux-next-20191209/include/linux/jbd2.h
@@ -457,7 +457,7 @@  struct jbd2_revoke_table_s;
  * @h_journal: Which journal handle belongs to - used iff h_reserved set.
  * @h_rsv_handle: Handle reserved for finishing the logical operation.
  * @h_total_credits: Number of remaining buffers we are allowed to add to
-	journal. These are dirty buffers and revoke descriptor blocks.
+ *	journal. These are dirty buffers and revoke descriptor blocks.
  * @h_revoke_credits: Number of remaining revoke records available for handle
  * @h_ref: Reference count on this handle.
  * @h_err: Field for caller's use to track errors through large fs operations.