From: Eric Biggers <ebiggers@kernel.org>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
"Jonathan Corbet" <corbet@lwn.net>,
"Theodore Y. Ts'o" <tytso@mit.edu>,
Jaegeuk Kim <jaegeuk@kernel.org>,
linux-fscrypt@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v6 35/80] docs: fs: fscrypt.rst: get rid of :c:type: tags
Date: Wed, 14 Oct 2020 14:59:54 -0700 [thread overview]
Message-ID: <20201014215954.GB2545693@gmail.com> (raw)
In-Reply-To: <20201014085907.7da5bed3@coco.lan>
On Wed, Oct 14, 2020 at 08:59:07AM +0200, Mauro Carvalho Chehab wrote:
> [PATCH v6.1 35/80] docs: fs: fscrypt.rst: get rid of :c:type: tags
>
> The :c:type: tag has problems with Sphinx 3.x, as structs
> there should be declared with c:struct.
>
> So, remove them, relying at automarkup.py extension to
> convert them into cross-references.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
"relying at" => "relying on".
Otherwise looks fine, you can add:
Reviewed-by: Eric Biggers <ebiggers@google.com>
I do still wonder about your comment though:
> It should be said that, currently, if there's no documentation for "foo",
> automarkup will just keep using the regular text font, keeping the text
> untouched.
That will apply to most (maybe all) of the structures mentioned in this file.
I expected that if the documentation system now automatically recognizes
'struct foo', then it would render it in code font even when 'struct foo' isn't
documented. Any particular reason why that isn't the case? Not like I care
much myself, but it's a bit unexpected and it means this change actually makes
the rendered documentation look worse...
- Eric
next prev parent reply other threads:[~2020-10-14 22:00 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1602589096.git.mchehab+huawei@kernel.org>
2020-10-13 11:53 ` [PATCH v6 23/80] docs: get rid of :c:type explicit declarations for structs Mauro Carvalho Chehab
2020-10-13 11:53 ` [PATCH v6 35/80] docs: fs: fscrypt.rst: get rid of :c:type: tags Mauro Carvalho Chehab
2020-10-13 17:25 ` Eric Biggers
2020-10-14 6:59 ` Mauro Carvalho Chehab
2020-10-14 21:59 ` Eric Biggers [this message]
2020-10-15 5:32 ` Mauro Carvalho Chehab
2020-10-15 16:36 ` Eric Biggers
2020-10-15 16:56 ` Mauro Carvalho Chehab
2020-10-15 21:26 ` Jonathan Corbet
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=20201014215954.GB2545693@gmail.com \
--to=ebiggers@kernel.org \
--cc=corbet@lwn.net \
--cc=jaegeuk@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-fscrypt@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@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;
as well as URLs for NNTP newsgroup(s).