diff options
| author | John Snow <jsnow@redhat.com> | 2021-05-11 15:29:50 -0400 |
|---|---|---|
| committer | Laurent Vivier <laurent@vivier.eu> | 2021-06-05 21:15:22 +0200 |
| commit | d7878875ae09e9c59aa2bd52e6f289cb845e944e (patch) | |
| tree | 41af41b7518d4f8eba901260f2cccba7da173132 /include/exec | |
| parent | 180d4ef3ad08f2f5073184e1fa763c230fe4750f (diff) | |
| download | focaccia-qemu-d7878875ae09e9c59aa2bd52e6f289cb845e944e.tar.gz focaccia-qemu-d7878875ae09e9c59aa2bd52e6f289cb845e944e.zip | |
docs: fix broken reference
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> Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Message-Id: <20210511192950.2061326-1-jsnow@redhat.com> Signed-off-by: Laurent Vivier <laurent@vivier.eu>
Diffstat (limited to 'include/exec')
| -rw-r--r-- | include/exec/memory.h | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/include/exec/memory.h b/include/exec/memory.h index c158fd7084..b114f5454b 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. * |