qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Laurent Vivier <laurent@vivier.eu>
To: qemu-devel@nongnu.org
Cc: qemu-trivial@nongnu.org, John Snow <jsnow@redhat.com>,
	Michael Tokarev <mjt@tls.msk.ru>,
	Laurent Vivier <laurent@vivier.eu>,
	Peter Maydell <peter.maydell@linaro.org>
Subject: [PULL 05/11] docs: fix broken reference
Date: Mon,  7 Jun 2021 20:57:24 +0200	[thread overview]
Message-ID: <20210607185730.346641-6-laurent@vivier.eu> (raw)
In-Reply-To: <20210607185730.346641-1-laurent@vivier.eu>

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



  parent reply	other threads:[~2021-06-07 19:01 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-07 18:57 [PULL 00/11] Trivial branch for 6.1 patches Laurent Vivier
2021-06-07 18:57 ` [PULL 01/11] target/riscv: Do not include 'pmp.h' in user emulation Laurent Vivier
2021-06-07 18:57 ` [PULL 02/11] i386/kvm: The value passed to strerror should be positive Laurent Vivier
2021-06-07 18:57 ` [PULL 03/11] misc: Correct relative include path Laurent Vivier
2021-06-07 18:57 ` [PULL 04/11] linux-user/syscall: Constify bitmask_transtbl fcntl/mmap flags_tlb[] Laurent Vivier
2021-06-07 18:57 ` Laurent Vivier [this message]
2021-06-07 18:57 ` [PULL 06/11] target/nios2: fix page-fit instruction count Laurent Vivier
2021-06-07 18:57 ` [PULL 07/11] hw/display/macfb: Classify the "nubus-macfb" as display device Laurent Vivier
2021-06-07 18:57 ` [PULL 08/11] target/hppa: Remove unused 'memory.h' header Laurent Vivier
2021-06-07 18:57 ` [PULL 09/11] target/mips: Fix 'Uncoditional' typo Laurent Vivier
2021-06-07 18:57 ` [PULL 10/11] scripts/oss-fuzz: Fix typo in documentation Laurent Vivier
2021-06-07 18:57 ` [PULL 11/11] vhost-vdpa: Remove redundant declaration of address_space_memory Laurent Vivier
2021-06-08  8:39 ` [PULL 00/11] Trivial branch for 6.1 patches Peter Maydell

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210607185730.346641-6-laurent@vivier.eu \
    --to=laurent@vivier.eu \
    --cc=jsnow@redhat.com \
    --cc=mjt@tls.msk.ru \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-trivial@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).