All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Jelle van der Waa <jvanderwaa@redhat.com>
Cc: linux-doc@vger.kernel.org, James Addison <jay@jp-hosting.net>,
	Thorsten Leemhuis <linux@leemhuis.info>
Subject: Re: [PATCH v3 1/1] docs: Disambiguate a pair of rST labels
Date: Mon, 14 Apr 2025 10:27:19 -0600	[thread overview]
Message-ID: <87semaaeu0.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250407195120.331103-2-jvanderwaa@redhat.com>

Jelle van der Waa writes:

> From: James Addison <jay@jp-hosting.net>
>
> According to the reStructuredText documentation, internal hyperlink
> targets[1] are intended to resolve within the current document.
>
> Sphinx has a bug that causes internal hyperlinks declared with
> duplicate names to resolve nondeterministically, producing incorrect
> documentation. Sphinx does not yet emit a warning when these
> duplicate target names are declared.
>
> To improve the reproducibility and correctness of the HTML
> documentation, disambiguate two labels both previously titled
> "submit_improvements".
>
> [1] - https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#hyperlink-targets
>
> Link: https://github.com/sphinx-doc/sphinx/issues/13383
> Signed-off-by: James Addison <jay@jp-hosting.net>
> ---
>  Documentation/admin-guide/quickly-build-trimmed-linux.rst     | 4 ++--
>  .../admin-guide/verify-bugs-and-bisect-regressions.rst        | 4 ++--
>  2 files changed, 4 insertions(+), 4 deletions(-)

The patch makes sense, and I've applied it, but ...

- When you forward a patch like this, you are really supposed to add
  your own Signed-off-by tag to it.  Given the nature of the patch and
  the explicit acknowledgment from James, I've concluded I can proceed
  without it.

- The headers of this patch have:

	From: Jelle van der Waa

  ...which doesn't help in the generation of a proper reply.  Something
  to look into.

Thanks,

jon

      parent reply	other threads:[~2025-04-14 16:27 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-07 19:51 [PATCH v3 0/1] reproducible sphinx docs Jelle
2025-04-07 19:51 ` [PATCH v3 1/1] docs: Disambiguate a pair of rST labels Jelle
2025-04-08  0:33   ` Bagas Sanjaya
2025-04-09 16:21     ` James Addison
2025-04-14 16:27   ` Jonathan Corbet [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=87semaaeu0.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=jay@jp-hosting.net \
    --cc=jvanderwaa@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux@leemhuis.info \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.