From patchwork Mon Jun 7 18:57:24 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Laurent Vivier X-Patchwork-Id: 1488897 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Authentication-Results: ozlabs.org; spf=pass (sender SPF authorized) smtp.mailfrom=nongnu.org (client-ip=209.51.188.17; helo=lists.gnu.org; envelope-from=qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org; receiver=) Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 4FzN4D36rHz9s5R for ; Tue, 8 Jun 2021 05:00:43 +1000 (AEST) Received: from localhost ([::1]:45146 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lqKUK-0000lc-3v for incoming@patchwork.ozlabs.org; Mon, 07 Jun 2021 15:00:40 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53560) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqKRT-0003fy-1T; Mon, 07 Jun 2021 14:57:43 -0400 Received: from mout.kundenserver.de ([212.227.126.133]:59729) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqKRR-0005mp-0h; Mon, 07 Jun 2021 14:57:42 -0400 Received: from quad ([82.142.12.38]) by mrelayeu.kundenserver.de (mreue010 [212.227.15.167]) with ESMTPSA (Nemesis) id 1MdvVu-1lFcJS1kJy-00b3iU; Mon, 07 Jun 2021 20:57:36 +0200 From: Laurent Vivier To: qemu-devel@nongnu.org Subject: [PULL 05/11] docs: fix broken reference Date: Mon, 7 Jun 2021 20:57:24 +0200 Message-Id: <20210607185730.346641-6-laurent@vivier.eu> X-Mailer: git-send-email 2.31.1 In-Reply-To: <20210607185730.346641-1-laurent@vivier.eu> References: <20210607185730.346641-1-laurent@vivier.eu> MIME-Version: 1.0 X-Provags-ID: V03:K1:ac47I72vAYias3vxwkfOxCfTUZrBwOUBhhz10yjGO4VU07XNXNe shTSTi4XDCP31Xmpyt56u3slGp+aRLwflKYgj8F5dlK2pnVSBbGQCETQHDE1dPx51GWrB9O SpCHys90UvuvqdSFbw2P3lKuLmFkgfogsM41wcHVxXnJlQEUV79/qkubQKIcnmQ4lCAKrcs PgJLBzTaI0DdwJ3wc8yZg== X-UI-Out-Filterresults: notjunk:1;V03:K0:1CcYzfhaukg=:g1D7Qq7qc2Qx4MCs3COb4f 43OOh4p8Alz6c8e40mUitNqLs4eDF+q78mLJtQqeKTLzZv4cOv6NAyp+yHKIlFTfNSzG7xpLY mkjO+32SL/O3u60ochLRut3etylHHgQvwxgW045GzZ900uchqk3amJ/hJ7WwKBZeT23jXikJq i22QNRx1DfdzAv0GUgZkt/RSwskQ6zPjrW4Ovld23UjENlSpu0FOiT1gp7Q0vCTpv350LOQpT GG7qrsdeulz/grxtzDa1G8TmbMqs69oOMZM20RgEoeLTlZAAu6NQQeAxowIYkjlpneTwDFX5p I6OEbnaXwD9wKGHwQFG3w50xJWBr+9+hQE6ynN1gbksB+ooxdPTBJOJsgIDOf77OQmbmDNIWQ jDh/6rj0X8KavcV+zchbuOlF2GATLACmBUreenA/rqJJD5WriZcWMBFWTlS//hHb7jC7rE40v x1JHnVtbqkuBHblBIONcg7LoutrfdOEAZH5Pqfkl839vuobfgW1hMPRMFXjp02feKM58NRzMv kXz08+jOSfq2PoFgv0dJgs= Received-SPF: none client-ip=212.227.126.133; envelope-from=laurent@vivier.eu; helo=mout.kundenserver.de X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_NONE=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: qemu-trivial@nongnu.org, John Snow , Michael Tokarev , Laurent Vivier , Peter Maydell Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" From: John Snow 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\(\) `,:c:type:`MemoryListener.region_del\(\) Sphinx does not process the role information correctly, so we get this (my pseudo-notation) construct: ,:c:type: MemoryListener.region_del() 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 Reviewed-by: Peter Maydell Message-Id: <20210511192950.2061326-1-jsnow@redhat.com> Signed-off-by: Laurent Vivier --- 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. *