]> git.baikalelectronics.ru Git - kernel.git/commit
jbd2: fix sphinx kernel-doc build warnings
authorTobin C. Harding <me@tobin.cc>
Wed, 10 Jan 2018 05:27:29 +0000 (00:27 -0500)
committerTheodore Ts'o <tytso@mit.edu>
Wed, 10 Jan 2018 05:27:29 +0000 (00:27 -0500)
commit75f1b19b1ad3dcd3e946d961f659301702c27a8a
treedf61d8f7c7bba712ea269cb5b037cd13d613fe43
parenta786106b7c06b103ac4152b9effa7afae634555e
jbd2: fix sphinx kernel-doc build warnings

Sphinx emits various (26) warnings when building make target 'htmldocs'.
Currently struct definitions contain duplicate documentation, some as
kernel-docs and some as standard c89 comments.  We can reduce
duplication while cleaning up the kernel docs.

Move all kernel-docs to right above each struct member.  Use the set of
all existing comments (kernel-doc and c89).  Add documentation for
missing struct members and function arguments.

Signed-off-by: Tobin C. Harding <me@tobin.cc>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
Cc: stable@vger.kernel.org
fs/jbd2/transaction.c
include/linux/jbd2.h