From nobody Mon Feb 9 13:07:24 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1768487232; cv=none; d=zohomail.com; s=zohoarc; b=WrrgMXePwYiybSjC4rnd7JlTK6fbeBNOKneCPWiMcKWqRE2rLpvLjMGD0LPVJmvfrl4DzzI9G0iVwNdK9UH7sR6wzucqa6YOwGVAw63vnuU5qKhob9Gn6gyTQPtalr+uWsn080LF0BMLfCeySiiQom6Lg+4oZLYoNYkck0KHw9A= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1768487232; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=pAnwY4PzPHpEbddcfZS0lRxYq0htrXKjp/HZmwpKGDk=; b=Asqjd8PbWNQCspsmtGv1LAiEt9c0zr9xZMPUnNdwje2A6mn4pZQrcytQvZRMUuzvj+G/ffxXNjU0zcBg9G2kcZDR4XUZNGIiJVq40NJB8sCABtU7WHgFlcPlhVxXpCcOJrCTz+Ls0XT8sJgOOeFSkmi/KazWgUVRfZV+BoPoI98= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1768487232584249.37193575870822; Thu, 15 Jan 2026 06:27:12 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1vgOJ4-0003Xj-QG; Thu, 15 Jan 2026 09:26:38 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1vgOJ3-0003XG-B4 for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:37 -0500 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1vgOJ0-0004jc-Tw for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:37 -0500 Received: by mail-wm1-x32c.google.com with SMTP id 5b1f17b1804b1-47ee76e8656so12206635e9.0 for ; Thu, 15 Jan 2026 06:26:34 -0800 (PST) Received: from mnementh.archaic.org.uk (f.7.f.1.7.5.e.f.f.f.c.5.d.8.2.4.0.0.0.0.0.d.1.0.0.b.8.0.1.0.0.2.ip6.arpa. [2001:8b0:1d0:0:428d:5cff:fe57:1f7f]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-47f4b2672d6sm50759435e9.14.2026.01.15.06.26.31 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Jan 2026 06:26:31 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1768487193; x=1769091993; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=pAnwY4PzPHpEbddcfZS0lRxYq0htrXKjp/HZmwpKGDk=; b=M7vZcOkOjFRb830QQUSRk4+6Kcbd7yIG7ugn1cqyig09UAKd1fRsg+t2rTOyeJrUTe gp40pAmkub8ee2Xdr4LPWhjkcQ3IsscgJRi02aUcvXn8VJhaVOmES40FE4y3FKmi8xOp 6bfUeAisdohVlRVY0fV2qPlZSE2R2eCexDund12P034U06l9nW57R4cItjBgzZnccEce xos1/5DEvP1mzWEWBYwPrY1eVXTAIXn9Y1v2XGOTWiZ8gbBFgazPOvkMx7QM2ufyWwWJ pjwSyJWRaxmey/km8dYUUsHXnClSh0TeVN/0FcgIueR57RgCi2uvS79JCrefGY9sq7kq GQHQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1768487193; x=1769091993; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=pAnwY4PzPHpEbddcfZS0lRxYq0htrXKjp/HZmwpKGDk=; b=eVxJHizU+Bcty7yBHPqdFD1YxI/cMt33AuSxFlmqvOuLXNTyWp9qrqG9SGHSqEpHPm vThJqTki7Mktqdsu8/y3R7ycG4j7jKX9+yUou9xd6PKPAcWU+hZPGvlKna6M+7rVkLBn io9poFY6k6SBVhwXfEWvzXNDwrC2zR7bhoDFsY67EltjeR2n9ffITlCBEtrtxVxS7ZoK qhvxlDLTS7+Kr7Lp4AfU1uflJEusouDOoHBXwZDaqsrmJp8eAK2bcmzDalExtLtuuMGZ uXm2vNxGuoAeMTyEYYcnv+Mgn9MLr570h+Y3s7WMZK5CEjU498gxnerJiS53zCI725tZ vN4g== X-Gm-Message-State: AOJu0Yw/sQYsFjQJXIQav9WMOWxnrlocOKNCXDfHOUJX91tY1NZQJ61G KPUGObKeNRkHYdJP0KRXVhKhI7waR74DjrRAQZUMK77joOMmVgub4vlqQhxqyKqmKEhDeQJ5cxz DgZ49 X-Gm-Gg: AY/fxX5Ak6JBQje8t4B4qhR3aIqoBPMZJ9cG0/a8WTo4ch8bWpBPfnoEPnMi7RN+wWs uwVnWtqOWwUILzNaWJ9ImJrohGWMNLWWbGtbbO+/CBy/ta5qcOecMg+719TwRibQIS4V4bm32Xi 0No1hM6LnrSshX3XW1PEM8ABs2LWygVgoUSHs2Ch9L0lTGz/YPK3ixwHM1YEsghpyAWkzVF7iO6 ZLQ3HDqPWo4yyjHQKb15RmTtSj9oEgoK2ny8sfhterCNHHaS7ndxiMW3l7TYLsE4BGsyemkIf+D TQxvFJF4ZD5lElW8k5UTE4+7Ym+rfk4fk1QHIujTBjUlj8vFdYg4m7L7xwF1ge7gMOlESBbuFR9 Y0p2W5mBYnI4HOt4sXAZAOVYrehXnIlPEU4jNRMsaKhuLyqZxtVXqzQqy/XxJ80QUbgw7CBK6Iu uJ48EXFR+9WF65qmb6Hv/b4mXcdH+qRXT7pB1rJG9WEOBvztcgqZbSGSJ877OcM7jq+yqEWrM+d 7YJRb4OxLhIl1udY5flbowOAhoW5uW0/uZ+LIaFLHhaKQ== X-Received: by 2002:a05:600c:34cd:b0:477:54cd:200e with SMTP id 5b1f17b1804b1-47ee32e5d05mr79663955e9.1.1768487193006; Thu, 15 Jan 2026 06:26:33 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Thomas Huth , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , "Edgar E. Iglesias" , Alistair Francis , Zhang Chen , Li Zhijian Subject: [PATCH 1/4] docs/system/arm/xlnx-zynq.rst: Improve docs rendering Date: Thu, 15 Jan 2026 14:26:26 +0000 Message-ID: <20260115142629.665319-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260115142629.665319-1-peter.maydell@linaro.org> References: <20260115142629.665319-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::32c; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32c.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, WEIRD_QUOTING=0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1768487233679158501 Content-Type: text/plain; charset="utf-8" Make some minor improvements to the rendering of the docs for the xlnx-zynq-a9 board: * use a proper hyperlink rather than a bare URL for the link to the reference manual * drop the hex address of the SMC SRAM: the bare '@' is rendered as bogus mailto: hyperlink, and the information is not very interesting to the user anyway * expand out the abbreviations in the list of Cortex-A9 per-CPU devices * correct the bullet-point list markup so it doesn't render with odd highlighted lines * capitalize 'Arm' correctly Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Zhang Chen --- docs/system/arm/xlnx-zynq.rst | 51 ++++++++++++++++++----------------- 1 file changed, 27 insertions(+), 24 deletions(-) diff --git a/docs/system/arm/xlnx-zynq.rst b/docs/system/arm/xlnx-zynq.rst index ade18a3fe1..aa37df2926 100644 --- a/docs/system/arm/xlnx-zynq.rst +++ b/docs/system/arm/xlnx-zynq.rst @@ -4,32 +4,35 @@ The Zynq 7000 family is based on the AMD SoC architecture= . These products integrate a feature-rich dual or single-core Arm Cortex-A9 MPCore based processing system (PS) and AMD programmable logic (PL) in a single device. =20 -More details here: -https://docs.amd.com/r/en-US/ug585-zynq-7000-SoC-TRM/Zynq-7000-SoC-Technic= al-Reference-Manual - -QEMU xilinx-zynq-a9 board supports following devices: - - A9 MPCORE - - cortex-a9 - - GIC v1 - - Generic timer - - wdt - - OCM 256KB - - SMC SRAM@0xe2000000 64MB - - Zynq SLCR - - SPI x2 - - QSPI - - UART - - TTC x2 - - Gigabit Ethernet Controller x2 - - SD Controller x2 - - XADC - - Arm PrimeCell DMA Controller - - DDR Memory - - USB 2.0 x2 +The SoC is documented in the +`Zynq 7000 Technical Reference manual `__. + +The QEMU xilinx-zynq-a9 board supports the following devices: + +- Arm Cortex-A9 MPCore CPU + + - Cortex-A9 CPUs + - GIC v1 interrupt controller + - Generic timer + - Watchdog timer + +- OCM 256KB +- SMC SRAM 64MB +- Zynq SLCR +- SPI x2 +- QSPI +- UART +- TTC x2 +- Gigabit Ethernet Controller x2 +- SD Controller x2 +- XADC +- Arm PrimeCell DMA Controller +- DDR Memory +- USB 2.0 x2 =20 Running """"""" -Direct Linux boot of a generic ARM upstream Linux kernel: +Direct Linux boot of a generic Arm upstream Linux kernel: =20 .. code-block:: bash =20 @@ -44,4 +47,4 @@ For configuring the boot-mode provide the following on th= e command line: =20 -machine boot-mode=3Dqspi =20 -Supported values are jtag, sd, qspi, nor. +Supported values are ``jtag``, ``sd``, ``qspi`` and ``nor``. --=20 2.47.3 From nobody Mon Feb 9 13:07:24 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1768487232; cv=none; d=zohomail.com; s=zohoarc; b=Q608rviRtFU+kemiPLA856PMGyPb526yaqWXW2CTgNLBvjEMeY9+yH8+SUQG6dBvSLBDCB0RtCriSzfzu8XN5uoBpJbNxhmeXDlB5mbzfDMdVV2euq3FpMvjzxw7Anr88f1JOFI2117sDkRNaAuUHCp29u/AAOwmE2ovcGatLwg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1768487232; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=LSGx3OEhBLISzf0x1Pda8IGrY+Ns7N44p2jUoJb+UpE=; b=WKURIeuz7AzTyVFK3ZOLwbiTqcV/AMoSsJsFydp7Uh5FWElSESDB+odUy6s3s5dsCZt2Vde88DOERB6zPfqhJ3T1/7XsyAdiUA2rfkggCfO1DL9hz61wP4+RW6+Bb0Z04EB6WtU/uI/6YZemnpbexNOCSWbxdG6IJSfUS2bjau8= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 176848723258292.48947632818783; Thu, 15 Jan 2026 06:27:12 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1vgOJ6-0003Xt-80; Thu, 15 Jan 2026 09:26:40 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1vgOJ4-0003Xf-J4 for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:38 -0500 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1vgOJ2-0004k4-Kr for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:38 -0500 Received: by mail-wm1-x32c.google.com with SMTP id 5b1f17b1804b1-47ee3a63300so9579045e9.2 for ; Thu, 15 Jan 2026 06:26:36 -0800 (PST) Received: from mnementh.archaic.org.uk (f.7.f.1.7.5.e.f.f.f.c.5.d.8.2.4.0.0.0.0.0.d.1.0.0.b.8.0.1.0.0.2.ip6.arpa. [2001:8b0:1d0:0:428d:5cff:fe57:1f7f]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-47f4b2672d6sm50759435e9.14.2026.01.15.06.26.33 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Jan 2026 06:26:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1768487195; x=1769091995; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=LSGx3OEhBLISzf0x1Pda8IGrY+Ns7N44p2jUoJb+UpE=; b=Uc6PDBtCr/v2MzKpY38BGy/PTUrhdSlDgV9+pmM/jzgS7WHKto7yrdP8lfX0/g+FlA HC6h023/Xd2OVTCBcDk7ANAeo53LABZOM+UFUx2qWB3RhWhplprdtbglUrlTNpZkcjgf djT9/yCpCGcIp4ijfo3A/ySeJdJBkg0X23AgHBlZ70xw8Iff6vHpGjD5QzvIuKAZx7qG 7Jr8iclJ9TuS9mIRWDYV/T7CkhyKNQbvQKYYTM0VhzmxtGNHN6W9Omv7y5E4wk9oQuC2 qYfOt9pVZxZQsSn9OsQ3MOVU6tPXu9xUsbKmD+MTzoB3iBdfUTxY7fH+j1QA22KKD+fD Lobw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1768487195; x=1769091995; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=LSGx3OEhBLISzf0x1Pda8IGrY+Ns7N44p2jUoJb+UpE=; b=D2U5MFKChrvJ1feWWbqspWCmxgoZIxeQc05n9NC14NUq1tvSUNvOaCmVc33a4xkjNB 2avDCyAsXmdeGEJPwxLj6QdOIQyGrxgYvbyBaw0SvguXULerKTlU27Svb+vBE30L3fEi v/V1JHwZdcYB5VmTwlL9kUOrFk/CvECRYRYxw+2FWx+QVM6QvK6HajKD0vLSnZBo7VOm nVgAGAZIyY546qRDU3r/Dw5z7Go7jnJuEdwGX632jwHNJ6xp/JyiE7tzqftCC0CcjX/A T8hnyckesRZ2jMlMoCGIkQwpJJ6bgMUjVRfFbh1+4rdpDFbRyEwv+xRqx+vA001LOT6X 8tUA== X-Gm-Message-State: AOJu0Ywrr1EpjxLe5Dv2HhwBwhQgzlcw3D32EpGrgUqoFe4AiCJGOrc/ uOuRnqow4tTOalJSIVTwUA6ef9+DzSMKqahmQfBYeZJgtTlkSexfchAXXgOSj7KOSvzrSPQJumO PQ7VC X-Gm-Gg: AY/fxX4wfoA9IhlKvSXOVCu3aR5M5lTGtwrM6hUyC0Z0L/sK7d9HQpFTNmUtl42T0Jq 4BJC7oIJ1pRuKdUkWH0tvWk/WWnBQoPQPfxUWPhTSWAqryopi+bOzMyRwm6T4NFJrATcP0Z6zX0 BrjKkFr+LJcjuWgVX/uUa/YTqWIPbymuxSo53jt9cJdHLARUnnhuGx6OE2Le28GFt08mNE6df+q 8OwpVeIosA44GaAB/tKuYwy1l+nDpzLZ7y9v5eEL8csE8pQATONK451BYe9fBvyNO0jnoth3P24 RE1xqjqlKVx3hFOYf+Od9FvS3IhZFURs28WVhJ6pmc30ti+5I6mmIBpuey9FRvH7MuwxmkcoYVu dP2O5YeCY+thHMPGwEcUMPMS5WU79vDId/XYdnlxdmIDoe6ofRXDJuaB31vJonCJhvTLhEvz7U4 E9L/jeB97PYcSYtgfk39QL/jDgzdgLhKy6GFxZl8rfYEakUWUdLeQJUUHMTkkQS6faeXMvuxZpO /A0kP0p8/GtKdz8iKhrpvThwO1tSZgoVWQihalGuYKfEw== X-Received: by 2002:a05:600c:a4c:b0:477:7975:30ea with SMTP id 5b1f17b1804b1-47ee338a820mr78141035e9.29.1768487195130; Thu, 15 Jan 2026 06:26:35 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Thomas Huth , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , "Edgar E. Iglesias" , Alistair Francis , Zhang Chen , Li Zhijian Subject: [PATCH 2/4] docs: avoid unintended mailto: hyperlinks Date: Thu, 15 Jan 2026 14:26:27 +0000 Message-ID: <20260115142629.665319-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260115142629.665319-1-peter.maydell@linaro.org> References: <20260115142629.665319-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::32c; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32c.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1768487233681158500 Content-Type: text/plain; charset="utf-8" In rST documents, an '@' character in normal text or a parsed-literal is assumed to be an email address and will result in a 'mailto:' hyperlink in the generated HTML. In several places we have mailto: hyperlinks that are unintended nonsense; correct these by either escaping the @ character or making the text use ``...`` preformatted rendering. This commit covers only the simple cases which can be trivially fixed with escaping or ``..``; the remaining cases will be handled in separate commits. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Zhang Chen --- docs/devel/submitting-a-patch.rst | 2 +- docs/system/device-url-syntax.rst.inc | 4 ++-- docs/system/vnc-security.rst | 6 +++--- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/devel/submitting-a-patch.rst b/docs/devel/submitting-a-pa= tch.rst index dd1cf32ad3..5ccd09a397 100644 --- a/docs/devel/submitting-a-patch.rst +++ b/docs/devel/submitting-a-patch.rst @@ -18,7 +18,7 @@ one-shot fix, the bare minimum we ask is that: =20 * - Check - Reason - * - Patches contain Signed-off-by: Your Name + * - Patches contain ``Signed-off-by: Your Name `` - States you are legally able to contribute the code. See :ref:`patch= _emails_must_include_a_signed_off_by_line` * - Sent as patch emails to ``qemu-devel@nongnu.org`` - The project uses an email list based workflow. See :ref:`submitting= _your_patches` diff --git a/docs/system/device-url-syntax.rst.inc b/docs/system/device-url= -syntax.rst.inc index 43b5c2596b..aae65d138c 100644 --- a/docs/system/device-url-syntax.rst.inc +++ b/docs/system/device-url-syntax.rst.inc @@ -33,7 +33,7 @@ These are specified using a special URL syntax. =20 .. parsed-literal:: =20 - |qemu_system| -drive file=3Discsi://user%password@192.0.2.1/iqn.2001= -04.com.example/1 + |qemu_system| -drive file=3Discsi://user%password\@192.0.2.1/iqn.200= 1-04.com.example/1 =20 Example (CHAP username/password via environment variables): =20 @@ -79,7 +79,7 @@ These are specified using a special URL syntax. =20 .. parsed-literal:: =20 - |qemu_system| -drive file=3Dssh://user@host/path/to/disk.img + |qemu_system| -drive file=3Dssh://user\@host/path/to/disk.img |qemu_system| -drive file.driver=3Dssh,file.user=3Duser,file.host=3D= host,file.port=3D22,file.path=3D/path/to/disk.img =20 Currently authentication must be done using ssh-agent. Other diff --git a/docs/system/vnc-security.rst b/docs/system/vnc-security.rst index 4c1769eeb8..97e94ff407 100644 --- a/docs/system/vnc-security.rst +++ b/docs/system/vnc-security.rst @@ -182,9 +182,9 @@ When not using TLS the recommended configuration is This says to use the 'GSSAPI' mechanism with the Kerberos v5 protocol, with the server principal stored in /etc/qemu/krb5.tab. For this to work the administrator of your KDC must generate a Kerberos principal for the -server, with a name of 'qemu/somehost.example.com@EXAMPLE.COM' replacing -'somehost.example.com' with the fully qualified host name of the machine -running QEMU, and 'EXAMPLE.COM' with the Kerberos Realm. +server, with a name of ``qemu/somehost.example.com@EXAMPLE.COM`` replacing +``somehost.example.com`` with the fully qualified host name of the machine +running QEMU, and ``EXAMPLE.COM`` with the Kerberos Realm. =20 When using TLS, if username+password authentication is desired, then a reasonable configuration is --=20 2.47.3 From nobody Mon Feb 9 13:07:24 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1768487451; cv=none; d=zohomail.com; s=zohoarc; b=hOcWJXhwzD0pjKlqSFvQ3Zuvl+Ik/T2RBe9K50MGnYI/vnR0iXijBpFBErBDrp3zz4TUZnm2gcnYnkdIXOKhHeDWwqkIRvODmmlqb7LV1fAvVeEsVoW/+rA+xFWfoesC4H7I+W6sxhAeyO/nF5xDfGW/gqONBLtLjUYuPbWwxoQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1768487451; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=MrIH/PkxdxhcCb21xCtkdaU8PJrncavs24FzlTPfmdw=; b=gQJnaAWcXkFpR6dTRihrk6IrMiyaKq3mlWJv9soahsGjT0OyLVOKVuBf4/5fh6Zq2F/6vUgySMX4mJkBv4gZjUMLFBSHYp9ZJe4ZQVbTDneLPfn4auAZf7tc0/jMKjbGKbjcsLkuHcGGBwSC76ycpCVeWIjqo85BfWj2wHKQ8kA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 176848745118941.58438396908741; Thu, 15 Jan 2026 06:30:51 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1vgOJ8-0003Z9-4K; Thu, 15 Jan 2026 09:26:42 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1vgOJ6-0003Xu-7t for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:40 -0500 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1vgOJ4-0004kN-F5 for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:39 -0500 Received: by mail-wm1-x329.google.com with SMTP id 5b1f17b1804b1-47ee9817a35so5586195e9.1 for ; Thu, 15 Jan 2026 06:26:37 -0800 (PST) Received: from mnementh.archaic.org.uk (f.7.f.1.7.5.e.f.f.f.c.5.d.8.2.4.0.0.0.0.0.d.1.0.0.b.8.0.1.0.0.2.ip6.arpa. [2001:8b0:1d0:0:428d:5cff:fe57:1f7f]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-47f4b2672d6sm50759435e9.14.2026.01.15.06.26.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Jan 2026 06:26:35 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1768487196; x=1769091996; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=MrIH/PkxdxhcCb21xCtkdaU8PJrncavs24FzlTPfmdw=; b=ypineUBwJfNdmjbEJbmaTZfr9SCdUNWx+/PmBqLftbWvG+yskC+jHUW15JNfwuNIgE zkWFpqoo31bHsciqvJ2+Xmm2fwhBLN3p/fMIE3L1kZkHZvGYxd7kqaCqkbIkIdedc/+n kZkOui8a0MdIA4mkBHdTTBJJl1GgELPiYd8zlsSqkr7/CfYYGMK00M+w+yGscmq+iRgu Sda9/CFkb9d6HmLPkXiw3XYepvZ6c8lPG3Eeg9exfGNLqCSd++hrLa7zjT/h19CzyMfM 9KoHW/Bdip1fWHpF3lAAtu4OrOy9J4WBfFPKs3FUtIK8USYOSKzRpFG5fC0NerPieV58 npQQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1768487196; x=1769091996; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=MrIH/PkxdxhcCb21xCtkdaU8PJrncavs24FzlTPfmdw=; b=b92t/+LJGJ5QK+Dobt3ZOLHYQv6Eu9ykYo79NmqYPKzB5lCFaOOiZjgJB/2TxITsbw IAIAUYwzUgdSrLdm9ANjs9IAR4rjMnxvZh9UR3AegOqjD36ibkaJ4io6yCCAA0AbBfPT +TELX6um/oViufURSOcgbCbBkuitKVvKOu2IQA4zD8sEnvHWvTJzCw8ERypW/8f4Ru30 jsyABobDU0BSxC9CjSuccamNYuJYb41hG2JAVNNQ0Ent2rjjSVgzoxNzt/CFSosVKlBq kMPCit9OCd5iRbjXRebXWdUldppIYEX05j2bn7zyl/BjBa2amBP54doO6g7hpLtEod0g J94g== X-Gm-Message-State: AOJu0Yx/ZNwYvhX6Kbq6ZBkIGIDtXN1burMywxOb69a4neV6uShVTxJM imWQvOEzkzoFrfHk8RF1+aLGGk34kMAWjF2+9y9HjkqYrCk4+OLjc8piOvmmOis+ZkOiLv+vWAC fGoU1 X-Gm-Gg: AY/fxX4wfMHE5cmlJJTn5WnXc9Tu9vsAuoEBgPCWfJo/1NGPvC0RmPbm5SVdvey0rjp /6jDgPQlF32Vy0tyHKMzkBHgQ5P0/0XiRW1YLJHIL2ZXsUOqFxCfUfBIlUeaQMmHscw9HWdh+eR /yxy1pJDIXuxodPz1mKfzGvbCQadBstumJNvt0OSHsc3Gv6bIL+y+N1DguywD+DeaOwQevtdZiJ or8EQTVKsYK70g2BZZZZnPrJA0FCyrvhdhcQ1L9N032YqAxVhDK0REj3wWBrKuZNi9YqNUbsiRO fV9TB1b3HGNdOdAxtnbdMR9u7HvIwq9XB4M++S+CQJR+qWiy9ujWMkqDg1h9qVk9lRF4Px0yaYj UY15TwNgoTZ8vgNYykOCTSRFE2QRG/Z/5obOzORE4aLvXWXEcsy8Th7uxSN/OI/t7GDqqjLGUFQ Iz42ekU9wPeR3mSz8/YplBLPFw5JJExcsqeYUaB3ic6puWKZgS1gpP4vci/bMBlFwIbayJ5a8uO MLTOFaFWN2M8O0k5Q9VRsJavLMUVAJrmr52ZW6FJUwdFQ== X-Received: by 2002:a05:600c:548c:b0:477:abea:9028 with SMTP id 5b1f17b1804b1-47ee32e0c52mr73399235e9.6.1768487196218; Thu, 15 Jan 2026 06:26:36 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Thomas Huth , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , "Edgar E. Iglesias" , Alistair Francis , Zhang Chen , Li Zhijian Subject: [PATCH 3/4] qemu-options.hx: Drop uses of @var Date: Thu, 15 Jan 2026 14:26:28 +0000 Message-ID: <20260115142629.665319-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260115142629.665319-1-peter.maydell@linaro.org> References: <20260115142629.665319-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::329; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x329.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1768487453038158500 Content-Type: text/plain; charset="utf-8" A few entries in qemu-options.hx use the syntax "my-option=3D@var{name}" when documenting an option that takes an argument. This syntax isn't consistently used, and the documentation generation has no support for it: it just appears literally in the HTML output. Switch these uses to the more common "my-option=3D". This also doesn't have any particular support in the documentation generation and so appears literally in the output, but it is a little less odd looking to the end-user. The other common pattern we have is "my-option=3Dname" with no marking at all that the right hand side of the '=3D' is not literal text; using <> seems preferable to me, as it makes it more distinct from cases where the right hand side is documenting that only certain values are permitted, as in "my-option=3Don|off". We don't change the uses of @var in the colo-compare documentation, as that part deserves a slightly more wide-ranging overhaul that is better in its own commit. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Markus Armbruster Reviewed-by: Zhang Chen --- qemu-options.hx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index ec92723f10..aca9dba8b9 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -36,7 +36,7 @@ DEF("machine", HAS_ARG, QEMU_OPTION_machine, \ " dea-key-wrap=3Don|off controls support for DEA key wr= apping (default=3Don)\n" " suppress-vmdesc=3Don|off disables self-describing mig= ration (default=3Doff)\n" " nvdimm=3Don|off controls NVDIMM support (default=3Dof= f)\n" - " memory-encryption=3D@var{} memory encryption object t= o use (default=3Dnone)\n" + " memory-encryption=3D memory encryption object to = use (default=3Dnone)\n" " hmat=3Don|off controls ACPI HMAT support (default=3Do= ff)\n" " spcr=3Don|off controls ACPI SPCR support (default=3Do= n)\n" #ifdef CONFIG_POSIX @@ -100,7 +100,7 @@ SRST ``nvdimm=3Don|off`` Enables or disables NVDIMM support. The default is off. =20 - ``memory-encryption=3D`` + ``memory-encryption=3D`` Memory encryption object to use. The default is none. =20 ``hmat=3Don|off`` @@ -180,7 +180,7 @@ SRST =20 -machine cxl-fmw.0.targets.0=3Dcxl.0,cxl-fmw.0.targets.1=3Dcxl= .1,cxl-fmw.0.size=3D128G,cxl-fmw.0.interleave-granularity=3D512 =20 - ``sgx-epc.0.memdev=3D@var{memid},sgx-epc.0.node=3D@var{numaid}`` + ``sgx-epc.0.memdev=3D,sgx-epc.0.node=3D`` Define an SGX EPC section. =20 ``smp-cache.0.cache=3Dcachename,smp-cache.0.topology=3Dtopologylevel`` @@ -4530,7 +4530,7 @@ DEF("compat", HAS_ARG, QEMU_OPTION_compat, " Policy for handling unstable management interfaces\n", QEMU_ARCH_ALL) SRST -``-compat [deprecated-input=3D@var{input-policy}][,deprecated-output=3D@va= r{output-policy}]`` +``-compat [deprecated-input=3D][,deprecated-output=3D]`` Set policy for handling deprecated management interfaces (experimental= ): =20 ``deprecated-input=3Daccept`` (default) @@ -4546,7 +4546,7 @@ SRST =20 Limitation: covers only syntactic aspects of QMP. =20 -``-compat [unstable-input=3D@var{input-policy}][,unstable-output=3D@var{ou= tput-policy}]`` +``-compat [unstable-input=3D][,unstable-output=3D]`` Set policy for handling unstable management interfaces (experimental): =20 ``unstable-input=3Daccept`` (default) --=20 2.47.3 From nobody Mon Feb 9 13:07:24 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=linaro.org ARC-Seal: i=1; a=rsa-sha256; t=1768487380; cv=none; d=zohomail.com; s=zohoarc; b=aoPokOe2iK4KWKRNr8ArPLGyoN2GwU8AyUspGJOAJpbx56wo6Rp8peu9i0x9B/lqxdklAyNaGEzLWCkIz7mMcXhfr0H6Gn2ia6mNZ+Fb+Y4+lbJDzhdXIq2ZeY+2inv+viY1I9mu/7S38Zl/cNI4kPZ+k2IV+aVTdDyq9bWXu7c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1768487380; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=HdzmhiNbhCuoACAiWr3MI6gOjyxPmkl9tpbKx4JTUfE=; b=efGdhu8fQRCohNG7D7HzrWlvKYg7aLZZxKwpVroKuAns28UchjxK55cO9+xQw8mlwkXVgRd9wkcAa9p51RVDmGLfKDPKiCEWsy+pN2mFfrX+flVeiOOapjhToXBMMcJcGhFghfLqSDNFrkl7IgubnL6KaHxzKQOGP9pbaotumIk= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1768487380571969.9186541549791; Thu, 15 Jan 2026 06:29:40 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1vgOJ8-0003ZA-K5; Thu, 15 Jan 2026 09:26:42 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1vgOJ7-0003Ym-HL for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:41 -0500 Received: from mail-wm1-x335.google.com ([2a00:1450:4864:20::335]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1vgOJ5-0004kk-27 for qemu-devel@nongnu.org; Thu, 15 Jan 2026 09:26:41 -0500 Received: by mail-wm1-x335.google.com with SMTP id 5b1f17b1804b1-47ee3a63300so9579455e9.2 for ; Thu, 15 Jan 2026 06:26:38 -0800 (PST) Received: from mnementh.archaic.org.uk (f.7.f.1.7.5.e.f.f.f.c.5.d.8.2.4.0.0.0.0.0.d.1.0.0.b.8.0.1.0.0.2.ip6.arpa. [2001:8b0:1d0:0:428d:5cff:fe57:1f7f]) by smtp.gmail.com with ESMTPSA id 5b1f17b1804b1-47f4b2672d6sm50759435e9.14.2026.01.15.06.26.36 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 15 Jan 2026 06:26:36 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1768487197; x=1769091997; darn=nongnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=HdzmhiNbhCuoACAiWr3MI6gOjyxPmkl9tpbKx4JTUfE=; b=qhcZXwe6zwQZ7btnBzVbu1uvG/1ExAwqSm2n8KC5z4Dqgie1g4i3CiPhjEXrLc2qNb S5RfNWHI7qRwfEN+3llwFfi9dQWkRgARoiBATf1HWwynq8uBMPMZ2dyfjtiLeImSfjqg CrADsE9qnOxiaQ0eg0onymB/oQcO3Ots+Rjsw/IYasBRyqKojw5gW1CVIhDVTY/EW4ST P9vw1i6j9mN5oLkxSHCIWtE7pALPdVLH6i5ir+4fjCTtcGL8FWYGR4xtoMy0EzqlGjyz d3LBYQ/vCJJ1DaMFH2UgBBzXIhoXT1cKClb+2ZjcCbkiMjKrBuDYem77JaV9Il8TMq2A cMmA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1768487197; x=1769091997; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-gg:x-gm-message-state:from :to:cc:subject:date:message-id:reply-to; bh=HdzmhiNbhCuoACAiWr3MI6gOjyxPmkl9tpbKx4JTUfE=; b=t3DVPOt4oWMT5tbyFVijhIAtIgR57Uh0YhHW9IV6Uin1atFe+RFZRto7cjGadU1ve1 JHJSMstPXI3fleH+aaceuQl/X6tQvO9+mmWfIIU2L2a65GiVbn3m5Nh8wgwlELRM1109 pug6B/INoNIrmqbP6W72KPXPj98eWOTYJzMOrT3zq8XKfYX5NbKjuQm6/PITEiVKdC1V GgPqBF0V86ABg8sQNI0mjD+SDc/+5klHE5ewepsbzI/US3UGxiEvHkd10Kp/tTWvb+vm WUCY8nGM0vmt8Vsf5x4l3jAq1Bp9mQMJKe7dl9XFYoS0Xe3Ql4KbPmT1QFAZHQYG9pTQ WctQ== X-Gm-Message-State: AOJu0YwtATH0EUFGGl1VXOYmUblTa+UM3TZyEfhNo8pi5oBfIQPCz3LP IVxjRkdA1jEoIS/PTyEpqSkiDcBDmjrnwdHteYFuzdq0ZMqn4TVLhzDpvNisANJaZ+zhIs+63P+ rp6Jl X-Gm-Gg: AY/fxX7jM1gzOlhKqytCbOYtC878H7a7cHy9evuQAxENtPGeGy8kim6LRvwJGVuAV2F uD59MAEwaTQlphrxhIWbRCgh0EkT+jCiaLNa460zsJ+rnbAK/F7jxDVQN17rw8d13LDUeV15pkM rMvPpUbvnI6QrNFF0Kq7ZOHKJhzCCilN616M7mrlBJHirYOBO4TADAPi9y9p6b5H37ivSiS4K6a QFigHEhqF636t47L9JRLWmEu3H7dkVkFz5gKDTY+DrL6h0vz3z6+2+uBlBwIULJ8us2O8JnFooO vDUPNvSfbHqBCl6ySEePefJANHqiWw8HDRR08L1jA9PwQCZd+6PDp5W622sfU+52vBVKudqw6Vx JEV3zUjM0aqfsyVNXPYbOwE4BIsw7giUzDEZV53KVLLCj+1WTrtP4H7SxI7a15oWNum/zR5ebDh HPS5TLC+bf6O/YwwSkBPOMHUeWlHuGBGgBFBY6N/pDrMpvu8e+PFps9LijFDhSE4jbN0kaiYzhP Yq/4k+y/lk0E9K2ClQyOBz1wIjdsvPCE+QoeW0YMIXnpw== X-Received: by 2002:a05:600c:548c:b0:477:fcb:2256 with SMTP id 5b1f17b1804b1-47ee3371876mr85492845e9.17.1768487197336; Thu, 15 Jan 2026 06:26:37 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Alex=20Benn=C3=A9e?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= , Thomas Huth , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , "Edgar E. Iglesias" , Alistair Francis , Zhang Chen , Li Zhijian Subject: [PATCH 4/4] qemu-options.hx: Improve formatting in colo-compare docs Date: Thu, 15 Jan 2026 14:26:29 +0000 Message-ID: <20260115142629.665319-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.47.3 In-Reply-To: <20260115142629.665319-1-peter.maydell@linaro.org> References: <20260115142629.665319-1-peter.maydell@linaro.org> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=2a00:1450:4864:20::335; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x335.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @linaro.org) X-ZM-MESSAGEID: 1768487382704158500 Content-Type: text/plain; charset="utf-8" The colo-compare option documentation has some formatting issues: it uses a "@var{...}" syntax which is not used elsewhere and which is rendered literally into the HTML documentation. The bare "@" sign also results in an unintended 'mailto:' hyperlink. Rewrite this into the style we seem to use most in the rest of the command line options, where an option which takes an argument is written as "my-option=3D". We take the opportunity to make the documentation a little clearer by splitting up the long paragraph and using preformatted-text markup for the names of the suboptions. Signed-off-by: Peter Maydell Reviewed-by: Alex Benn=C3=A9e Reviewed-by: Zhang Chen --- As I don't know anything about colo-compare, I may have accidentally introduced errors here; please check. --- qemu-options.hx | 41 +++++++++++++++++++++++++---------------- 1 file changed, 25 insertions(+), 16 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index aca9dba8b9..3883afb484 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -5972,22 +5972,31 @@ SRST stored. The file format is libpcap, so it can be analyzed with tools such as tcpdump or Wireshark. =20 - ``-object colo-compare,id=3Did,primary_in=3Dchardevid,secondary_in=3Dc= hardevid,outdev=3Dchardevid,iothread=3Did[,vnet_hdr_support][,notify_dev=3D= id][,compare_timeout=3D@var{ms}][,expired_scan_cycle=3D@var{ms}][,max_queue= _size=3D@var{size}]`` - Colo-compare gets packet from primary\_in chardevid and - secondary\_in, then compare whether the payload of primary packet - and secondary packet are the same. If same, it will output - primary packet to out\_dev, else it will notify COLO-framework to = do - checkpoint and send primary packet to out\_dev. In order to - improve efficiency, we need to put the task of comparison in - another iothread. If it has the vnet\_hdr\_support flag, - colo compare will send/recv packet with vnet\_hdr\_len. - The compare\_timeout=3D@var{ms} determines the maximum time of the - colo-compare hold the packet. The expired\_scan\_cycle=3D@var{ms} - is to set the period of scanning expired primary node network pack= ets. - The max\_queue\_size=3D@var{size} is to set the max compare queue - size depend on user environment. - If user want to use Xen COLO, need to add the notify\_dev to - notify Xen colo-frame to do checkpoint. + ``-object colo-compare,id=3D,primary_in=3D,secondary_in= =3D,outdev=3D,iothread=3D[,vnet_hdr_support][,not= ify_dev=3D][,compare_timeout=3D][,expired_scan_cycle=3D][,max_queue_size=3D]`` + Colo-compare gets packets from the chardev backends specified by + ``primary_in`` and ``secondary_in``, and compares whether the payl= oads + of the primary packet and the secondary packet are the same. + If they match, it will output the primary packet to the chardev + backend specified by ``outdev``; otherwise it will notify COLO-fra= mework + to do a checkpoint and send the primary packet to ``outdev``. + + In order to improve efficiency, we need to put the task of compari= son in + another iothread; the ``iothread`` option specifies that iothread = object + (which your commandline should create). + + The ``vnet_hdr_support`` flag tells + colo compare to pass the vnet header length when it sends and rece= ives packets. + + The ``compare_timeout`` option sets the maximum time that + colo-compare will hold the packet for, in ms. + + The ``expired_scan_cycle`` option sets the period of scanning expi= red + primary node network packets, in ms. + + The ``max_queue_size`` option sets the max compare queue size. + + If you want to use Xen COLO, you need to specify ``notify_dev`` to + tell colo-compare how to notify Xen colo-frame to do a checkpoint. =20 COLO-compare must be used with the help of filter-mirror, filter-redirector and filter-rewriter. --=20 2.47.3