From: "Tobin C. Harding" <me@tobin.cc>
To: Theodore Ts'o <tytso@mit.edu>, Jan Kara <jack@suse.com>,
linux-ext4@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] jbd2: fix sphinx kerel-doc build warnings
Date: Wed, 10 Jan 2018 17:29:30 +1100 [thread overview]
Message-ID: <20180110062930.GA25272@eros> (raw)
In-Reply-To: <20180110052619.GG5809@thunk.org>
On Wed, Jan 10, 2018 at 12:26:19AM -0500, Theodore Ts'o wrote:
> On Wed, Jan 10, 2018 at 12:42:29PM +1100, Tobin C. Harding wrote:
> > 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>
>
> Thanks, applied. I did fix up a few of your newly added doc strings.
>
> - Ted
Oh cool, thanks.
Tobin
prev parent reply other threads:[~2018-01-10 6:29 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-01-10 1:42 [PATCH v2] jbd2: fix sphinx kerel-doc build warnings Tobin C. Harding
2018-01-10 5:26 ` Theodore Ts'o
2018-01-10 6:29 ` Tobin C. Harding [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20180110062930.GA25272@eros \
--to=me@tobin.cc \
--cc=jack@suse.com \
--cc=linux-ext4@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=tytso@mit.edu \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox