jbd2: fix sphinx kernel-doc build warnings
authorTobin C. Harding <me@tobin.cc>
Wed, 10 Jan 2018 05:27:29 +0000 (00:27 -0500)
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Thu, 22 Feb 2018 14:42:26 +0000 (15:42 +0100)
commit879bcbe0913fb6f938157af821d10f48235c166c
treeade4c13f8b3a690d5af3617e5a9edd42324c3717
parent598b21708ec09ad33cd66d162d2fea2dd66d9f64
jbd2: fix sphinx kernel-doc build warnings

commit f69120ce6c024aa634a8fc25787205e42f0ccbe6 upstream.

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
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
fs/jbd2/transaction.c
include/linux/jbd2.h