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
Message-Id: <20211216192704.413216-1-james.clark@arm.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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