Re: [PATCH v3 1/1] docs: Disambiguate a pair of rST labels

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Jelle van der Waa writes:

> From: James Addison <jay@xxxxxxxxxxxxxx>
>
> 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@xxxxxxxxxxxxxx>
> ---
>  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




[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux