[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 05/11] docs: fix broken reference
From: |
Laurent Vivier |
Subject: |
[PULL 05/11] docs: fix broken reference |
Date: |
Mon, 7 Jun 2021 20:57:24 +0200 |
From: John Snow <jsnow@redhat.com>
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>
---
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 c158fd708455..b114f5454b15 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.31.1
- [PULL 00/11] Trivial branch for 6.1 patches, Laurent Vivier, 2021/06/07
- [PULL 02/11] i386/kvm: The value passed to strerror should be positive, Laurent Vivier, 2021/06/07
- [PULL 05/11] docs: fix broken reference,
Laurent Vivier <=
- [PULL 06/11] target/nios2: fix page-fit instruction count, Laurent Vivier, 2021/06/07
- [PULL 11/11] vhost-vdpa: Remove redundant declaration of address_space_memory, Laurent Vivier, 2021/06/07
- [PULL 04/11] linux-user/syscall: Constify bitmask_transtbl fcntl/mmap flags_tlb[], Laurent Vivier, 2021/06/07
- [PULL 07/11] hw/display/macfb: Classify the "nubus-macfb" as display device, Laurent Vivier, 2021/06/07
- [PULL 03/11] misc: Correct relative include path, Laurent Vivier, 2021/06/07
- [PULL 09/11] target/mips: Fix 'Uncoditional' typo, Laurent Vivier, 2021/06/07
- [PULL 01/11] target/riscv: Do not include 'pmp.h' in user emulation, Laurent Vivier, 2021/06/07
- [PULL 10/11] scripts/oss-fuzz: Fix typo in documentation, Laurent Vivier, 2021/06/07
- [PULL 08/11] target/hppa: Remove unused 'memory.h' header, Laurent Vivier, 2021/06/07
- Re: [PULL 00/11] Trivial branch for 6.1 patches, Peter Maydell, 2021/06/08