From: Jonathan Corbet <corbet@lwn.net>
To: "Tobin C. Harding" <tobin@kernel.org>
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 3/4] docs: Remove unnecessary reference link title
Date: Tue, 9 Apr 2019 15:20:30 -0600 [thread overview]
Message-ID: <20190409152030.2ed66e86@lwn.net> (raw)
In-Reply-To: <20190409004359.29668-4-tobin@kernel.org>
On Tue, 9 Apr 2019 10:43:58 +1000
"Tobin C. Harding" <tobin@kernel.org> wrote:
> Labels that precede a heading use the heading as the link title.
> Explicitly adding the link title is redundant and makes the reference
> slightly less maintainable.
>
> Remove unnecessary reference link title.
So I agree with the objective, but...
> - As mentioned above in :ref:`VMA policies <vma_policy>` section,
> + As mentioned above in :ref:`vma_policy` section,
...this one generates a warning that highlights a flaw in the reasoning
here:
Documentation/admin-guide/mm/numa_memory_policy.rst:144: WARNING:
undefined label: vma-policy (if the link has no caption the label
must precede a section header)
Said label does not precede a section header, so it can't be used bare in
this way.
I'll apply the other three, but this one needs some repairs :)
Thanks,
jon
next prev parent reply other threads:[~2019-04-09 21:20 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-09 0:43 [PATCH v2 0/4] docs: Fix various build warnings/errors Tobin C. Harding
2019-04-09 0:43 ` [PATCH v2 1/4] docs: Fix spelling mistake Tobin C. Harding
2019-04-09 0:43 ` [PATCH v2 2/4] docs: Add colon clearing sphinx warning Tobin C. Harding
2019-04-09 0:43 ` [PATCH v2 3/4] docs: Remove unnecessary reference link title Tobin C. Harding
2019-04-09 21:20 ` Jonathan Corbet [this message]
2019-04-09 23:21 ` Tobin C. Harding
2019-04-09 0:43 ` [PATCH v2 4/4] docs: Use reference to link to rst file Tobin C. Harding
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=20190409152030.2ed66e86@lwn.net \
--to=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=tobin@kernel.org \
/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).