* [PATCH] docs: fix broken reference
@ 2021-05-11 19:29 John Snow
2021-05-24 18:26 ` John Snow
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: John Snow @ 2021-05-11 19:29 UTC (permalink / raw)
To: qemu-trivial; +Cc: Paolo Bonzini, John Snow, qemu-devel, Peter Maydell
Long story short, we need a space here for the reference to work
correctly.
Longer story:
Without the space, kerneldoc generates a line like this:
one of :c:type:`MemoryListener.region_add\(\) <MemoryListener>`,:c:type:`MemoryListener.region_del\(\)
Sphinx does not process the role information correctly, so we get this
(my pseudo-notation) construct:
<text>,:c:type:</text>
<reference target="MemoryListener">MemoryListener.region_del()</reference>
which does not reference the desired entity, and leaves some extra junk
in the rendered output. See
https://qemu-project.gitlab.io/qemu/devel/memory.html#c.MemoryListener
member log_start for an example of the broken output as it looks today.
Signed-off-by: John Snow <jsnow@redhat.com>
---
include/exec/memory.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/exec/memory.h b/include/exec/memory.h
index 5728a681b27..3b9ca696061 100644
--- a/include/exec/memory.h
+++ b/include/exec/memory.h
@@ -571,7 +571,7 @@ struct MemoryListener {
* @log_start:
*
* Called during an address space update transaction, after
- * one of #MemoryListener.region_add(),#MemoryListener.region_del() or
+ * one of #MemoryListener.region_add(), #MemoryListener.region_del() or
* #MemoryListener.region_nop(), if dirty memory logging clients have
* become active since the last transaction.
*
--
2.30.2
^ permalink raw reply related [flat|nested] 4+ messages in thread* Re: [PATCH] docs: fix broken reference
2021-05-11 19:29 [PATCH] docs: fix broken reference John Snow
@ 2021-05-24 18:26 ` John Snow
2021-05-25 8:47 ` Peter Maydell
2021-06-05 19:15 ` Laurent Vivier
2 siblings, 0 replies; 4+ messages in thread
From: John Snow @ 2021-05-24 18:26 UTC (permalink / raw)
To: qemu-trivial; +Cc: Paolo Bonzini, qemu-devel, Peter Maydell
ping
On 5/11/21 3:29 PM, John Snow wrote:
> Long story short, we need a space here for the reference to work
> correctly.
>
>
> Longer story:
>
> Without the space, kerneldoc generates a line like this:
>
> one of :c:type:`MemoryListener.region_add\(\) <MemoryListener>`,:c:type:`MemoryListener.region_del\(\)
>
> Sphinx does not process the role information correctly, so we get this
> (my pseudo-notation) construct:
>
> <text>,:c:type:</text>
> <reference target="MemoryListener">MemoryListener.region_del()</reference>
>
> which does not reference the desired entity, and leaves some extra junk
> in the rendered output. See
> https://qemu-project.gitlab.io/qemu/devel/memory.html#c.MemoryListener
> member log_start for an example of the broken output as it looks today.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> include/exec/memory.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index 5728a681b27..3b9ca696061 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -571,7 +571,7 @@ struct MemoryListener {
> * @log_start:
> *
> * Called during an address space update transaction, after
> - * one of #MemoryListener.region_add(),#MemoryListener.region_del() or
> + * one of #MemoryListener.region_add(), #MemoryListener.region_del() or
> * #MemoryListener.region_nop(), if dirty memory logging clients have
> * become active since the last transaction.
> *
>
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] docs: fix broken reference
2021-05-11 19:29 [PATCH] docs: fix broken reference John Snow
2021-05-24 18:26 ` John Snow
@ 2021-05-25 8:47 ` Peter Maydell
2021-06-05 19:15 ` Laurent Vivier
2 siblings, 0 replies; 4+ messages in thread
From: Peter Maydell @ 2021-05-25 8:47 UTC (permalink / raw)
To: John Snow; +Cc: QEMU Trivial, Paolo Bonzini, QEMU Developers
On Tue, 11 May 2021 at 20:29, John Snow <jsnow@redhat.com> wrote:
>
> Long story short, we need a space here for the reference to work
> correctly.
>
>
> Longer story:
>
> Without the space, kerneldoc generates a line like this:
>
> one of :c:type:`MemoryListener.region_add\(\) <MemoryListener>`,:c:type:`MemoryListener.region_del\(\)
>
> Sphinx does not process the role information correctly, so we get this
> (my pseudo-notation) construct:
>
> <text>,:c:type:</text>
> <reference target="MemoryListener">MemoryListener.region_del()</reference>
>
> which does not reference the desired entity, and leaves some extra junk
> in the rendered output. See
> https://qemu-project.gitlab.io/qemu/devel/memory.html#c.MemoryListener
> member log_start for an example of the broken output as it looks today.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> include/exec/memory.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index 5728a681b27..3b9ca696061 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -571,7 +571,7 @@ struct MemoryListener {
> * @log_start:
> *
> * Called during an address space update transaction, after
> - * one of #MemoryListener.region_add(),#MemoryListener.region_del() or
> + * one of #MemoryListener.region_add(), #MemoryListener.region_del() or
> * #MemoryListener.region_nop(), if dirty memory logging clients have
> * become active since the last transaction.
> *
> --
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
thanks
-- PMM
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] docs: fix broken reference
2021-05-11 19:29 [PATCH] docs: fix broken reference John Snow
2021-05-24 18:26 ` John Snow
2021-05-25 8:47 ` Peter Maydell
@ 2021-06-05 19:15 ` Laurent Vivier
2 siblings, 0 replies; 4+ messages in thread
From: Laurent Vivier @ 2021-06-05 19:15 UTC (permalink / raw)
To: John Snow, qemu-trivial; +Cc: Paolo Bonzini, qemu-devel, Peter Maydell
Le 11/05/2021 à 21:29, John Snow a écrit :
> Long story short, we need a space here for the reference to work
> correctly.
>
>
> Longer story:
>
> Without the space, kerneldoc generates a line like this:
>
> one of :c:type:`MemoryListener.region_add\(\) <MemoryListener>`,:c:type:`MemoryListener.region_del\(\)
>
> Sphinx does not process the role information correctly, so we get this
> (my pseudo-notation) construct:
>
> <text>,:c:type:</text>
> <reference target="MemoryListener">MemoryListener.region_del()</reference>
>
> which does not reference the desired entity, and leaves some extra junk
> in the rendered output. See
> https://qemu-project.gitlab.io/qemu/devel/memory.html#c.MemoryListener
> member log_start for an example of the broken output as it looks today.
>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
> include/exec/memory.h | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/include/exec/memory.h b/include/exec/memory.h
> index 5728a681b27..3b9ca696061 100644
> --- a/include/exec/memory.h
> +++ b/include/exec/memory.h
> @@ -571,7 +571,7 @@ struct MemoryListener {
> * @log_start:
> *
> * Called during an address space update transaction, after
> - * one of #MemoryListener.region_add(),#MemoryListener.region_del() or
> + * one of #MemoryListener.region_add(), #MemoryListener.region_del() or
> * #MemoryListener.region_nop(), if dirty memory logging clients have
> * become active since the last transaction.
> *
>
Applied to my trivial-patches branch.
Thanks,
Laurent
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2021-06-05 19:16 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2021-05-11 19:29 [PATCH] docs: fix broken reference John Snow
2021-05-24 18:26 ` John Snow
2021-05-25 8:47 ` Peter Maydell
2021-06-05 19:15 ` Laurent Vivier
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).