]> git.ipfire.org Git - thirdparty/linux.git/commit
fs: fix __sb_write_started() kerneldoc formatting
authorVegard Nossum <vegard.nossum@oracle.com>
Thu, 28 Dec 2023 10:06:08 +0000 (11:06 +0100)
committerChristian Brauner <brauner@kernel.org>
Thu, 28 Dec 2023 10:40:40 +0000 (11:40 +0100)
commitc39e2ae3943d4ee278af4e1b1dcfd5946da1089b
tree0f7e0578fcd3593b4a1905df33a1c9c88039d0ca
parent7a18c0fff41ee60438ab2a1837d5b1a73ca2e2dd
fs: fix __sb_write_started() kerneldoc formatting

When running 'make htmldocs', I see the following warning:

  Documentation/filesystems/api-summary:14: ./include/linux/fs.h:1659: WARNING: Definition list ends without a blank line; unexpected unindent.

The official guidance [1] seems to be to use lists, which will prevent
both the "unexpected unindent" warning as well as ensure that each line
is formatted on a separate line in the HTML output instead of being
all considered a single paragraph.

[1]: https://docs.kernel.org/doc-guide/kernel-doc.html#return-values

Fixes: 8802e580ee64 ("fs: create __sb_write_started() helper")
Cc: Amir Goldstein <amir73il@gmail.com>
Cc: Josef Bacik <josef@toxicpanda.com>
Cc: Jan Kara <jack@suse.cz>
Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com>
Link: https://lore.kernel.org/r/20231228100608.3123987-1-vegard.nossum@oracle.com
Signed-off-by: Christian Brauner <brauner@kernel.org>
include/linux/fs.h