linux-ext4 - [PATCH] jbd2: fix kernel-doc notation warning

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-ID: <53e3ce27-ceae-560d-0fd4-f95728a33e12@infradead.org>
Date:   Sun, 8 Dec 2019 20:31:32 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Linux FS Devel <linux-fsdevel@...r.kernel.org>,
        linux-ext4@...r.kernel.org, Theodore Ts'o <tytso@....edu>
Cc:     Jan Kara <jack@...e.com>
Subject: [PATCH] jbd2: fix kernel-doc notation warning

From: Randy Dunlap <rdunlap@...radead.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@...radead.org>
Cc: "Theodore Ts'o" <tytso@....edu>
Cc: Jan Kara <jack@...e.com>
Cc: linux-ext4@...r.kernel.org
---
 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.