[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH v3] doc/sphinx/hxtool.py: add optional label argument to SRST
|
From: |
Peter Maydell |
|
Subject: |
Re: [PATCH v3] doc/sphinx/hxtool.py: add optional label argument to SRST directive |
|
Date: |
Tue, 30 Jan 2024 17:55:08 +0000 |
On Sat, 27 Jan 2024 at 23:18, David Woodhouse <dwmw2@infradead.org> wrote:
>
> From: David Woodhouse <dwmw@amazon.co.uk>
>
> We can't just embed labels directly into files like qemu-options.hx which
> are included from multiple top-level rST files, because Sphinx sees the
> labels as duplicate: https://github.com/sphinx-doc/sphinx/issues/9707
>
> So add an optional argument to the SRST directive which causes a label
> of the form '.. _DOCNAME-HXFILE-LABEL:' to be emitted, where 'DOCNAME'
> is the name of the top level rST file, 'HXFILE' is the filename of the
> .hx file, and 'LABEL' is the text provided within the 'SRST()' directive.
> Using the DOCNAME of the top-level rST document means that it is unique
> even when the .hx file is included from two different documents, as is
> the case for qemu-options.hx
>
> Now where the Xen PV documentation refers to the documentation for the
> -initrd command line option, it can emit a link directly to it as
> '<system/invocation-qemu-options-initrd>'.
>
> Signed-off-by: David Woodhouse <dwmw@amazon.co.uk>
> Reviewed-by: Paul Durrant <paul@xen.org>
> ---
This looks good so
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
but something has got mangled somewhere: patchew can't apply it:
4114f7204e892316d66be8f810eb5b8de4c0f75f.camel@infradead.org/">https://patchew.org/QEMU/4114f7204e892316d66be8f810eb5b8de4c0f75f.camel@infradead.org/
and patches doesn't like it either. In both cases git am barfs with
error: corrupt patch at line 23
I'm guessing it doesn't like the quoted-printable encoding.
thanks
-- PMM