From: James Clark <james.clark@arm.com>
To: mchehab+huawei@kernel.org, nfraprado@protonmail.com,
corbet@lwn.net, linux-doc@vger.kernel.org
Cc: James Clark <james.clark@arm.com>, linux-kernel@vger.kernel.org
Subject: [PATCH 0/1] docs: automarkup.py: Fix invalid HTML link output and broken URI fragments
Date: Thu, 16 Dec 2021 19:27:03 +0000 [thread overview]
Message-ID: <20211216192704.413216-1-james.clark@arm.com> (raw)
Hi,
I was looking modify some of the docs and add some links to subsections, but I noticed that this
was broken. I double checked on the kernel.org docs in case it was an issue with my sphinx version.
The commit message goes into more details.
I made a fix, but it does have one small side-effect. The original commit had the
side effect to prettify some of the page links. In the example I gave in the commit message
"L1TF - L1 Terminal Fault" now becomes "Documentation/admin-guide/hw-vuln//l1tf.rst". But this is
true to the rst source:
:ref:`Documentation/admin-guide/hw-vuln//l1tf.rst <default_mitigations>`.
Technically the bit between the `` and not the <> should be what is displayed. So I think this is
fine. And the original breaking commit only attempted to touchup plain text page links. I don't
think the intention was to modify existing references.
Thanks
James
James Clark (1):
docs: automarkup.py: Fix invalid HTML link output and broken URI
fragments
Documentation/sphinx/automarkup.py | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
--
2.28.0
next reply other threads:[~2021-12-16 19:27 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-16 19:27 James Clark [this message]
2021-12-16 19:27 ` [PATCH 1/1] " James Clark
2022-01-04 14:17 ` James Clark
2022-01-04 21:58 ` Nícolas F. R. A. Prado
2022-01-05 14:42 ` James Clark
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=20211216192704.413216-1-james.clark@arm.com \
--to=james.clark@arm.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=nfraprado@protonmail.com \
/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
all inboxes | Powered by JetHome®