From patchwork Mon Aug 2 11:57:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413733 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8C2D1C4320A for ; Mon, 2 Aug 2021 11:59:29 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 36AA360EBC for ; Mon, 2 Aug 2021 11:59:29 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 36AA360EBC Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:44474 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWbQ-0002nl-CL for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 07:59:28 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49830) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaH-0000G7-Gh for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:17 -0400 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:35763) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaF-0003Xi-T3 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:17 -0400 Received: by mail-wr1-x435.google.com with SMTP id n12so21182306wrr.2 for ; Mon, 02 Aug 2021 04:58:15 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=SI/Yhp0mK4jAlx2Z9SWd6mts9nvU3MwCROGAVFLjxyI=; b=q17p82xd39tFBerYd2v6GgKbgXxS7u4k4GeXLK886+nmtPC+U//BEFqAWee+H9Yi0d D+ZqGzNsU+Hdj8nrHj29qBGJaDDGGeuMuyRE4N8VmvN5Bu7YSkue12RA21e5a4bGQRuA PEmwNTZ3C/n0dZoioTRk6RyQ0sVjwgbrllsKJvM3WNPK11DE2SwiYroxed0uN1hwckve gQYbKTu8FaW/yQYC/HcnisPFaSmlUYkDeNhM64ZIBNHM+KFBO+E7fOzg2fSyjoHcFd/t LHiNz715d1PqV5nY/K+HvxB08XrYglstvTsO11/1MwfeJGjQbsp9/ySc7J0qr9m5XKmF b8Sg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=SI/Yhp0mK4jAlx2Z9SWd6mts9nvU3MwCROGAVFLjxyI=; b=b9y4wKGvBXD0LPuourRkF9Ck/tWbWoQTqQq1YRNjSWabC1ssQGOj2UPzMXR8jwLwMX p+oRMhIM+y8Yjv0Z/HCFb3Y1bEaICHH1G+G1tA3BJ8v2zln9VIUCBKBikXl/fTC6bTfb 06CM/yEGT8A9mzBT3LW7fLLW9G+bSEYQUxJbj6Dqqlnb8BTUe3ZVtilK3GK106xEytf8 ahHxjFCrdTLsXEk0hHRzltFhifBEFwAOe6y9q8q0xOP+NFiORGnruTsgRIUpZ+khQQHz PGSyp1M+F8MZiBAS1CJcGnCcA/HeEQ/Hd/VOdg2S5eoByH7x4TWjmCR07/szD7P2tK5J +PsA== X-Gm-Message-State: AOAM533xVmQcDDX1sLqMzIDZYV8a59c6J4/7ZAoBi7X9swemD3NzpLRq S4uQJVm7BiBVmLXUmtHchnFn420Q2VvUUQ== X-Google-Smtp-Source: ABdhPJykvJvR6NxjohGpZ9WZQEzN8uKM+nSdrYHZDViJudrNG+OwtknBtph3snxxAVO5HrGdc3TDTw== X-Received: by 2002:adf:d4cd:: with SMTP id w13mr16959299wrk.355.1627905494625; Mon, 02 Aug 2021 04:58:14 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.14 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:14 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 01/21] docs: Add documentation of Arm 'mainstone' board Date: Mon, 2 Aug 2021 12:57:52 +0100 Message-Id: <20210802115812.10731-2-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::435; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x435.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Add brief documentation of the Arm 'mainstone' board. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Message-id: 20210722175229.29065-2-peter.maydell@linaro.org --- docs/system/arm/mainstone.rst | 25 +++++++++++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 27 insertions(+) create mode 100644 docs/system/arm/mainstone.rst diff --git a/docs/system/arm/mainstone.rst b/docs/system/arm/mainstone.rst new file mode 100644 index 00000000000..05310f42c7f --- /dev/null +++ b/docs/system/arm/mainstone.rst @@ -0,0 +1,25 @@ +Intel Mainstone II board (``mainstone``) +======================================== + +The ``mainstone`` board emulates the Intel Mainstone II development +board, which uses a PXA270 CPU. + +Emulated devices: + +- Flash memory +- Keypad +- MMC controller +- 91C111 ethernet +- PIC +- Timer +- DMA +- GPIO +- FIR +- Serial +- LCD controller +- SSP +- USB controller +- RTC +- PCMCIA +- I2C +- I2S diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index c0c2585c0ad..ad3f5f435d6 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -90,6 +90,7 @@ undocumented; you can get a complete list by running arm/highbank arm/musicpal arm/gumstix + arm/mainstone arm/nrf arm/nseries arm/nuvoton diff --git a/MAINTAINERS b/MAINTAINERS index 6831978d2cd..24e0819bf8c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -856,6 +856,7 @@ F: include/hw/arm/pxa.h F: include/hw/arm/sharpsl.h F: include/hw/display/tc6393xb.h F: docs/system/arm/xscale.rst +F: docs/system/arm/mainstone.rst SABRELITE / i.MX6 M: Peter Maydell From patchwork Mon Aug 2 11:57:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413745 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 09250C4338F for ; Mon, 2 Aug 2021 12:02:59 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id C362760F70 for ; Mon, 2 Aug 2021 12:02:58 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org C362760F70 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:53060 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWen-0000Cd-7b for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:02:57 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49858) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaI-0000IX-K3 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:18 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:42933) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaG-0003Xp-RP for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:18 -0400 Received: by mail-wr1-x436.google.com with SMTP id j2so21113918wrx.9 for ; Mon, 02 Aug 2021 04:58:16 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=g8zSSxlwwOd/Ei3jqIbJDyuDbX9lwwum1BX0g/f66Ws=; b=w4ckBxSL38q5M7FgtkHo1Xf8+iOz4rzLnkMcRNRcJJzYUs5LZpUaCDwFEYT4JGR0Bx 6RXasL/i8EqXL8xvFNxRXW5aFpJU2H6TWkIpFuLyv7TvBOF2eKcRVkmGOMmPxA8NDkdU ZnGmLSW5mYC8mfuCdIzep8vYrZHdCZdXYAs2Dw/if5WIIezXSkbkvnsM63x8Pg0Kdveo 4/+LuZQFpGAr+sVaNJaT/sNwVnXtC3ufcWNezZVLwgLnUSDFE3+yTGGjlKhnnfvBVPMN g3oZ9asprnl0YUk9NPwEdVzPAtWVGjEGa46s2aO2186ayzzIH4s8GlLPIaIMn25KNM+2 KOrQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=g8zSSxlwwOd/Ei3jqIbJDyuDbX9lwwum1BX0g/f66Ws=; b=iKB/Ci5ta9T+wRMzDb7+HlHC9q6KDkiQlFS7FHES61oHjUnrwnnO2vP6U37XgIgoSN 6N7ti8DBlguY7JQaEVqYmmXzCnSgT1ppGhYXQt7GepNmBHKmMEZrSqMg+l4hkHxoSSAf vFK1tnetnMpm2ZfMmFUMkONb6j3M3iRGVH/0tSnasHdY7e1u/gnBDbqTnXF4nH9MSi3f 3ACNAEYQssdk+0np5MBG7BTqSKBN+uH7JhZObdJ16GLlV/iEnajSHp0FyEDkjVXRqW8J YKwdGrQNbk+RubmqZMimvHHNXor7piZaUT11KEaNbQADGA1nir+KuJKCNUdRGERtbUdx HyZg== X-Gm-Message-State: AOAM5334ayJ6LHD5jqq7hmfcPRyAfGWuQ3uxJPvkviCw9fMhAIAcMirc 3XTSJ6FF0frNm3dnU/JqvcoSCIAZRr8U5g== X-Google-Smtp-Source: ABdhPJxZz1eagYWXKVfziPriwOaXcO5WvxRBdsf15fKHRMACNQl+f/iH4FFRAgHatmqpdZFJBOpsRA== X-Received: by 2002:adf:d1e4:: with SMTP id g4mr3833593wrd.371.1627905495252; Mon, 02 Aug 2021 04:58:15 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.14 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:14 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 02/21] docs: Add documentation of Arm 'kzm' board Date: Mon, 2 Aug 2021 12:57:53 +0100 Message-Id: <20210802115812.10731-3-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::436; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x436.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Add brief documentation of the Arm 'kzm' board. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Message-id: 20210722175229.29065-3-peter.maydell@linaro.org --- docs/system/arm/kzm.rst | 18 ++++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 20 insertions(+) create mode 100644 docs/system/arm/kzm.rst diff --git a/docs/system/arm/kzm.rst b/docs/system/arm/kzm.rst new file mode 100644 index 00000000000..bb018fbdf7c --- /dev/null +++ b/docs/system/arm/kzm.rst @@ -0,0 +1,18 @@ +Kyoto Microcomputer KZM-ARM11-01 (``kzm``) +========================================== + +The ``kzm`` board emulates the Kyoto Microcomputer KZM-ARM11-01 +evaluation board, which is based on an NXP i.MX32 SoC +which uses an ARM1136 CPU. + +Emulated devices: + +- UARTs +- LAN9118 ethernet +- AVIC +- CCM +- GPT +- EPIT timers +- I2C +- GPIO controllers +- Watchdog timer diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index ad3f5f435d6..d423782d661 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -91,6 +91,7 @@ undocumented; you can get a complete list by running arm/musicpal arm/gumstix arm/mainstone + arm/kzm arm/nrf arm/nseries arm/nuvoton diff --git a/MAINTAINERS b/MAINTAINERS index 24e0819bf8c..6c558303f96 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -694,6 +694,7 @@ F: hw/*/imx_* F: hw/*/*imx31* F: include/hw/*/imx_* F: include/hw/*/*imx31* +F: docs/system/arm/kzm.rst Integrator CP M: Peter Maydell From patchwork Mon Aug 2 11:57:54 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413763 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 94986C4338F for ; Mon, 2 Aug 2021 12:06:21 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 3EC5460E97 for ; Mon, 2 Aug 2021 12:06:21 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 3EC5460E97 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:33374 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWi4-0005t0-81 for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:06:20 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49870) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaJ-0000JN-0F for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:19 -0400 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]:43742) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaH-0003YH-Fm for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:18 -0400 Received: by mail-wm1-x32c.google.com with SMTP id m20-20020a05600c4f54b029024e75a15716so10839406wmq.2 for ; Mon, 02 Aug 2021 04:58:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=K+43bwjBEMaP3/NNrT8H6mztjjaRqn0rPO+cVcTuedE=; b=U/7ClweBPYFLjoCana235PvBCSSD72l40KrymFU58aepy/xuelt5WFZlGWz7enG0Sj MTEs6EiPoYfLTgSOc7M4o4JiNJX/Gnazc1N2esQsRppHuEFGq/Zm4v3LDYmJEVUZS5Cw lAR0e7cdRzrteeXW4gctkv64m2TPzKqJIn9COtkEeVx6aCPQz9F+ezKMDYiwbh45h+vE gD96UyI0oxl7VnEVM79fXOmiJDc7Fp0Vn6prdUlBsfDJHjaOboeLFA2uUBIPQ5RUXOEl gs4MRKc2QLVcpvF2Yt7R1biQOV7n1mmupgnI7NVkNe4e/5JcNYmnHoOghbh2l6Xt8UQW 1+MQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=K+43bwjBEMaP3/NNrT8H6mztjjaRqn0rPO+cVcTuedE=; b=n17bjrVPgwT+aRbs3iU8ty+wHSXWelW7YenuoRVQX1V8+pm8DObi+tr2u4DwXPgU/N +FQ6YbgF/3kLuiwXwjomd8lwMMRyo5NSxueYocVKD3QHbekMcHW9W0oavxZ61pzBiutB 0daUVWFy+rZyRm5uPylDNJzwShS+kmEiukYKmQPCFNd2sn8qmOxqURpFvOTN6TMJfvUA gsNA3gX331D7BY1/oEhO1rHZPQQw3LbyAMVLxQqC7wR1SQAGTOSTdRCiQjODmFAsaMKx eZKiGAy6q8pj9UtSQEknhaCNhpvcZ+LgSPObr7NZLTjwmcsjfW8uP4iDPwwpc+mzetAf eIPw== X-Gm-Message-State: AOAM532btUkDyzL7M1LTvepewZIlUn64kHpwXjU3banNhYjN8qzbUZek mbcs/hogxZkUUG4w9OWwzAmhAUZ/Es5M3Q== X-Google-Smtp-Source: ABdhPJyVehG0bkYNL7u6E0PrOHYQ05njXeveL8w8N6oNg9n6JXHJDfzlmsV4uul45JSWVUYqaVwrVQ== X-Received: by 2002:a1c:1dcf:: with SMTP id d198mr16318723wmd.103.1627905495982; Mon, 02 Aug 2021 04:58:15 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.15 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:15 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 03/21] docs: Add documentation of Arm 'imx25-pdk' board Date: Mon, 2 Aug 2021 12:57:54 +0100 Message-Id: <20210802115812.10731-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Add brief documentation of the Arm 'imx25-pdk' board. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Message-id: 20210722175229.29065-4-peter.maydell@linaro.org --- docs/system/arm/imx25-pdk.rst | 19 +++++++++++++++++++ docs/system/target-arm.rst | 1 + MAINTAINERS | 1 + 3 files changed, 21 insertions(+) create mode 100644 docs/system/arm/imx25-pdk.rst diff --git a/docs/system/arm/imx25-pdk.rst b/docs/system/arm/imx25-pdk.rst new file mode 100644 index 00000000000..2a9711e8a79 --- /dev/null +++ b/docs/system/arm/imx25-pdk.rst @@ -0,0 +1,19 @@ +NXP i.MX25 PDK board (``imx25-pdk``) +==================================== + +The ``imx25-pdk`` board emulates the NXP i.MX25 Product Development Kit +board, which is based on an i.MX25 SoC which uses an ARM926 CPU. + +Emulated devices: + +- SD controller +- AVIC +- CCM +- GPT +- EPIT timers +- FEC +- RNGC +- I2C +- GPIO controllers +- Watchdog timer +- USB controllers diff --git a/docs/system/target-arm.rst b/docs/system/target-arm.rst index d423782d661..91ebc26c6db 100644 --- a/docs/system/target-arm.rst +++ b/docs/system/target-arm.rst @@ -95,6 +95,7 @@ undocumented; you can get a complete list by running arm/nrf arm/nseries arm/nuvoton + arm/imx25-pdk arm/orangepi arm/palm arm/raspi diff --git a/MAINTAINERS b/MAINTAINERS index 6c558303f96..bda08356d46 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -684,6 +684,7 @@ F: hw/watchdog/wdt_imx2.c F: include/hw/arm/fsl-imx25.h F: include/hw/misc/imx25_ccm.h F: include/hw/watchdog/wdt_imx2.h +F: docs/system/arm/imx25-pdk.rst i.MX31 (kzm) M: Peter Maydell From patchwork Mon Aug 2 11:57:55 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413747 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 5A42DC4338F for ; Mon, 2 Aug 2021 12:03:10 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 1426E60F70 for ; Mon, 2 Aug 2021 12:03:10 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 1426E60F70 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:53104 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWez-0000Dz-90 for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:03:09 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49886) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaJ-0000Kr-Fv for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:19 -0400 Received: from mail-wm1-x32e.google.com ([2a00:1450:4864:20::32e]:43744) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaH-0003YQ-Tz for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:19 -0400 Received: by mail-wm1-x32e.google.com with SMTP id m20-20020a05600c4f54b029024e75a15716so10839424wmq.2 for ; Mon, 02 Aug 2021 04:58:17 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=YZEAZ8C/Pl2yg429OjaxJSx9EOz84JN+Qm8dDccl3Ms=; b=Irz4OFsojbhxLzThid+SKbF3G8qjpKc7nYpEYgVh89X3EX9Eh3Wb9Kyma7XS2wYJ/6 Eft9qZFCEe3eqWrjecwbsnOirqd4Fg/2w8qA0H3OG/BQFxhf4F4/DVtJdqix+G1Bz7ZB YxrxGFEOhbH3UJiZYbMtCNTWfxbP2YkXDQLEt4wdIdDKh8cNK73udWNu8X5S9swMSR1e UWNtFNGjtyeoX98483Kkfp9ho8ZX3GS4hWJ54bVGifiHfJvgByDupTHA8bJigRPJoWXn kLb35Z0F2CQh19nYJR9fbSNTb70nQZJUCayVDkjhOYt7fX4q93/cB0nbePXLpXLwpUnD mp0g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=YZEAZ8C/Pl2yg429OjaxJSx9EOz84JN+Qm8dDccl3Ms=; b=emk8314fdYiE0nXWG1r0rdWfmvk48EgNNKuBfuQz/A+Hm4hIX9b/3bj7zUqdSNtpLF qixZzc0sgPO7W3cPo8nB0l3t19+KcnCLRSlDmdIjgYQ0iyXL5TlnU5yBAWuiIlku4cAA EohrZ961llD+YB7KELn9D+KJmLpXAeyhIwkZsOB3FfKvYTyI+P+Iw9ZXwTnkSBsWZFeK mAiDIJzGg/ztesBDMTF5UEfMi36VgtYLVVx7u0/M4bUWTQRhJ9zJV6a9lTnZfcnP9hyb Xf073m8lSo27VoeU83K6jNdAQ4gHRCQDqyVC4tsBgG9DP8uiAS+2v1mRnOhRUiVN0c/f 6S9Q== X-Gm-Message-State: AOAM5326yM8yU4K1lskOmaN9iZ+Cjp+b/ahO4JS8qQjuu4NCVNvzCNEm AR/E9IAy1GD2467Au3mJxWsgj7o5gHppEA== X-Google-Smtp-Source: ABdhPJzsk9PURc4DYSy6ojQSWTwb24on3dlMKjzFXNZDheuXg1FTtPg4ZOAk+jJbU+XTJ9tyb+Jh9A== X-Received: by 2002:a7b:cb53:: with SMTP id v19mr15989592wmj.127.1627905496640; Mon, 02 Aug 2021 04:58:16 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.16 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:16 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 04/21] MAINTAINERS: Don't list Andrzej Zaborowski for various components Date: Mon, 2 Aug 2021 12:57:55 +0100 Message-Id: <20210802115812.10731-5-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32e; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32e.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Andrzej Zaborowski is listed as an "Odd Fixes" maintainer for the nSeries, Palm and PXA2XX boards, as well as the "Maintained" status Arm 32-bit TCG backend. Andrzej's last email to qemu-devel was back in 2017, and the email before that was all the way back in 2013. We don't really need to fill his email up with CCs on QEMU patches any more... Remove Andrzej from the various boards sections (leaving them still Odd Fixes with me as the backup patch reviewer). Add Richard Henderson as the maintainer for the Arm TCG backend, since removing Andrzej would otherwise leave that section with no M: line at all. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Message-id: 20210722180951.29802-1-peter.maydell@linaro.org --- MAINTAINERS | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/MAINTAINERS b/MAINTAINERS index bda08356d46..37b1a8e4428 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -788,7 +788,6 @@ F: roms/vbootrom F: docs/system/arm/nuvoton.rst nSeries -M: Andrzej Zaborowski M: Peter Maydell L: qemu-arm@nongnu.org S: Odd Fixes @@ -806,7 +805,6 @@ F: tests/acceptance/machine_arm_n8x0.py F: docs/system/arm/nseries.rst Palm -M: Andrzej Zaborowski M: Peter Maydell L: qemu-arm@nongnu.org S: Odd Fixes @@ -839,7 +837,6 @@ F: include/hw/intc/realview_gic.h F: docs/system/arm/realview.rst PXA2XX -M: Andrzej Zaborowski M: Peter Maydell L: qemu-arm@nongnu.org S: Odd Fixes @@ -3043,7 +3040,7 @@ F: disas/arm-a64.cc F: disas/libvixl/ ARM TCG target -M: Andrzej Zaborowski +M: Richard Henderson S: Maintained L: qemu-arm@nongnu.org F: tcg/arm/ From patchwork Mon Aug 2 11:57:56 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413765 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 60CDCC432BE for ; Mon, 2 Aug 2021 12:06:22 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 0F81F60E97 for ; Mon, 2 Aug 2021 12:06:22 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0F81F60E97 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:33350 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWi5-0005sF-30 for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:06:21 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49898) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaK-0000MZ-21 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:20 -0400 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:34327) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaI-0003ZI-Jk for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:19 -0400 Received: by mail-wr1-x434.google.com with SMTP id h13so7694187wrp.1 for ; Mon, 02 Aug 2021 04:58:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=dYWzxaEjFe3WsD8kw53uK4SvN3H1WbPYqZcSOzz5hJc=; b=qOpf7rm1HPj/uOEOwbKgvTSktlpiPVjimLwm5Dkost258OK61rKIAi1TuaYu1ehzqw 4ZZaHItYLX4YCNPgswNI7mzo72T5FVC7nnkYoz+Qsn2Ugl2HDJF+nxODOV4I+MfymEMk RtdyCPcLQvjQfUX4cPJKITq88YSWuS4AD4klqSp7GltTB4+Kv21gTtCH2oYWhmgfBMdu b6vwsTmyjflmjQGjljxKktaKB+L83fFq42fsbJpv2W85vqnsZS9hz5aWCbqBFYM+Y5qz TTyFSfHDtMhJQuogKVjpfLkKwJSdChvgHXfiGzkCxWwRwXEUJuH9ZOS9HpAJoRaD4ReQ Lmew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=dYWzxaEjFe3WsD8kw53uK4SvN3H1WbPYqZcSOzz5hJc=; b=hrNPJhxPQYOR4eQl0Qxx6uZgQGypqoJqEXcIWEOI76cBng0Iqg2znEvaLqs0R9xOhs +IJR/a95TpLSed4w4levh1X4F7RmnKxLdTFuUcyHJIPD+1iVIEmGXzYICPk9hKFYWhq8 VRb0l1Sor72hLEvOSXvOLT9abjm5SeTGX9nrD4NSR7AoLNje+1oVkK6TXaBI8VdLbYvm +YNESN3486aL7e0LAJ+z0bkS3RFS96RUdW3bhvgVy6r2+h4Z6TnylTFkZGFNtYBtBMth N4rddunI1KEh1Xks3DKgctizdTIlUtKcywCwiuUECR1RttGUHfikl3Tml9yGWzFiIT8Q OTEg== X-Gm-Message-State: AOAM532/RUxTMpmSdCk4hj2Q/2WO6+49PBJ3XkGiLc3n1J9i4hvJnont bSQoCa5JbGY3qnK8CY3zHYtLpuq2aJoH3g== X-Google-Smtp-Source: ABdhPJxDQrQywMce4vHHtp42hA2dOG8QV2bm05iO106kMcGk3rTbYmttBQ9X9gjrRB2EXU0mNU6THw== X-Received: by 2002:adf:c549:: with SMTP id s9mr17318115wrf.344.1627905497217; Mon, 02 Aug 2021 04:58:17 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.16 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:16 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 05/21] docs: Remove stale TODO comments about license and version Date: Mon, 2 Aug 2021 12:57:56 +0100 Message-Id: <20210802115812.10731-6-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::434; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x434.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Since commits 13f934e79fa and 3a50c8f3067aaf, our HTML docs include a footer to all pages stating the license and version. We can therefore delete the TODO comments suggesting we should do that from our .rst files. Signed-off-by: Peter Maydell Reviewed-by: Marc-André Lureau Reviewed-by: Cleber Rosa Reviewed-by: Markus Armbruster Message-id: 20210722192016.24915-2-peter.maydell@linaro.org --- docs/interop/qemu-ga-ref.rst | 9 --------- docs/interop/qemu-qmp-ref.rst | 9 --------- docs/interop/qemu-storage-daemon-qmp-ref.rst | 9 --------- 3 files changed, 27 deletions(-) diff --git a/docs/interop/qemu-ga-ref.rst b/docs/interop/qemu-ga-ref.rst index db1e9461249..032d4924552 100644 --- a/docs/interop/qemu-ga-ref.rst +++ b/docs/interop/qemu-ga-ref.rst @@ -1,15 +1,6 @@ QEMU Guest Agent Protocol Reference =================================== -.. - TODO: the old Texinfo manual used to note that this manual - is GPL-v2-or-later. We should make that reader-visible - both here and in our Sphinx manuals more generally. - -.. - TODO: display the QEMU version, both here and in our Sphinx manuals - more generally. - .. contents:: :depth: 3 diff --git a/docs/interop/qemu-qmp-ref.rst b/docs/interop/qemu-qmp-ref.rst index b5bebf6b9a9..357effd64f3 100644 --- a/docs/interop/qemu-qmp-ref.rst +++ b/docs/interop/qemu-qmp-ref.rst @@ -1,15 +1,6 @@ QEMU QMP Reference Manual ========================= -.. - TODO: the old Texinfo manual used to note that this manual - is GPL-v2-or-later. We should make that reader-visible - both here and in our Sphinx manuals more generally. - -.. - TODO: display the QEMU version, both here and in our Sphinx manuals - more generally. - .. contents:: :depth: 3 diff --git a/docs/interop/qemu-storage-daemon-qmp-ref.rst b/docs/interop/qemu-storage-daemon-qmp-ref.rst index d0ebb42ebd5..9fed68152f5 100644 --- a/docs/interop/qemu-storage-daemon-qmp-ref.rst +++ b/docs/interop/qemu-storage-daemon-qmp-ref.rst @@ -1,15 +1,6 @@ QEMU Storage Daemon QMP Reference Manual ======================================== -.. - TODO: the old Texinfo manual used to note that this manual - is GPL-v2-or-later. We should make that reader-visible - both here and in our Sphinx manuals more generally. - -.. - TODO: display the QEMU version, both here and in our Sphinx manuals - more generally. - .. contents:: :depth: 3 From patchwork Mon Aug 2 11:57:57 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413771 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BF74BC4338F for ; Mon, 2 Aug 2021 12:08:53 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 84CF360EFD for ; Mon, 2 Aug 2021 12:08:53 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 84CF360EFD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:41110 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWkW-0002oy-PG for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:08:52 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49900) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaK-0000Nl-Go for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:20 -0400 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]:52037) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaJ-0003ZO-1L for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:20 -0400 Received: by mail-wm1-x32c.google.com with SMTP id u15so10252544wmj.1 for ; Mon, 02 Aug 2021 04:58:18 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=x8RJzHi+/BlMs3RtR+24I7t54meXItlsIyK745HJ9J0=; b=MpuFau0Qn8ySebK8aZFb+bdSBN1+EFeZkg8tUGLAzEZ8Sax9VdiUyXGmiJ6Eo8eluD MNVQScQ0JFaEHSSkaSAhXD0CAKrky0qIKqH10JqAYCXXcXD+rYanBCN6FHU5KbAOnrrq yZxhIDxCPHM2T9GfUQGOK1b7jEPC8a6TB8TbeQfscB3IbxAGIiAne32XANi508EeUHMK 5I3G3f10kiAyJR81kRZvEPe27AxTfEJCp1hwGlFn8R2E5iB3Dhd/drfzIEGVgqZcuqj8 8tFE5/oUsY7mQzkM/Yuc+deOHwK1Oo3MPAFjyFd5KjbgEo7AU5eUwqp+noOnPbnFTamI Brew== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=x8RJzHi+/BlMs3RtR+24I7t54meXItlsIyK745HJ9J0=; b=cvHDufRNEVm0+cKeSXAUBMmCqPxeyb80Y9l+NO2GzlHZcceNdgW+DqerUpurhc936y saBYPQWAwnNRJkUFhVubrXa5hdQv+5CE65fsb74nEENmhpppEo9OM20ru8P57pAKE8ee IsBzD1ZwDHsaz4thOmj2mN9xXnc+fxil2J967fAIuwYbYLrG+o5Ll6uezZBPMDCO7eH2 WXgF6+H4b4YSmwFLrNBaX0yP3aKDfwMbq5F9Ztt8wCeh8WZxJ3ExA77WzExmPfjpT7AE iknBLiKkH5PPaT5rnQV2oVwoUZglTFRzCCtmRzWQfYRoi+UEJ4E4Gar/1pTA/oRf/D1J eLBQ== X-Gm-Message-State: AOAM531AiGrpsfimNA884gfLLPmvJKp9ZQhUhPCamPv/z/Im8fhk0cWJ RRZl3K39ERuSvc43ADupfCAQDunR9NxGSA== X-Google-Smtp-Source: ABdhPJzstM26D4hu/yuSn6HCL601TcheDO2ALt5YkP0AtWm7OhW8MUHmBDGMeAGyqgULPnHotIQYew== X-Received: by 2002:a05:600c:4e87:: with SMTP id f7mr14890355wmq.121.1627905497835; Mon, 02 Aug 2021 04:58:17 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.17 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:17 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 06/21] docs: Move licence/copyright from HTML output to rST comments Date: Mon, 2 Aug 2021 12:57:57 +0100 Message-Id: <20210802115812.10731-7-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Our built HTML documentation now has a standard footer which gives the license for QEMU (and its documentation as a whole). In almost all pages, we either don't bother to state the copyright/license for the individual rST sources, or we put it in an rST comment. There are just three pages which render copyright or license information into the user-visible HTML. Quoting a specific (different) license for an individual HTML page within the manual is confusing. Downgrade the license and copyright info to a comment within the rST source, bringing these pages in line with the rest of our documents. Suggested-by: Markus Armbruster Signed-off-by: Peter Maydell Reviewed-by: Marc-André Lureau Reviewed-by: Cleber Rosa Reviewed-by: Markus Armbruster Acked-by: Michael S. Tsirkin Message-id: 20210722192016.24915-3-peter.maydell@linaro.org --- docs/interop/vhost-user-gpu.rst | 7 ++++--- docs/interop/vhost-user.rst | 12 +++++++----- docs/system/generic-loader.rst | 4 ++-- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/interop/vhost-user-gpu.rst b/docs/interop/vhost-user-gpu.rst index 3268bf405ce..71a2c52b313 100644 --- a/docs/interop/vhost-user-gpu.rst +++ b/docs/interop/vhost-user-gpu.rst @@ -2,9 +2,10 @@ Vhost-user-gpu Protocol ======================= -:Licence: This work is licensed under the terms of the GNU GPL, - version 2 or later. See the COPYING file in the top-level - directory. +.. + Licence: This work is licensed under the terms of the GNU GPL, + version 2 or later. See the COPYING file in the top-level + directory. .. contents:: Table of Contents diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst index 7fc693521e5..edc3ad84a35 100644 --- a/docs/interop/vhost-user.rst +++ b/docs/interop/vhost-user.rst @@ -3,11 +3,13 @@ =================== Vhost-user Protocol =================== -:Copyright: 2014 Virtual Open Systems Sarl. -:Copyright: 2019 Intel Corporation -:Licence: This work is licensed under the terms of the GNU GPL, - version 2 or later. See the COPYING file in the top-level - directory. + +.. + Copyright 2014 Virtual Open Systems Sarl. + Copyright 2019 Intel Corporation + Licence: This work is licensed under the terms of the GNU GPL, + version 2 or later. See the COPYING file in the top-level + directory. .. contents:: Table of Contents diff --git a/docs/system/generic-loader.rst b/docs/system/generic-loader.rst index 531ddbc8e34..4f9fb005f1d 100644 --- a/docs/system/generic-loader.rst +++ b/docs/system/generic-loader.rst @@ -1,8 +1,8 @@ .. Copyright (c) 2016, Xilinx Inc. -This work is licensed under the terms of the GNU GPL, version 2 or later. See -the COPYING file in the top-level directory. + This work is licensed under the terms of the GNU GPL, version 2 or later. See + the COPYING file in the top-level directory. Generic Loader -------------- From patchwork Mon Aug 2 11:57:58 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413803 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id F2850C4338F for ; Mon, 2 Aug 2021 12:10:38 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 63A7861029 for ; Mon, 2 Aug 2021 12:10:38 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 63A7861029 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:47608 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWmD-0007Pr-Hx for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:10:37 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49948) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaN-0000VF-7k for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:23 -0400 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]:40634) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaK-0003a0-HL for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:23 -0400 Received: by mail-wm1-x329.google.com with SMTP id k38-20020a05600c1ca6b029025af5e0f38bso2474114wms.5 for ; Mon, 02 Aug 2021 04:58:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=woZjiPKWnfTmaS1CIBKdYSxYIOPWZm8+wKl63I+SP1w=; b=hJaG4qY7zb6en8+WLdfWv9HFlIUTspLeMlLm1jswDPyQm4Qdlf+3//xhinKW0ZnISo GS1uSccR1OQK955+sszuhl1qOZoaEVbPPm/tSC0FPjFhYa83T3/StXTS2SJa9ae8F2R8 eu9+BeeAqNByG7f4ylUoOXmiFyZNoDnxGh61nI8hNgKKpHTJy5CLc1pFdILocCWpQaP4 Ft7jgiRPfQ2BlDHvv+gnhaFQYlIC2fRiyoVflE7wA/c2NdH4xV3sE+LTgc1ZxdSptgtO sU8TQprHA1vERnmQ0jPELPaAlO7Y3MFQvSs+wS1GgpzokibW2wQRMpMCQ847KQC8cghX JRkg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=woZjiPKWnfTmaS1CIBKdYSxYIOPWZm8+wKl63I+SP1w=; b=iQXxka/XsPA6HeDTU/RUSxH0ahExtIZ7euHuzWfmb551Mm7l0b5A/urXX+bayy7qis gfVlYWBdqQAO3WBx0LnYe/0DYRaTk7a9LOyaVycYwhETuQAAZ9rfqCSPMx/rvPqsHXNr l0EV+v4MLZIA++6JCLZ9ehloBvCjDnR5JqTGAA35akvFt30Qn8rLnaywSAYCFv6i4Yxv B2Rxw7dDTAyIt7Z1GgnaqhKTwGdoNzg/dmFMBf5UKcXOMgb2gjQL+S9MTcfknlLNfxlP BdKQecrFMDFQVH3U5EAhwnCMeQdxdCcvPM4EkYjKKgVAshpYQZMEB1TDkLiwwjJk3pAx b6PA== X-Gm-Message-State: AOAM531RIfv8Bt9e8QTy66QvhcoPA3Z1bd6Vdv/JVDXkt/S5PfAYewic EXJHGgrYWCNaOgKvqfoXqClGdXutCFav7g== X-Google-Smtp-Source: ABdhPJxvdYTUBkOW3+K9e7tLwpnzhDkqn3dgiGuDIDwmq2A+lkFrr2Yj9D1DN4dMPgDQzHDjzca5uw== X-Received: by 2002:a05:600c:896:: with SMTP id l22mr6668888wmp.68.1627905498815; Mon, 02 Aug 2021 04:58:18 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.17 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:18 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 07/21] docs/devel/build-system.rst: Format literals correctly Date: Mon, 2 Aug 2021 12:57:58 +0100 Message-Id: <20210802115812.10731-8-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). build-system.rst seems to have been written under the mistaken assumption that single-backticks mark up literal text (function names, etc) which should be rendered in a fixed-width font. The rST markup for this is ``double backticks``. Update all the markup. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Message-id: 20210726142338.31872-2-peter.maydell@linaro.org --- docs/devel/build-system.rst | 156 ++++++++++++++++++------------------ 1 file changed, 78 insertions(+), 78 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index fd1650442ec..ee660a998d0 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -53,14 +53,14 @@ following tasks: - Add a Meson build option to meson_options.txt. - Add support to the command line arg parser to handle any new - `--enable-XXX`/`--disable-XXX` flags required by the feature. + ``--enable-XXX``/``--disable-XXX`` flags required by the feature. - Add information to the help output message to report on the new feature flag. - Add code to perform the actual feature check. - - Add code to include the feature status in `config-host.h` + - Add code to include the feature status in ``config-host.h`` - Add code to print out the feature status in the configure summary upon completion. @@ -116,51 +116,51 @@ Helper functions The configure script provides a variety of helper functions to assist developers in checking for system features: -`do_cc $ARGS...` +``do_cc $ARGS...`` Attempt to run the system C compiler passing it $ARGS... -`do_cxx $ARGS...` +``do_cxx $ARGS...`` Attempt to run the system C++ compiler passing it $ARGS... -`compile_object $CFLAGS` +``compile_object $CFLAGS`` Attempt to compile a test program with the system C compiler using $CFLAGS. The test program must have been previously written to a file - called $TMPC. The replacement in Meson is the compiler object `cc`, - which has methods such as `cc.compiles()`, - `cc.check_header()`, `cc.has_function()`. + called $TMPC. The replacement in Meson is the compiler object ``cc``, + which has methods such as ``cc.compiles()``, + ``cc.check_header()``, ``cc.has_function()``. -`compile_prog $CFLAGS $LDFLAGS` +``compile_prog $CFLAGS $LDFLAGS`` Attempt to compile a test program with the system C compiler using $CFLAGS and link it with the system linker using $LDFLAGS. The test program must have been previously written to a file called $TMPC. - The replacement in Meson is `cc.find_library()` and `cc.links()`. + The replacement in Meson is ``cc.find_library()`` and ``cc.links()``. -`has $COMMAND` +``has $COMMAND`` Determine if $COMMAND exists in the current environment, either as a shell builtin, or executable binary, returning 0 on success. The - replacement in Meson is `find_program()`. + replacement in Meson is ``find_program()``. -`check_define $NAME` +``check_define $NAME`` Determine if the macro $NAME is defined by the system C compiler -`check_include $NAME` +``check_include $NAME`` Determine if the include $NAME file is available to the system C - compiler. The replacement in Meson is `cc.has_header()`. + compiler. The replacement in Meson is ``cc.has_header()``. -`write_c_skeleton` +``write_c_skeleton`` Write a minimal C program main() function to the temporary file indicated by $TMPC -`feature_not_found $NAME $REMEDY` +``feature_not_found $NAME $REMEDY`` Print a message to stderr that the feature $NAME was not available on the system, suggesting the user try $REMEDY to address the problem. -`error_exit $MESSAGE $MORE...` +``error_exit $MESSAGE $MORE...`` Print $MESSAGE to stderr, followed by $MORE... and then exit from the configure script with non-zero status -`query_pkg_config $ARGS...` +``query_pkg_config $ARGS...`` Run pkg-config passing it $ARGS. If QEMU is doing a static build, then --static will be automatically added to $ARGS @@ -187,7 +187,7 @@ process for: 4) other data files, such as icons or desktop files -All executables are built by default, except for some `contrib/` +All executables are built by default, except for some ``contrib/`` binaries that are known to fail to build on some platforms (for example 32-bit or big-endian platforms). Tests are also built by default, though that might change in the future. @@ -195,14 +195,14 @@ though that might change in the future. The source code is highly modularized, split across many files to facilitate building of all of these components with as little duplicated compilation as possible. Using the Meson "sourceset" functionality, -`meson.build` files group the source files in rules that are +``meson.build`` files group the source files in rules that are enabled according to the available system libraries and to various configuration symbols. Sourcesets belong to one of four groups: Subsystem sourcesets: Various subsystems that are common to both tools and emulators have - their own sourceset, for example `block_ss` for the block device subsystem, - `chardev_ss` for the character device subsystem, etc. These sourcesets + their own sourceset, for example ``block_ss`` for the block device subsystem, + ``chardev_ss`` for the character device subsystem, etc. These sourcesets are then turned into static libraries as follows:: libchardev = static_library('chardev', chardev_ss.sources(), @@ -211,8 +211,8 @@ Subsystem sourcesets: chardev = declare_dependency(link_whole: libchardev) - As of Meson 0.55.1, the special `.fa` suffix should be used for everything - that is used with `link_whole`, to ensure that the link flags are placed + As of Meson 0.55.1, the special ``.fa`` suffix should be used for everything + that is used with ``link_whole``, to ensure that the link flags are placed correctly in the command line. Target-independent emulator sourcesets: @@ -221,16 +221,16 @@ Target-independent emulator sourcesets: This includes error handling infrastructure, standard data structures, platform portability wrapper functions, etc. - Target-independent code lives in the `common_ss`, `softmmu_ss` and - `user_ss` sourcesets. `common_ss` is linked into all emulators, - `softmmu_ss` only in system emulators, `user_ss` only in user-mode + Target-independent code lives in the ``common_ss``, ``softmmu_ss`` and + ``user_ss`` sourcesets. ``common_ss`` is linked into all emulators, + ``softmmu_ss`` only in system emulators, ``user_ss`` only in user-mode emulators. Target-independent sourcesets must exercise particular care when using - `if_false` rules. The `if_false` rule will be used correctly when linking + ``if_false`` rules. The ``if_false`` rule will be used correctly when linking emulator binaries; however, when *compiling* target-independent files - into .o files, Meson may need to pick *both* the `if_true` and - `if_false` sides to cater for targets that want either side. To + into .o files, Meson may need to pick *both* the ``if_true`` and + ``if_false`` sides to cater for targets that want either side. To achieve that, you can add a special rule using the ``CONFIG_ALL`` symbol:: @@ -245,14 +245,14 @@ Target-dependent emulator sourcesets: In the target-dependent set lives CPU emulation, some device emulation and much glue code. This sometimes also has to be compiled multiple times, once for each target being built. Target-dependent files are included - in the `specific_ss` sourceset. + in the ``specific_ss`` sourceset. - Each emulator also includes sources for files in the `hw/` and `target/` + Each emulator also includes sources for files in the ``hw/`` and ``target/`` subdirectories. The subdirectory used for each emulator comes from the target's definition of ``TARGET_BASE_ARCH`` or (if missing) - ``TARGET_ARCH``, as found in `default-configs/targets/*.mak`. + ``TARGET_ARCH``, as found in ``default-configs/targets/*.mak``. - Each subdirectory in `hw/` adds one sourceset to the `hw_arch` dictionary, + Each subdirectory in ``hw/`` adds one sourceset to the ``hw_arch`` dictionary, for example:: arm_ss = ss.source_set() @@ -262,8 +262,8 @@ Target-dependent emulator sourcesets: The sourceset is only used for system emulators. - Each subdirectory in `target/` instead should add one sourceset to each - of the `target_arch` and `target_softmmu_arch`, which are used respectively + Each subdirectory in ``target/`` instead should add one sourceset to each + of the ``target_arch`` and ``target_softmmu_arch``, which are used respectively for all emulators and for system emulators only. For example:: arm_ss = ss.source_set() @@ -273,11 +273,11 @@ Target-dependent emulator sourcesets: target_softmmu_arch += {'arm': arm_softmmu_ss} Module sourcesets: - There are two dictionaries for modules: `modules` is used for - target-independent modules and `target_modules` is used for - target-dependent modules. When modules are disabled the `module` - source sets are added to `softmmu_ss` and the `target_modules` - source sets are added to `specific_ss`. + There are two dictionaries for modules: ``modules`` is used for + target-independent modules and ``target_modules`` is used for + target-dependent modules. When modules are disabled the ``module`` + source sets are added to ``softmmu_ss`` and the ``target_modules`` + source sets are added to ``specific_ss``. Both dictionaries are nested. One dictionary is created per subdirectory, and these per-subdirectory dictionaries are added to @@ -290,15 +290,15 @@ Module sourcesets: modules += { 'hw-display': hw_display_modules } Utility sourcesets: - All binaries link with a static library `libqemuutil.a`. This library + All binaries link with a static library ``libqemuutil.a``. This library is built from several sourcesets; most of them however host generated - code, and the only two of general interest are `util_ss` and `stub_ss`. + code, and the only two of general interest are ``util_ss`` and ``stub_ss``. The separation between these two is purely for documentation purposes. - `util_ss` contains generic utility files. Even though this code is only + ``util_ss`` contains generic utility files. Even though this code is only linked in some binaries, sometimes it requires hooks only in some of these and depend on other functions that are not fully implemented by - all QEMU binaries. `stub_ss` links dummy stubs that will only be linked + all QEMU binaries. ``stub_ss`` links dummy stubs that will only be linked into the binary if the real implementation is not present. In a way, the stubs can be thought of as a portable implementation of the weak symbols concept. @@ -307,8 +307,8 @@ Utility sourcesets: The following files concur in the definition of which files are linked into each emulator: -`default-configs/devices/*.mak` - The files under `default-configs/devices/` control the boards and devices +``default-configs/devices/*.mak`` + The files under ``default-configs/devices/`` control the boards and devices that are built into each QEMU system emulation targets. They merely contain a list of config variable definitions such as:: @@ -316,18 +316,18 @@ into each emulator: CONFIG_XLNX_ZYNQMP_ARM=y CONFIG_XLNX_VERSAL=y -`*/Kconfig` - These files are processed together with `default-configs/devices/*.mak` and +``*/Kconfig`` + These files are processed together with ``default-configs/devices/*.mak`` and describe the dependencies between various features, subsystems and device models. They are described in :ref:`kconfig` -`default-configs/targets/*.mak` - These files mostly define symbols that appear in the `*-config-target.h` +``default-configs/targets/*.mak`` + These files mostly define symbols that appear in the ``*-config-target.h`` file for each emulator [#cfgtarget]_. However, the ``TARGET_ARCH`` - and ``TARGET_BASE_ARCH`` will also be used to select the `hw/` and - `target/` subdirectories that are compiled into each target. + and ``TARGET_BASE_ARCH`` will also be used to select the ``hw/`` and + ``target/`` subdirectories that are compiled into each target. -.. [#cfgtarget] This header is included by `qemu/osdep.h` when +.. [#cfgtarget] This header is included by ``qemu/osdep.h`` when compiling files from the target-specific sourcesets. These files rarely need changing unless you are adding a completely @@ -339,19 +339,19 @@ Support scripts --------------- Meson has a special convention for invoking Python scripts: if their -first line is `#! /usr/bin/env python3` and the file is *not* executable, +first line is ``#! /usr/bin/env python3`` and the file is *not* executable, find_program() arranges to invoke the script under the same Python interpreter that was used to invoke Meson. This is the most common and preferred way to invoke support scripts from Meson build files, because it automatically uses the value of configure's --python= option. -In case the script is not written in Python, use a `#! /usr/bin/env ...` +In case the script is not written in Python, use a ``#! /usr/bin/env ...`` line and make the script executable. Scripts written in Python, where it is desirable to make the script executable (for example for test scripts that developers may want to invoke from the command line, such as tests/qapi-schema/test-qapi.py), -should be invoked through the `python` variable in meson.build. For +should be invoked through the ``python`` variable in meson.build. For example:: test('QAPI schema regression tests', python, @@ -375,10 +375,10 @@ rules and wraps them so that e.g. submodules are built before QEMU. The resulting build system is largely non-recursive in nature, in contrast to common practices seen with automake. -Tests are also ran by the Makefile with the traditional `make check` -phony target, while benchmarks are run with `make bench`. Meson test -suites such as `unit` can be ran with `make check-unit` too. It is also -possible to run tests defined in meson.build with `meson test`. +Tests are also ran by the Makefile with the traditional ``make check`` +phony target, while benchmarks are run with ``make bench``. Meson test +suites such as ``unit`` can be ran with ``make check-unit`` too. It is also +possible to run tests defined in meson.build with ``meson test``. Important files for the build system ==================================== @@ -390,28 +390,28 @@ The following key files are statically defined in the source tree, with the rules needed to build QEMU. Their behaviour is influenced by a number of dynamically created files listed later. -`Makefile` +``Makefile`` The main entry point used when invoking make to build all the components of QEMU. The default 'all' target will naturally result in the build of every component. Makefile takes care of recursively building submodules directly via a non-recursive set of rules. -`*/meson.build` +``*/meson.build`` The meson.build file in the root directory is the main entry point for the Meson build system, and it coordinates the configuration and build of all executables. Build rules for various subdirectories are included in other meson.build files spread throughout the QEMU source tree. -`tests/Makefile.include` +``tests/Makefile.include`` Rules for external test harnesses. These include the TCG tests, - `qemu-iotests` and the Avocado-based acceptance tests. + ``qemu-iotests`` and the Avocado-based acceptance tests. -`tests/docker/Makefile.include` +``tests/docker/Makefile.include`` Rules for Docker tests. Like tests/Makefile, this file is included directly by the top level Makefile, anything defined in this file will influence the entire build system. -`tests/vm/Makefile.include` +``tests/vm/Makefile.include`` Rules for VM-based tests. Like tests/Makefile, this file is included directly by the top level Makefile, anything defined in this file will influence the entire build system. @@ -427,11 +427,11 @@ Makefile. Built by configure: -`config-host.mak` +``config-host.mak`` When configure has determined the characteristics of the build host it will write a long list of variables to config-host.mak file. This provides the various install directories, compiler / linker flags and a - variety of `CONFIG_*` variables related to optionally enabled features. + variety of ``CONFIG_*`` variables related to optionally enabled features. This is imported by the top level Makefile and meson.build in order to tailor the build output. @@ -446,29 +446,29 @@ Built by configure: Built by Meson: -`${TARGET-NAME}-config-devices.mak` +``${TARGET-NAME}-config-devices.mak`` TARGET-NAME is again the name of a system or userspace emulator. The config-devices.mak file is automatically generated by make using the scripts/make_device_config.sh program, feeding it the default-configs/$TARGET-NAME file as input. -`config-host.h`, `$TARGET-NAME/config-target.h`, `$TARGET-NAME/config-devices.h` +``config-host.h``, ``$TARGET-NAME/config-target.h``, ``$TARGET-NAME/config-devices.h`` These files are used by source code to determine what features are enabled. They are generated from the contents of the corresponding - `*.h` files using the scripts/create_config program. This extracts + ``*.h`` files using the scripts/create_config program. This extracts relevant variables and formats them as C preprocessor macros. -`build.ninja` +``build.ninja`` The build rules. Built by Makefile: -`Makefile.ninja` +``Makefile.ninja`` A Makefile include that bridges to ninja for the actual build. The Makefile is mostly a list of targets that Meson included in build.ninja. -`Makefile.mtest` +``Makefile.mtest`` The Makefile definitions that let "make check" run tests defined in meson.build. The rules are produced from Meson's JSON description of tests (obtained with "meson introspect --tests") through the script @@ -478,9 +478,9 @@ Built by Makefile: Useful make targets ------------------- -`help` +``help`` Print a help message for the most common build targets. -`print-VAR` +``print-VAR`` Print the value of the variable VAR. Useful for debugging the build system. From patchwork Mon Aug 2 11:57:59 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413769 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 67582C4338F for ; Mon, 2 Aug 2021 12:08:47 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 2ADCB60FC2 for ; Mon, 2 Aug 2021 12:08:47 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 2ADCB60FC2 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:40928 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWkQ-0002gA-CB for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:08:46 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49926) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaM-0000Rm-68 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:22 -0400 Received: from mail-wr1-x42c.google.com ([2a00:1450:4864:20::42c]:39851) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaK-0003a4-Oz for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:21 -0400 Received: by mail-wr1-x42c.google.com with SMTP id b11so15835714wrx.6 for ; Mon, 02 Aug 2021 04:58:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=oAmHaChlHeq8uZJC1dsECbrC/qaM8LnULTn49QMEW04=; b=o8f9UcKjTg5qY35Tcd689IhDfmTJxs6A9s7yONGVBuyvrOdO7pEOFvcra2t2bRLvAt fFKALyVWJ5gThbTq5K6xBOZuBSg/4VJR7zOTgz0PZ7kXpqOkG64V3ZTRazoYASu1LhK6 lNpFTXgS6U0eR49OpPZUyWd4hgwERpNhYFcnA7WBlboy2rOw0FBHniUVxWS3JJZhtZFN GSjUhiitf12uJN/iVfcSkSdrx2ukDhGzPS0PQ6AcOw/kG8DnTca+7mhEOezv8hmzcqBk jlTCX9OsdnvyOzt0N4JikzYrzOet78gqxj5u1UzSrO8m3IdX6wfIPCCN5zZbEffLeGH6 3iPA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=oAmHaChlHeq8uZJC1dsECbrC/qaM8LnULTn49QMEW04=; b=CQ2OQPoDpuW69oeRJCBK1xw5m2BPZTeN25Be17UAwUy+WTlLn169qvIAKUZtnIM8eI FPSOpYlRWx2DBRmEALmtAV8zLlU7fgjbySRqybDnHwlN1M7qrXDOkN3ir3dz+oXviXSm tPc2rRhm06P8Nv6XTMGCH23YcsJKgOtEIpjJHpVMX+d6nz4f//xWezBnQUIUTy8F/gAq tPVEx47VBF5rjthA9wIgYyPwqDtu74X5HwtGOrTEalUPtXDmnhLxw/YwT9sju4zLKSvk pDbIC4Ru1N9GeeFxf0khDK+vybKYywKE5BYHE7eet9yuEmdYYILncQNM2fQDduae5Mfy db2A== X-Gm-Message-State: AOAM532T9/GtjvlWyjmPPddgWSU4JCSoSNiYm76VUwzi5jHe3wXDR7Ds WYY8YuptNa+qdARVPuHGo8UKn+F5Jji6Ug== X-Google-Smtp-Source: ABdhPJytmjOgUy9ynvAduik6G0snhPRmmXsHUmnMQ9itwMHGBvJWk9xJ6WAX6+UxsE+QhNJnHEDGYA== X-Received: by 2002:a5d:4d85:: with SMTP id b5mr16895604wru.317.1627905499532; Mon, 02 Aug 2021 04:58:19 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.18 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:19 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 08/21] docs/devel/build-system.rst: Correct typo in example code Date: Mon, 2 Aug 2021 12:57:59 +0100 Message-Id: <20210802115812.10731-9-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42c; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42c.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" One of the example meson.build fragments incorrectly quotes some symbols as 'CONFIG_FOO`; the correct syntax here is 'CONFIG_FOO'. (This isn't a rST formatting mistake because the example is displayed literally; it's just the wrong kind of quote.) Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726142338.31872-3-peter.maydell@linaro.org --- docs/devel/build-system.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/devel/build-system.rst b/docs/devel/build-system.rst index ee660a998d0..3baec158f22 100644 --- a/docs/devel/build-system.rst +++ b/docs/devel/build-system.rst @@ -235,11 +235,11 @@ Target-independent emulator sourcesets: symbol:: # Some targets have CONFIG_ACPI, some don't, so this is not enough - softmmu_ss.add(when: 'CONFIG_ACPI`, if_true: files('acpi.c'), + softmmu_ss.add(when: 'CONFIG_ACPI', if_true: files('acpi.c'), if_false: files('acpi-stub.c')) # This is required as well: - softmmu_ss.add(when: 'CONFIG_ALL`, if_true: files('acpi-stub.c')) + softmmu_ss.add(when: 'CONFIG_ALL', if_true: files('acpi-stub.c')) Target-dependent emulator sourcesets: In the target-dependent set lives CPU emulation, some device emulation and From patchwork Mon Aug 2 11:58:00 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413735 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 321ACC432BE for ; Mon, 2 Aug 2021 11:59:44 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id A347460FC2 for ; Mon, 2 Aug 2021 11:59:43 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org A347460FC2 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:45184 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWbd-0003Fz-Th for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 07:59:41 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49960) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaN-0000XB-U1 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:23 -0400 Received: from mail-wm1-x335.google.com ([2a00:1450:4864:20::335]:55205) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaL-0003at-GL for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:23 -0400 Received: by mail-wm1-x335.google.com with SMTP id b128so10238855wmb.4 for ; Mon, 02 Aug 2021 04:58:21 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=Y2muprbycP1Fyma9ck4C7z6fmxENa295w40MBCrC3qo=; b=qwd8K/NWxu4pcOrWimJ1M0PN2cj1wCqNhWCaYmKFbOz1Sl8ThVAN6zYVv3izanoRJn NVcqdbo6u/Pwzzkb0KfZjQwR/LcO20tKaY74F4KCbIS8LCGwiCMwwfGSHrl44L+QIYnu 5BJwuXlIdTP+QQgo3/sJ7xZ1HDh4sH6WsoWdCdzFK5vQCRCPUO/IzEEHBULg/C2F6o8I kQTwfkfvgPJbJFPMMgK8YWqVr8XZQk7pNari+uKzatX9p5JL+Yadmp1to6DTSvkFqrHj TPnN/2xKZPcArIO6nuhec+5t8arB4F1YmEQtD57AP9ojzWNZwReXCyVDKb5Rg+7PXy24 t3VQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Y2muprbycP1Fyma9ck4C7z6fmxENa295w40MBCrC3qo=; b=VWTp7UDkDlW0G0SYtUDJTDXt8+LxIWEN+AP7E3jJxYP+LgussvtsFB4dtKvjzaO0oX BvbMkLYJSrTKLhhCrJ+QYBiMr6Ms/08Yb6zZag9JU0vdgL90yQtvCRBufQw+lXR6tPW0 5k+pHeWHaoe7W7BuQ01zR6B/OHfjPef1zlM6HzTqj9E1QKgGy5XUEZRJtDdvQobRxV59 qgHD9ZvM6FljplsNXns5Khhxv3J6CmkItkviMWoq0gQFicD0sioBbZ6Nr0OiTqFOTW7u kEVy7eo/MbliltYGQMjJrnD2ukffkiChAkX5by6UPZYreZyWNZ5eH//P/mZ+lme/qlxY I1pQ== X-Gm-Message-State: AOAM531skUBO2cyCiAwrpvQUoO4R3dXn0ncIWJk1mNMKY+eYWwNtUBCD bykdj06HAODdqVjB5dt4jm9S3Rl7QE9d+Q== X-Google-Smtp-Source: ABdhPJzs47I21YfVyWJcGevfboYYkYxDni0qRW4FFZ9o67OG7MR0i2+LhWsvCXfL5a6yECViXmzFZQ== X-Received: by 2002:a1c:2984:: with SMTP id p126mr16359277wmp.58.1627905500218; Mon, 02 Aug 2021 04:58:20 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.19 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:19 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 09/21] docs/devel/ebpf_rss.rst: Format literals correctly Date: Mon, 2 Aug 2021 12:58:00 +0100 Message-Id: <20210802115812.10731-10-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. ebpf_rss.rst gets this wrong in a few places; correct them. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726142338.31872-4-peter.maydell@linaro.org --- docs/devel/ebpf_rss.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/devel/ebpf_rss.rst b/docs/devel/ebpf_rss.rst index e00962577ad..4a68682b31a 100644 --- a/docs/devel/ebpf_rss.rst +++ b/docs/devel/ebpf_rss.rst @@ -72,7 +72,7 @@ eBPF RSS implementation eBPF RSS loading functionality located in ebpf/ebpf_rss.c and ebpf/ebpf_rss.h. -The `struct EBPFRSSContext` structure that holds 4 file descriptors: +The ``struct EBPFRSSContext`` structure that holds 4 file descriptors: - ctx - pointer of the libbpf context. - program_fd - file descriptor of the eBPF RSS program. @@ -80,20 +80,20 @@ The `struct EBPFRSSContext` structure that holds 4 file descriptors: - map_toeplitz_key - file descriptor of the 'Toeplitz key' map. One element of the 40byte key prepared for the hashing algorithm. - map_indirections_table - 128 elements of queue indexes. -`struct EBPFRSSConfig` fields: +``struct EBPFRSSConfig`` fields: -- redirect - "boolean" value, should the hash be calculated, on false - `default_queue` would be used as the final decision. +- redirect - "boolean" value, should the hash be calculated, on false - ``default_queue`` would be used as the final decision. - populate_hash - for now, not used. eBPF RSS doesn't support hash reporting. -- hash_types - binary mask of different hash types. See `VIRTIO_NET_RSS_HASH_TYPE_*` defines. If for packet hash should not be calculated - `default_queue` would be used. +- hash_types - binary mask of different hash types. See ``VIRTIO_NET_RSS_HASH_TYPE_*`` defines. If for packet hash should not be calculated - ``default_queue`` would be used. - indirections_len - length of the indirections table, maximum 128. - default_queue - the queue index that used for packet that shouldn't be hashed. For some packets, the hash can't be calculated(g.e ARP). Functions: -- `ebpf_rss_init()` - sets ctx to NULL, which indicates that EBPFRSSContext is not loaded. -- `ebpf_rss_load()` - creates 3 maps and loads eBPF program from the rss.bpf.skeleton.h. Returns 'true' on success. After that, program_fd can be used to set steering for TAP. -- `ebpf_rss_set_all()` - sets values for eBPF maps. `indirections_table` length is in EBPFRSSConfig. `toeplitz_key` is VIRTIO_NET_RSS_MAX_KEY_SIZE aka 40 bytes array. -- `ebpf_rss_unload()` - close all file descriptors and set ctx to NULL. +- ``ebpf_rss_init()`` - sets ctx to NULL, which indicates that EBPFRSSContext is not loaded. +- ``ebpf_rss_load()`` - creates 3 maps and loads eBPF program from the rss.bpf.skeleton.h. Returns 'true' on success. After that, program_fd can be used to set steering for TAP. +- ``ebpf_rss_set_all()`` - sets values for eBPF maps. ``indirections_table`` length is in EBPFRSSConfig. ``toeplitz_key`` is VIRTIO_NET_RSS_MAX_KEY_SIZE aka 40 bytes array. +- ``ebpf_rss_unload()`` - close all file descriptors and set ctx to NULL. Simplified eBPF RSS workflow: @@ -122,4 +122,4 @@ Simplified eBPF RSS workflow: NetClientState SetSteeringEBPF() ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -For now, `set_steering_ebpf()` method supported by Linux TAP NetClientState. The method requires an eBPF program file descriptor as an argument. +For now, ``set_steering_ebpf()`` method supported by Linux TAP NetClientState. The method requires an eBPF program file descriptor as an argument. From patchwork Mon Aug 2 11:58:01 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413749 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A9E7DC4338F for ; Mon, 2 Aug 2021 12:03:23 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 43F6660EFD for ; Mon, 2 Aug 2021 12:03:23 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 43F6660EFD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:53798 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWfC-0000gn-8p for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:03:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49976) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaO-0000ZG-La for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:24 -0400 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]:36492) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaM-0003az-FB for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:24 -0400 Received: by mail-wr1-x434.google.com with SMTP id b13so10310260wrs.3 for ; Mon, 02 Aug 2021 04:58:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=Dg5nApdUFCOrIhZ/JoSJnJ//2SJbZdxUlkIsuGjN9ZI=; b=TdV9OYy2qHK6LfHJnZ6XhGbgK2BH++Opqyxc4Xbyf/dIOexeOXIVgw/pBYRQ3jDDVm Vkdv/5hyTdPVdBzpCasLBM0plNQqyw5uRRIsHZx1Ja8AK1UN0fHMN98GWQe6zSVZruJM E51Y1GgfL4duCTmK+OetPhaG4eJxHYGvAW6FIZTVDGs8wwZHVFqyO6pnJhXjFvVKIW4k BPJsw3Rf58NnLaRBCd/FQjSgIGP5g96fabF0xMztSZfNazKlFk+pBguVZboPeRl5q6UQ 1If0WvwMR1npYOpayTVuBfbiCxFO2IwVyxXsKv0J3P94KyvV8Xo3vPXI8DOjkpC7ZQYW BGTg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Dg5nApdUFCOrIhZ/JoSJnJ//2SJbZdxUlkIsuGjN9ZI=; b=QTI3bX8pkLQcnBXFOWPIqhqvFsn8TQBLs+1kGkvsJUUh4C1PAQfgszDRO1z+0D14JT UMX+isK10svuyT3rGdzXMc1MJN/p9PzZfKRzfs2XU/dQORGwDrItFdpUopDs5sO7Jnwv FSAIKK0S0OLGDOidI7NOG8w50w/o5EptpfH27l3e5ckVldvS0lbvtftt156//0JEoAwP zXIVyC9IeztCD2sijmz80FtVgJAS8mosjtQMaejYKQ7J510/hUhlda5597WrpadFbloH W3RyMl8nxiAOs4yGbvo35PF7cFHKdvJ8r7pptE5rPqHpA9V4GKlyEijtZqZ7V/Y7pvsP QtRw== X-Gm-Message-State: AOAM532d8VmMSLgyHAbMIZIx/aj9MnPTEHImtVsZk73LtT/RGBA/rUTd vP3T4gMVjp9NP3rb/YFsBJqCJ+h/SPlDDg== X-Google-Smtp-Source: ABdhPJzYeMQ8hTjxzccq70BwsGae3iXboSWLoszCt256vRmamCgludWQH3twTXR0QSm9aur6d7EPrg== X-Received: by 2002:a5d:4b48:: with SMTP id w8mr17321990wrs.109.1627905501034; Mon, 02 Aug 2021 04:58:21 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.20 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:20 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 10/21] docs/devel/migration.rst: Format literals correctly Date: Mon, 2 Aug 2021 12:58:01 +0100 Message-Id: <20210802115812.10731-11-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::434; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x434.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. Mostly migration.rst gets this right, but some places incorrectly use single backticks where double backticks were intended; correct them. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Acked-by: Dr. David Alan Gilbert Message-id: 20210726142338.31872-5-peter.maydell@linaro.org --- docs/devel/migration.rst | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/devel/migration.rst b/docs/devel/migration.rst index 19c3d4f3eac..24012534827 100644 --- a/docs/devel/migration.rst +++ b/docs/devel/migration.rst @@ -53,7 +53,7 @@ savevm/loadvm functionality. Debugging ========= -The migration stream can be analyzed thanks to `scripts/analyze-migration.py`. +The migration stream can be analyzed thanks to ``scripts/analyze-migration.py``. Example usage: @@ -75,8 +75,8 @@ Common infrastructure ===================== The files, sockets or fd's that carry the migration stream are abstracted by -the ``QEMUFile`` type (see `migration/qemu-file.h`). In most cases this -is connected to a subtype of ``QIOChannel`` (see `io/`). +the ``QEMUFile`` type (see ``migration/qemu-file.h``). In most cases this +is connected to a subtype of ``QIOChannel`` (see ``io/``). Saving the state of one device @@ -166,14 +166,14 @@ An example (from hw/input/pckbd.c) }; We are declaring the state with name "pckbd". -The `version_id` is 3, and the fields are 4 uint8_t in a KBDState structure. +The ``version_id`` is 3, and the fields are 4 uint8_t in a KBDState structure. We registered this with: .. code:: c vmstate_register(NULL, 0, &vmstate_kbd, s); -For devices that are `qdev` based, we can register the device in the class +For devices that are ``qdev`` based, we can register the device in the class init function: .. code:: c @@ -210,9 +210,9 @@ another to load the state back. SaveVMHandlers *ops, void *opaque); -Two functions in the ``ops`` structure are the `save_state` -and `load_state` functions. Notice that `load_state` receives a version_id -parameter to know what state format is receiving. `save_state` doesn't +Two functions in the ``ops`` structure are the ``save_state`` +and ``load_state`` functions. Notice that ``load_state`` receives a version_id +parameter to know what state format is receiving. ``save_state`` doesn't have a version_id parameter because it always uses the latest version. Note that because the VMState macros still save the data in a raw @@ -385,18 +385,18 @@ migration of a device, and using them breaks backward-migration compatibility; in general most changes can be made by adding Subsections (see above) or _TEST macros (see above) which won't break compatibility. -Each version is associated with a series of fields saved. The `save_state` always saves -the state as the newer version. But `load_state` sometimes is able to +Each version is associated with a series of fields saved. The ``save_state`` always saves +the state as the newer version. But ``load_state`` sometimes is able to load state from an older version. You can see that there are several version fields: -- `version_id`: the maximum version_id supported by VMState for that device. -- `minimum_version_id`: the minimum version_id that VMState is able to understand +- ``version_id``: the maximum version_id supported by VMState for that device. +- ``minimum_version_id``: the minimum version_id that VMState is able to understand for that device. -- `minimum_version_id_old`: For devices that were not able to port to vmstate, we can +- ``minimum_version_id_old``: For devices that were not able to port to vmstate, we can assign a function that knows how to read this old state. This field is - ignored if there is no `load_state_old` handler. + ignored if there is no ``load_state_old`` handler. VMState is able to read versions from minimum_version_id to version_id. And the function ``load_state_old()`` (if present) is able to @@ -454,7 +454,7 @@ data and then transferred to the main structure. If you use memory API functions that update memory layout outside initialization (i.e., in response to a guest action), this is a strong -indication that you need to call these functions in a `post_load` callback. +indication that you need to call these functions in a ``post_load`` callback. Examples of such memory API functions are: - memory_region_add_subregion() @@ -823,12 +823,12 @@ Postcopy migration with shared memory needs explicit support from the other processes that share memory and from QEMU. There are restrictions on the type of memory that userfault can support shared. -The Linux kernel userfault support works on `/dev/shm` memory and on `hugetlbfs` -(although the kernel doesn't provide an equivalent to `madvise(MADV_DONTNEED)` +The Linux kernel userfault support works on ``/dev/shm`` memory and on ``hugetlbfs`` +(although the kernel doesn't provide an equivalent to ``madvise(MADV_DONTNEED)`` for hugetlbfs which may be a problem in some configurations). The vhost-user code in QEMU supports clients that have Postcopy support, -and the `vhost-user-bridge` (in `tests/`) and the DPDK package have changes +and the ``vhost-user-bridge`` (in ``tests/``) and the DPDK package have changes to support postcopy. The client needs to open a userfaultfd and register the areas From patchwork Mon Aug 2 11:58:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413767 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 27814C4338F for ; Mon, 2 Aug 2021 12:06:40 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 96DD760F70 for ; Mon, 2 Aug 2021 12:06:39 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 96DD760F70 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:34156 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWiM-0006PK-Ea for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:06:38 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49982) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaP-0000aV-1b for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:25 -0400 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:43653) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaN-0003b8-2q for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:24 -0400 Received: by mail-wr1-x435.google.com with SMTP id h14so21135297wrx.10 for ; Mon, 02 Aug 2021 04:58:22 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=aGF2G+/n9eScQIPDnrsebLNRQ810Fm+XJpMurXM/QN0=; b=LQpFA+y6L3wcvpBV31JKdzI2L16uGmqXRBzTOUULfDoMwYEB6yEtkVZGj3xqZkRrQH ujsqGsi9UI48q7AxR8nfsjDbY33MgP5vAFtN1CZXhZf71zdHKO4rBWLFbBc6MdGHt2xc bb+jaqHLofVYmKVkyJh6J/H1H6Ywdi/XvtjHCTjED39iQZwFWOhvq+nUOo3H/VBTzi1H 6K2metXIt5qvZF+9JasT2vOYzEhaUAtRYpJJKwPsRrHh8bfa+5qfIExpwDyCkLOC/EUg XN10pyukdp5XkdSxB0M/NOzHPEW4AAAHcpjQmZ8DTK/22GXHXgNHGN82NYcgbLxhWv6o ezFg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=aGF2G+/n9eScQIPDnrsebLNRQ810Fm+XJpMurXM/QN0=; b=D9rJ6NA3PTkdZP1xvh9d8kc6ETn7yAS2YS6hkPe/CPDxAKzmsHg+urAVWtvjIJLZnX irRt3PgRztAcrPU6R9+2zqtlssoeAqoqhuj9r2+y/wUFwp5Hnyv/1+SbkYaQIZgboWrh iZqTLYgOzOZ8TJg3iaREEYztKt/Vrb6bKWoZfEY/PO4MVianXs2hSrg9O9nzx5dKLujd f4qsB2CkGutHnv6bIL2sCjm2Ib8N2vAKN31C7mdwxovf3B9X8wt4/xAMo56UKPPu2AOS YTTgF3kJuZz3JDhqQd7pE3vCFBcsaw/WmmNYBNVDdRd0aX9ARRSwjdXDR+OQmQv4zxEf 5dkg== X-Gm-Message-State: AOAM530QDO1p28YRitBm9emjVXVRd4sIMFdZS+mpDDhKkwxMZn0EpODz TRwD0Egiy2s/A3yukAmA0VSJHVQ+knMwFA== X-Google-Smtp-Source: ABdhPJwPf9zgrXKXL9Uk6z7S/Uak5v4Nk3UFvhoAnkyghJ8+jkOtLtlsQAhSsTzSMOxnA9lR8FNI/A== X-Received: by 2002:a5d:53cf:: with SMTP id a15mr17164874wrw.410.1627905501832; Mon, 02 Aug 2021 04:58:21 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.21 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:21 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 11/21] docs/devel: Format literals correctly Date: Mon, 2 Aug 2021 12:58:02 +0100 Message-Id: <20210802115812.10731-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::435; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x435.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). Fix various places in the devel section of the manual which were using single backticks when double backticks (for literal text) were intended. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726142338.31872-6-peter.maydell@linaro.org --- docs/devel/qgraph.rst | 8 ++++---- docs/devel/tcg-plugins.rst | 14 +++++++------- docs/devel/testing.rst | 8 ++++---- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/devel/qgraph.rst b/docs/devel/qgraph.rst index 318534d4b08..39e293687e6 100644 --- a/docs/devel/qgraph.rst +++ b/docs/devel/qgraph.rst @@ -66,11 +66,11 @@ Notes for the nodes: Edges ^^^^^^ -An edge relation between two nodes (drivers or machines) `X` and `Y` can be: +An edge relation between two nodes (drivers or machines) ``X`` and ``Y`` can be: -- ``X CONSUMES Y``: `Y` can be plugged into `X` -- ``X PRODUCES Y``: `X` provides the interface `Y` -- ``X CONTAINS Y``: `Y` is part of `X` component +- ``X CONSUMES Y``: ``Y`` can be plugged into ``X`` +- ``X PRODUCES Y``: ``X`` provides the interface ``Y`` +- ``X CONTAINS Y``: ``Y`` is part of ``X`` component Execution steps ^^^^^^^^^^^^^^^ diff --git a/docs/devel/tcg-plugins.rst b/docs/devel/tcg-plugins.rst index 7e54f128375..047bf4ada7c 100644 --- a/docs/devel/tcg-plugins.rst +++ b/docs/devel/tcg-plugins.rst @@ -34,11 +34,11 @@ version they were built against. This can be done simply by:: QEMU_PLUGIN_EXPORT int qemu_plugin_version = QEMU_PLUGIN_VERSION; The core code will refuse to load a plugin that doesn't export a -`qemu_plugin_version` symbol or if plugin version is outside of QEMU's +``qemu_plugin_version`` symbol or if plugin version is outside of QEMU's supported range of API versions. -Additionally the `qemu_info_t` structure which is passed to the -`qemu_plugin_install` method of a plugin will detail the minimum and +Additionally the ``qemu_info_t`` structure which is passed to the +``qemu_plugin_install`` method of a plugin will detail the minimum and current API versions supported by QEMU. The API version will be incremented if new APIs are added. The minimum API version will be incremented if existing APIs are changed or removed. @@ -146,12 +146,12 @@ Example Plugins There are a number of plugins included with QEMU and you are encouraged to contribute your own plugins plugins upstream. There is a -`contrib/plugins` directory where they can go. +``contrib/plugins`` directory where they can go. - tests/plugins These are some basic plugins that are used to test and exercise the -API during the `make check-tcg` target. +API during the ``make check-tcg`` target. - contrib/plugins/hotblocks.c @@ -163,7 +163,7 @@ with linux-user execution as system emulation tends to generate re-translations as blocks from different programs get swapped in and out of system memory. -If your program is single-threaded you can use the `inline` option for +If your program is single-threaded you can use the ``inline`` option for slightly faster (but not thread safe) counters. Example:: @@ -251,7 +251,7 @@ which will lead to a sorted list after the class breakdown:: ... To find the argument shorthand for the class you need to examine the -source code of the plugin at the moment, specifically the `*opt` +source code of the plugin at the moment, specifically the ``*opt`` argument in the InsnClassExecCount tables. - contrib/plugins/lockstep.c diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst index 8f572255d32..8a9cda33a5d 100644 --- a/docs/devel/testing.rst +++ b/docs/devel/testing.rst @@ -775,7 +775,7 @@ The base test class has also support for tests with more than one QEMUMachine. The way to get machines is through the ``self.get_vm()`` method which will return a QEMUMachine instance. The ``self.get_vm()`` method accepts arguments that will be passed to the QEMUMachine creation -and also an optional `name` attribute so you can identify a specific +and also an optional ``name`` attribute so you can identify a specific machine and get it more than once through the tests methods. A simple and hypothetical example follows: @@ -1062,7 +1062,7 @@ Here is a list of the most used variables: AVOCADO_ALLOW_LARGE_STORAGE ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Tests which are going to fetch or produce assets considered *large* are not -going to run unless that `AVOCADO_ALLOW_LARGE_STORAGE=1` is exported on +going to run unless that ``AVOCADO_ALLOW_LARGE_STORAGE=1`` is exported on the environment. The definition of *large* is a bit arbitrary here, but it usually means an @@ -1076,7 +1076,7 @@ skipped by default. The definition of *not safe* is also arbitrary but usually it means a blob which either its source or build process aren't public available. -You should export `AVOCADO_ALLOW_UNTRUSTED_CODE=1` on the environment in +You should export ``AVOCADO_ALLOW_UNTRUSTED_CODE=1`` on the environment in order to allow tests which make use of those kind of assets. AVOCADO_TIMEOUT_EXPECTED @@ -1090,7 +1090,7 @@ property defined in the test class, for further details:: Even though the timeout can be set by the test developer, there are some tests that may not have a well-defined limit of time to finish under certain conditions. For example, tests that take longer to execute when QEMU is -compiled with debug flags. Therefore, the `AVOCADO_TIMEOUT_EXPECTED` variable +compiled with debug flags. Therefore, the ``AVOCADO_TIMEOUT_EXPECTED`` variable has been used to determine whether those tests should run or not. GITLAB_CI From patchwork Mon Aug 2 11:58:03 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413801 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C48DAC4338F for ; Mon, 2 Aug 2021 12:10:34 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 7BB5A60FA0 for ; Mon, 2 Aug 2021 12:10:34 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 7BB5A60FA0 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:47332 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWm9-0007F9-Hn for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:10:33 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:49988) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaP-0000bb-Hk for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:25 -0400 Received: from mail-wr1-x431.google.com ([2a00:1450:4864:20::431]:41606) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaN-0003bX-Tm for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:25 -0400 Received: by mail-wr1-x431.google.com with SMTP id c9so905568wri.8 for ; Mon, 02 Aug 2021 04:58:23 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=JQ370mH+fhk/bsQzvkzprTIabj45DjmXohdnh4/YhHs=; b=agZOf1TGDuwC17GVgX9u/JFZER4ibGyB9k/shjN15lm06HYvk+NZo+4TOYFHcbJjgV 7fa7v/sb818KN8PfYuw/LiN5lnpAPGKrpftD3RLBWOLAr4GGy/t9CvSPgv5x/a6pTJyV fRkEPEvesxWf5babU4a5h727iW/nKacL4RztnE3ZJeG1RkQOvQxnz31xTre9nkHGhusN zPBxMwigL1NTXatPhop12Ncp29AFMi8U10izh+zVBnWoLPq5hWHCIsQ5Qhpvuma1SMiA jXsKRsM9fCB6MgRUjaSpHXnUVovTMcKORiMfadV4yxf2kct4m8XHkym/hG5BWYexedXF 3r7A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=JQ370mH+fhk/bsQzvkzprTIabj45DjmXohdnh4/YhHs=; b=XdoxG+3KIzByAdroyQTqg5C4Kb8hwZieVOZGXzJ/wPcJ7oXAEnEU2D+dXH1xdb5cwj 4ny7KUlOyOFJkQ57c66gkUajsEbszdVuDcECjz94sZgwb1fa4Dy+uD/2sefk8Wc+yBs5 Z/4cseLP2vrLCVqHhll+BuchjPlqIpg8fpv4uDXa+StYPAEMueqi3eVOxQNyLV3FHBHQ 0erRWUGXgV4VWQb6YMxRuvGT40yuAulo9ORFmmepEGrQaJzueom5LpdOVcr0DjTfWlyp JCsQaQC3VM1w4NmG20wWBKkK6Ioht8F9qnSAe5SL5n6SDVmg9A7j/pO0XVg7fglz6vpo 9RhA== X-Gm-Message-State: AOAM533tPynkIlryH9PrQAnKnfqNPWb9jkOwaBp35gLSBdfLwtXJJcvH jZmls6jjA8UytEKlWyOi6qJM92fuA8/MIg== X-Google-Smtp-Source: ABdhPJw2ZJBT04TO2RjDKJFVRmriuQZgOcmQKxFDtEY7qVqtdfMgXQH0nrJQQqsP5sL5fOMA+nYRkA== X-Received: by 2002:adf:ef50:: with SMTP id c16mr16838206wrp.190.1627905502561; Mon, 02 Aug 2021 04:58:22 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.21 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:22 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 12/21] docs/system/s390x/protvirt.rst: Format literals correctly Date: Mon, 2 Aug 2021 12:58:03 +0100 Message-Id: <20210802115812.10731-13-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::431; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x431.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. protvirt.rst consistently uses single backticks when double backticks are required; correct it. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Acked-by: Cornelia Huck Message-id: 20210726142338.31872-7-peter.maydell@linaro.org --- docs/system/s390x/protvirt.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/system/s390x/protvirt.rst b/docs/system/s390x/protvirt.rst index 0f481043d99..aee63ed7ec9 100644 --- a/docs/system/s390x/protvirt.rst +++ b/docs/system/s390x/protvirt.rst @@ -14,11 +14,11 @@ Prerequisites To run PVMs, a machine with the Protected Virtualization feature, as indicated by the Ultravisor Call facility (stfle bit 158), is required. The Ultravisor needs to be initialized at boot by setting -`prot_virt=1` on the host's kernel command line. +``prot_virt=1`` on the host's kernel command line. Running PVMs requires using the KVM hypervisor. -If those requirements are met, the capability `KVM_CAP_S390_PROTECTED` +If those requirements are met, the capability ``KVM_CAP_S390_PROTECTED`` will indicate that KVM can support PVMs on that LPAR. @@ -26,15 +26,15 @@ Running a Protected Virtual Machine ----------------------------------- To run a PVM you will need to select a CPU model which includes the -`Unpack facility` (stfle bit 161 represented by the feature -`unpack`/`S390_FEAT_UNPACK`), and add these options to the command line:: +``Unpack facility`` (stfle bit 161 represented by the feature +``unpack``/``S390_FEAT_UNPACK``), and add these options to the command line:: -object s390-pv-guest,id=pv0 \ -machine confidential-guest-support=pv0 Adding these options will: -* Ensure the `unpack` facility is available +* Ensure the ``unpack`` facility is available * Enable the IOMMU by default for all I/O devices * Initialize the PV mechanism @@ -63,5 +63,5 @@ from the disk boot. This memory layout includes the encrypted components (kernel, initrd, cmdline), the stage3a loader and metadata. In case this boot method is used, the command line options -initrd and -cmdline are ineffective. The preparation of a PVM -image is done via the `genprotimg` tool from the s390-tools +image is done via the ``genprotimg`` tool from the s390-tools collection. From patchwork Mon Aug 2 11:58:04 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413805 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 400B9C432BE for ; Mon, 2 Aug 2021 12:13:32 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id CECF860EFD for ; Mon, 2 Aug 2021 12:13:31 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org CECF860EFD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:54062 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWp0-0003Ux-Vc for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:13:31 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50032) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaR-0000il-WF for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:28 -0400 Received: from mail-wm1-x32a.google.com ([2a00:1450:4864:20::32a]:46834) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaO-0003c6-Ve for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:27 -0400 Received: by mail-wm1-x32a.google.com with SMTP id h24-20020a1ccc180000b029022e0571d1a0so10846484wmb.5 for ; Mon, 02 Aug 2021 04:58:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=DGWN4y+CEHwKPlDwI5EEl9tQSUtlin5ZsMFr+XhjNFc=; b=B0jHqJBUKELYq5/Jq+TKUsB1AboJNEa0LfOb8lQ2zgvE3958I/gcp2AnGsiGKnKvL7 V2ntFalmEIRLVGXYIe/cBTZg2OW8NfH3TtxrrVJJvKHi+fOgxK1tjBi2ljbhZgSU9SlS +bQjN2qTb+rmZ/P2khZld3qELR4FDfzFc23L9ktFY7TeserMKdMMDHLNTwOp/h+kxa3C Ob74hbQquBzP4km+j0w2SXwms3gSJbfCsaaKyvSdW/04GQtFGXG9HRdklUDUWMJ4jP6D XtUK33dAdbWW7M0gtuzPPdoHUR+7yQ8H7f8uaSA6rN0ULhKDby1Jzz6yEPdvbBWt1VWH wWgw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=DGWN4y+CEHwKPlDwI5EEl9tQSUtlin5ZsMFr+XhjNFc=; b=m/2KpJ4rjI2quzLZxFVgd8HIF9PBzPobjwSstm4tPAU6Hl8prAYbHVEZ/isOGdoNmx 9jM4vRAxBX58ONi61SZJ04PgYOFAsLE5KAEuhRqeOo8WMVEUhLYc5RjzZ4yalSPHh9fX 9lNkI+A0cGlC9vB4Oyoj1T1GAINDv9pmEDZ4RSkpnX4g4wFw5IZSrfYD3tmEOi8wLhB2 jms21rfkxlMZpptPWmdxWmibDXEU22GltgFiSYRO53V6eF+e8WFr9e3OlhnHhRWt66GE mM/fKs9+6152Z4AQW1k1IIsc+pxKgzlhTp6Z1yE4jbMe+gf3KaWKUM6UvAbRh7Ab4LET 3nSQ== X-Gm-Message-State: AOAM5319dE9qH1u5miyrB6A4tTYhHzZvLHjoqzgZ7HzqtADVJrBrNhrq NmLW1KkIYtZsGIChRN9y0qAzDOc47/aadg== X-Google-Smtp-Source: ABdhPJyviY1DRYJHYyLe3x7WftM7GLaD2QvTFaQgjvZCRn9esorNXO+NEILDXS93g1hwq2CH3gdZSw== X-Received: by 2002:a1c:cc1a:: with SMTP id h26mr16110290wmb.47.1627905503417; Mon, 02 Aug 2021 04:58:23 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.22 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:23 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 13/21] docs/system/arm/cpu-features.rst: Format literals correctly Date: Mon, 2 Aug 2021 12:58:04 +0100 Message-Id: <20210802115812.10731-14-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32a; envelope-from=peter.maydell@linaro.org; helo=mail-wm1-x32a.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). To format a literal (generally rendered as fixed-width font), double-backticks are required. cpu-features.rst consistently uses single backticks when double backticks are required; correct it. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726142338.31872-8-peter.maydell@linaro.org --- docs/system/arm/cpu-features.rst | 116 +++++++++++++++---------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/docs/system/arm/cpu-features.rst b/docs/system/arm/cpu-features.rst index 11dce5c6037..584eb170974 100644 --- a/docs/system/arm/cpu-features.rst +++ b/docs/system/arm/cpu-features.rst @@ -10,22 +10,22 @@ is the Performance Monitoring Unit (PMU). CPU types such as the Cortex-A15 and the Cortex-A57, which respectively implement Arm architecture reference manuals ARMv7-A and ARMv8-A, may both optionally implement PMUs. For example, if a user wants to use a Cortex-A15 without -a PMU, then the `-cpu` parameter should contain `pmu=off` on the QEMU -command line, i.e. `-cpu cortex-a15,pmu=off`. +a PMU, then the ``-cpu`` parameter should contain ``pmu=off`` on the QEMU +command line, i.e. ``-cpu cortex-a15,pmu=off``. As not all CPU types support all optional CPU features, then whether or not a CPU property exists depends on the CPU type. For example, CPUs that implement the ARMv8-A architecture reference manual may optionally support the AArch32 CPU feature, which may be enabled by disabling the -`aarch64` CPU property. A CPU type such as the Cortex-A15, which does -not implement ARMv8-A, will not have the `aarch64` CPU property. +``aarch64`` CPU property. A CPU type such as the Cortex-A15, which does +not implement ARMv8-A, will not have the ``aarch64`` CPU property. QEMU's support may be limited for some CPU features, only partially supporting the feature or only supporting the feature under certain -configurations. For example, the `aarch64` CPU feature, which, when +configurations. For example, the ``aarch64`` CPU feature, which, when disabled, enables the optional AArch32 CPU feature, is only supported when using the KVM accelerator and when running on a host CPU type that -supports the feature. While `aarch64` currently only works with KVM, +supports the feature. While ``aarch64`` currently only works with KVM, it could work with TCG. CPU features that are specific to KVM are prefixed with "kvm-" and are described in "KVM VCPU Features". @@ -33,12 +33,12 @@ CPU Feature Probing =================== Determining which CPU features are available and functional for a given -CPU type is possible with the `query-cpu-model-expansion` QMP command. -Below are some examples where `scripts/qmp/qmp-shell` (see the top comment +CPU type is possible with the ``query-cpu-model-expansion`` QMP command. +Below are some examples where ``scripts/qmp/qmp-shell`` (see the top comment block in the script for usage) is used to issue the QMP commands. -1. Determine which CPU features are available for the `max` CPU type - (Note, we started QEMU with qemu-system-aarch64, so `max` is +1. Determine which CPU features are available for the ``max`` CPU type + (Note, we started QEMU with qemu-system-aarch64, so ``max`` is implementing the ARMv8-A reference manual in this case):: (QEMU) query-cpu-model-expansion type=full model={"name":"max"} @@ -51,9 +51,9 @@ block in the script for usage) is used to issue the QMP commands. "sve896": true, "sve1280": true, "sve2048": true }}}} -We see that the `max` CPU type has the `pmu`, `aarch64`, `sve`, and many -`sve` CPU features. We also see that all the CPU features are -enabled, as they are all `true`. (The `sve` CPU features are all +We see that the ``max`` CPU type has the ``pmu``, ``aarch64``, ``sve``, and many +``sve`` CPU features. We also see that all the CPU features are +enabled, as they are all ``true``. (The ``sve`` CPU features are all optional SVE vector lengths (see "SVE CPU Properties"). While with TCG all SVE vector lengths can be supported, when KVM is in use it's more likely that only a few lengths will be supported, if SVE is supported at @@ -71,9 +71,9 @@ all.) "sve896": true, "sve1280": true, "sve2048": true }}}} -We see it worked, as `pmu` is now `false`. +We see it worked, as ``pmu`` is now ``false``. -(3) Let's try to disable `aarch64`, which enables the AArch32 CPU feature:: +(3) Let's try to disable ``aarch64``, which enables the AArch32 CPU feature:: (QEMU) query-cpu-model-expansion type=full model={"name":"max","props":{"aarch64":false}} {"error": { @@ -84,7 +84,7 @@ We see it worked, as `pmu` is now `false`. It looks like this feature is limited to a configuration we do not currently have. -(4) Let's disable `sve` and see what happens to all the optional SVE +(4) Let's disable ``sve`` and see what happens to all the optional SVE vector lengths:: (QEMU) query-cpu-model-expansion type=full model={"name":"max","props":{"sve":false}} @@ -97,14 +97,14 @@ currently have. "sve896": false, "sve1280": false, "sve2048": false }}}} -As expected they are now all `false`. +As expected they are now all ``false``. (5) Let's try probing CPU features for the Cortex-A15 CPU type:: (QEMU) query-cpu-model-expansion type=full model={"name":"cortex-a15"} {"return": {"model": {"name": "cortex-a15", "props": {"pmu": true}}}} -Only the `pmu` CPU feature is available. +Only the ``pmu`` CPU feature is available. A note about CPU feature dependencies ------------------------------------- @@ -123,29 +123,29 @@ A note about CPU models and KVM ------------------------------- Named CPU models generally do not work with KVM. There are a few cases -that do work, e.g. using the named CPU model `cortex-a57` with KVM on a -seattle host, but mostly if KVM is enabled the `host` CPU type must be +that do work, e.g. using the named CPU model ``cortex-a57`` with KVM on a +seattle host, but mostly if KVM is enabled the ``host`` CPU type must be used. This means the guest is provided all the same CPU features as the -host CPU type has. And, for this reason, the `host` CPU type should +host CPU type has. And, for this reason, the ``host`` CPU type should enable all CPU features that the host has by default. Indeed it's even a bit strange to allow disabling CPU features that the host has when using -the `host` CPU type, but in the absence of CPU models it's the best we can +the ``host`` CPU type, but in the absence of CPU models it's the best we can do if we want to launch guests without all the host's CPU features enabled. -Enabling KVM also affects the `query-cpu-model-expansion` QMP command. The +Enabling KVM also affects the ``query-cpu-model-expansion`` QMP command. The affect is not only limited to specific features, as pointed out in example (3) of "CPU Feature Probing", but also to which CPU types may be expanded. -When KVM is enabled, only the `max`, `host`, and current CPU type may be +When KVM is enabled, only the ``max``, ``host``, and current CPU type may be expanded. This restriction is necessary as it's not possible to know all CPU types that may work with KVM, but it does impose a small risk of users experiencing unexpected errors. For example on a seattle, as mentioned -above, the `cortex-a57` CPU type is also valid when KVM is enabled. -Therefore a user could use the `host` CPU type for the current type, but -then attempt to query `cortex-a57`, however that query will fail with our +above, the ``cortex-a57`` CPU type is also valid when KVM is enabled. +Therefore a user could use the ``host`` CPU type for the current type, but +then attempt to query ``cortex-a57``, however that query will fail with our restrictions. This shouldn't be an issue though as management layers and -users have been preferring the `host` CPU type for use with KVM for quite +users have been preferring the ``host`` CPU type for use with KVM for quite some time. Additionally, if the KVM-enabled QEMU instance running on a -seattle host is using the `cortex-a57` CPU type, then querying `cortex-a57` +seattle host is using the ``cortex-a57`` CPU type, then querying ``cortex-a57`` will work. Using CPU Features @@ -158,12 +158,12 @@ QEMU command line with that CPU type:: $ qemu-system-aarch64 -M virt -cpu max,pmu=off,sve=on,sve128=on,sve256=on The example above disables the PMU and enables the first two SVE vector -lengths for the `max` CPU type. Note, the `sve=on` isn't actually -necessary, because, as we observed above with our probe of the `max` CPU -type, `sve` is already on by default. Also, based on our probe of +lengths for the ``max`` CPU type. Note, the ``sve=on`` isn't actually +necessary, because, as we observed above with our probe of the ``max`` CPU +type, ``sve`` is already on by default. Also, based on our probe of defaults, it would seem we need to disable many SVE vector lengths, rather than only enabling the two we want. This isn't the case, because, as -disabling many SVE vector lengths would be quite verbose, the `sve` CPU +disabling many SVE vector lengths would be quite verbose, the ``sve`` CPU properties have special semantics (see "SVE CPU Property Parsing Semantics"). @@ -217,11 +217,11 @@ TCG VCPU Features TCG VCPU features are CPU features that are specific to TCG. Below is the list of TCG VCPU features and their descriptions. - pauth Enable or disable `FEAT_Pauth`, pointer + pauth Enable or disable ``FEAT_Pauth``, pointer authentication. By default, the feature is - enabled with `-cpu max`. + enabled with ``-cpu max``. - pauth-impdef When `FEAT_Pauth` is enabled, either the + pauth-impdef When ``FEAT_Pauth`` is enabled, either the *impdef* (Implementation Defined) algorithm is enabled or the *architected* QARMA algorithm is enabled. By default the impdef algorithm @@ -235,49 +235,49 @@ Below is the list of TCG VCPU features and their descriptions. SVE CPU Properties ================== -There are two types of SVE CPU properties: `sve` and `sve`. The first -is used to enable or disable the entire SVE feature, just as the `pmu` +There are two types of SVE CPU properties: ``sve`` and ``sve``. The first +is used to enable or disable the entire SVE feature, just as the ``pmu`` CPU property completely enables or disables the PMU. The second type -is used to enable or disable specific vector lengths, where `N` is the -number of bits of the length. The `sve` CPU properties have special +is used to enable or disable specific vector lengths, where ``N`` is the +number of bits of the length. The ``sve`` CPU properties have special dependencies and constraints, see "SVE CPU Property Dependencies and Constraints" below. Additionally, as we want all supported vector lengths to be enabled by default, then, in order to avoid overly verbose command -lines (command lines full of `sve=off`, for all `N` not wanted), we +lines (command lines full of ``sve=off``, for all ``N`` not wanted), we provide the parsing semantics listed in "SVE CPU Property Parsing Semantics". SVE CPU Property Dependencies and Constraints --------------------------------------------- - 1) At least one vector length must be enabled when `sve` is enabled. + 1) At least one vector length must be enabled when ``sve`` is enabled. - 2) If a vector length `N` is enabled, then, when KVM is enabled, all + 2) If a vector length ``N`` is enabled, then, when KVM is enabled, all smaller, host supported vector lengths must also be enabled. If KVM is not enabled, then only all the smaller, power-of-two vector lengths must be enabled. E.g. with KVM if the host supports all - vector lengths up to 512-bits (128, 256, 384, 512), then if `sve512` + vector lengths up to 512-bits (128, 256, 384, 512), then if ``sve512`` is enabled, the 128-bit vector length, 256-bit vector length, and 384-bit vector length must also be enabled. Without KVM, the 384-bit vector length would not be required. 3) If KVM is enabled then only vector lengths that the host CPU type support may be enabled. If SVE is not supported by the host, then - no `sve*` properties may be enabled. + no ``sve*`` properties may be enabled. SVE CPU Property Parsing Semantics ---------------------------------- - 1) If SVE is disabled (`sve=off`), then which SVE vector lengths + 1) If SVE is disabled (``sve=off``), then which SVE vector lengths are enabled or disabled is irrelevant to the guest, as the entire SVE feature is disabled and that disables all vector lengths for - the guest. However QEMU will still track any `sve` CPU - properties provided by the user. If later an `sve=on` is provided, - then the guest will get only the enabled lengths. If no `sve=on` + the guest. However QEMU will still track any ``sve`` CPU + properties provided by the user. If later an ``sve=on`` is provided, + then the guest will get only the enabled lengths. If no ``sve=on`` is provided and there are explicitly enabled vector lengths, then an error is generated. - 2) If SVE is enabled (`sve=on`), but no `sve` CPU properties are + 2) If SVE is enabled (``sve=on``), but no ``sve`` CPU properties are provided, then all supported vector lengths are enabled, which when KVM is not in use means including the non-power-of-two lengths, and, when KVM is in use, it means all vector lengths supported by the host @@ -293,7 +293,7 @@ SVE CPU Property Parsing Semantics constraint (2) of "SVE CPU Property Dependencies and Constraints"). 5) When KVM is enabled, if the host does not support SVE, then an error - is generated when attempting to enable any `sve*` properties (see + is generated when attempting to enable any ``sve*`` properties (see constraint (3) of "SVE CPU Property Dependencies and Constraints"). 6) When KVM is enabled, if the host does support SVE, then an error is @@ -301,8 +301,8 @@ SVE CPU Property Parsing Semantics by the host (see constraint (3) of "SVE CPU Property Dependencies and Constraints"). - 7) If one or more `sve` CPU properties are set `off`, but no `sve`, - CPU properties are set `on`, then the specified vector lengths are + 7) If one or more ``sve`` CPU properties are set ``off``, but no ``sve``, + CPU properties are set ``on``, then the specified vector lengths are disabled but the default for any unspecified lengths remains enabled. When KVM is not enabled, disabling a power-of-two vector length also disables all vector lengths larger than the power-of-two length. @@ -310,15 +310,15 @@ SVE CPU Property Parsing Semantics disables all larger vector lengths (see constraint (2) of "SVE CPU Property Dependencies and Constraints"). - 8) If one or more `sve` CPU properties are set to `on`, then they + 8) If one or more ``sve`` CPU properties are set to ``on``, then they are enabled and all unspecified lengths default to disabled, except for the required lengths per constraint (2) of "SVE CPU Property Dependencies and Constraints", which will even be auto-enabled if they were not explicitly enabled. - 9) If SVE was disabled (`sve=off`), allowing all vector lengths to be + 9) If SVE was disabled (``sve=off``), allowing all vector lengths to be explicitly disabled (i.e. avoiding the error specified in (3) of - "SVE CPU Property Parsing Semantics"), then if later an `sve=on` is + "SVE CPU Property Parsing Semantics"), then if later an ``sve=on`` is provided an error will be generated. To avoid this error, one must enable at least one vector length prior to enabling SVE. @@ -329,12 +329,12 @@ SVE CPU Property Examples $ qemu-system-aarch64 -M virt -cpu max,sve=off - 2) Implicitly enable all vector lengths for the `max` CPU type:: + 2) Implicitly enable all vector lengths for the ``max`` CPU type:: $ qemu-system-aarch64 -M virt -cpu max 3) When KVM is enabled, implicitly enable all host CPU supported vector - lengths with the `host` CPU type:: + lengths with the ``host`` CPU type:: $ qemu-system-aarch64 -M virt,accel=kvm -cpu host From patchwork Mon Aug 2 11:58:05 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413807 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-23.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B074CC432BE for ; Mon, 2 Aug 2021 12:13:37 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 2506260FC2 for ; Mon, 2 Aug 2021 12:13:37 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 2506260FC2 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:54494 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWp6-0003mA-9X for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:13:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50036) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaS-0000ip-2h for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:28 -0400 Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:41601) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaP-0003cG-O1 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:27 -0400 Received: by mail-wr1-x42b.google.com with SMTP id c9so905671wri.8 for ; Mon, 02 Aug 2021 04:58:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=L8fNdCo6aFHirsmryZbRBTmjA6Ah4ZwEjtSOqdou9fY=; b=ux2yWoVMK4Ke4oOc337CbjQQ7JdUsTMi6+rcy+e/dr4P99G0caV531/XNIq5JLIvmq yjqM1bAqMbAiGUPtVApVCisLdOITbcEXd2JNlAlEpYWmNg3GtWcQi79KiYcTC9ktlJ3G iNReJnFunnyYrcXWROW/WqPea0XycoVvZwIIJ8Ouw82Xi9ex1Lkjnhy0ovYO+D04FlMz wvwtD8LCIpQLsvJ3ghbW2u7EPAuSFIqJQPyrWlJunEWkC1scU1oIAhqXmEPgXzIy0T6l YbzGWtvFtug3D/+5zh7IiZoQALJmInOD7qAOy01nC1v+Oh7QERbTM3t3Yw+bRGuFHbib 8QIw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=L8fNdCo6aFHirsmryZbRBTmjA6Ah4ZwEjtSOqdou9fY=; b=hTPjqs/0cm5rmSWXZyxaJLqaW/NDVGK1Y2MnxqaxM1eJK+oZR9SG5gnSgMm48mDHmT GmTipXClazkIMQYTJNM7AEuM03vADaP+eAwfwXG2haRB+Ri6MNPObY7q+p4MN0r+ZEIl uoZ/gf0qYM5DWceb0T/TkJLFki1i6XZ6JaLe2o7pbUh8jyeFLGdE9HLDCK//nqbMHJq6 6iKnBIzW9lwhlmRX7uMn1H6YCh3AiEhR4vVxF7Ta9r2Z8/Zp5IawYwCuo3B6wKzdcdhv TBfXMkLcKZDt34YaFCtOcI+knzQZYlqOyv20iHz1kWcOfVC3ij8bNvbZe92UB7LxQL7N b99w== X-Gm-Message-State: AOAM533zDGJvW/OOC4RVbcdlh08Ns5RmYu8BZ1cYwu44oS+HM6jcL2hz kDIf6Iqtes5+c9tYj+nFnyA1CtKI+ucXlg== X-Google-Smtp-Source: ABdhPJwLpOt4pIXgjk93Br96j5aINO4kh7HNAJmlsbx8p16td1DU9jyLwR+bVTzT5Se7uFh8cnNN0Q== X-Received: by 2002:a5d:5650:: with SMTP id j16mr17041535wrw.46.1627905504190; Mon, 02 Aug 2021 04:58:24 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.23 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:23 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 14/21] docs: Format literals correctly Date: Mon, 2 Aug 2021 12:58:05 +0100 Message-Id: <20210802115812.10731-15-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42b; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42b.google.com X-Spam_score_int: 0 X-Spam_score: -0.1 X-Spam_bar: / X-Spam_report: (-0.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, PDS_OTHER_BAD_TLD=2, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no 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: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" In rST markup, single backticks `like this` represent "interpreted text", which can be handled as a bunch of different things if tagged with a specific "role": https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#interpreted-text (the most common one for us is "reference to a URL, which gets hyperlinked"). The default "role" if none is specified is "title_reference", intended for references to book or article titles, and it renders into the HTML as ... (usually comes out as italics). This commit fixes various places in the manual which were using single backticks when double backticks (for literal text) were intended, and covers those files where only one or two instances of these errors were made. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson --- docs/about/index.rst | 2 +- docs/interop/live-block-operations.rst | 2 +- docs/system/arm/nuvoton.rst | 2 +- docs/system/arm/sbsa.rst | 4 ++-- docs/system/arm/virt.rst | 2 +- docs/system/cpu-hotplug.rst | 2 +- docs/system/guest-loader.rst | 6 +++--- docs/system/ppc/powernv.rst | 8 ++++---- docs/system/riscv/microchip-icicle-kit.rst | 2 +- docs/system/riscv/virt.rst | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/about/index.rst b/docs/about/index.rst index 689a9861dc3..beb762aa0a9 100644 --- a/docs/about/index.rst +++ b/docs/about/index.rst @@ -15,7 +15,7 @@ where QEMU can launch processes compiled for one CPU on another CPU. In this mode the CPU is always emulated. QEMU also provides a number of standalone commandline utilities, -such as the `qemu-img` disk image utility that allows you to create, +such as the ``qemu-img`` disk image utility that allows you to create, convert and modify disk images. .. toctree:: diff --git a/docs/interop/live-block-operations.rst b/docs/interop/live-block-operations.rst index 477d085f54e..9e3635b2338 100644 --- a/docs/interop/live-block-operations.rst +++ b/docs/interop/live-block-operations.rst @@ -781,7 +781,7 @@ the content of image [D]. } (6) [On *destination* QEMU] Finally, resume the guest vCPUs by issuing the - QMP command `cont`:: + QMP command ``cont``:: (QEMU) cont { diff --git a/docs/system/arm/nuvoton.rst b/docs/system/arm/nuvoton.rst index 3cd2b2b18d8..69f57c2886f 100644 --- a/docs/system/arm/nuvoton.rst +++ b/docs/system/arm/nuvoton.rst @@ -79,7 +79,7 @@ Boot options ------------ The Nuvoton machines can boot from an OpenBMC firmware image, or directly into -a kernel using the ``-kernel`` option. OpenBMC images for `quanta-gsj` and +a kernel using the ``-kernel`` option. OpenBMC images for ``quanta-gsj`` and possibly others can be downloaded from the OpenPOWER jenkins : https://openpower.xyz/ diff --git a/docs/system/arm/sbsa.rst b/docs/system/arm/sbsa.rst index 27b0999aaca..b499d7e9272 100644 --- a/docs/system/arm/sbsa.rst +++ b/docs/system/arm/sbsa.rst @@ -1,8 +1,8 @@ Arm Server Base System Architecture Reference board (``sbsa-ref``) ================================================================== -While the `virt` board is a generic board platform that doesn't match -any real hardware the `sbsa-ref` board intends to look like real +While the ``virt`` board is a generic board platform that doesn't match +any real hardware the ``sbsa-ref`` board intends to look like real hardware. The `Server Base System Architecture `_ defines a minimum base line of hardware support and importantly how the firmware diff --git a/docs/system/arm/virt.rst b/docs/system/arm/virt.rst index 27652adfae1..59acf0eeafa 100644 --- a/docs/system/arm/virt.rst +++ b/docs/system/arm/virt.rst @@ -1,7 +1,7 @@ 'virt' generic virtual platform (``virt``) ========================================== -The `virt` board is a platform which does not correspond to any +The ``virt`` board is a platform which does not correspond to any real hardware; it is designed for use in virtual machines. It is the recommended board type if you simply want to run a guest such as Linux and do not care about reproducing the diff --git a/docs/system/cpu-hotplug.rst b/docs/system/cpu-hotplug.rst index bd0663616e8..015ce2b6ec3 100644 --- a/docs/system/cpu-hotplug.rst +++ b/docs/system/cpu-hotplug.rst @@ -78,7 +78,7 @@ vCPU hotplug } (QEMU) -(5) Optionally, run QMP `query-cpus-fast` for some details about the +(5) Optionally, run QMP ``query-cpus-fast`` for some details about the vCPUs:: (QEMU) query-cpus-fast diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 37d03cbd892..4320d1183f7 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -4,7 +4,7 @@ Guest Loader ------------ -The guest loader is similar to the `generic-loader` although it is +The guest loader is similar to the ``generic-loader`` although it is aimed at a particular use case of loading hypervisor guests. This is useful for debugging hypervisors without having to jump through the hoops of firmware and boot-loaders. @@ -27,12 +27,12 @@ multi-boot capability. A typical example would look like: In the above example the Xen hypervisor is loaded by the -kernel parameter and passed it's boot arguments via -append. The Dom0 guest is loaded into the areas of memory. Each blob will get -`/chosen/module@` entry in the FDT to indicate it's location and +``/chosen/module@`` entry in the FDT to indicate it's location and size. Additional information can be passed with by using additional arguments. Currently the only supported machines which use FDT data to boot are -the ARM and RiscV `virt` machines. +the ARM and RiscV ``virt`` machines. Arguments ^^^^^^^^^ diff --git a/docs/system/ppc/powernv.rst b/docs/system/ppc/powernv.rst index 43c58bc32e7..4c4cdea527e 100644 --- a/docs/system/ppc/powernv.rst +++ b/docs/system/ppc/powernv.rst @@ -48,15 +48,15 @@ Firmware -------- The OPAL firmware (OpenPower Abstraction Layer) for OpenPower systems -includes the runtime services `skiboot` and the bootloader kernel and -initramfs `skiroot`. Source code can be found on GitHub: +includes the runtime services ``skiboot`` and the bootloader kernel and +initramfs ``skiroot``. Source code can be found on GitHub: https://github.com/open-power. -Prebuilt images of `skiboot` and `skiboot` are made available on the `OpenPOWER `__ site. To boot a POWER9 machine, use the `witherspoon `__ images. For POWER8, use +Prebuilt images of ``skiboot`` and ``skiboot`` are made available on the `OpenPOWER `__ site. To boot a POWER9 machine, use the `witherspoon `__ images. For POWER8, use the `palmetto `__ images. -QEMU includes a prebuilt image of `skiboot` which is updated when a +QEMU includes a prebuilt image of ``skiboot`` which is updated when a more recent version is required by the models. Boot options diff --git a/docs/system/riscv/microchip-icicle-kit.rst b/docs/system/riscv/microchip-icicle-kit.rst index 817d2aec9cd..40798b1aae5 100644 --- a/docs/system/riscv/microchip-icicle-kit.rst +++ b/docs/system/riscv/microchip-icicle-kit.rst @@ -95,7 +95,7 @@ Then we can boot the machine by: -serial chardev:serial1 With above command line, current terminal session will be used for the first -serial port. Open another terminal window, and use `minicom` to connect the +serial port. Open another terminal window, and use ``minicom`` to connect the second serial port. .. code-block:: bash diff --git a/docs/system/riscv/virt.rst b/docs/system/riscv/virt.rst index 3709f057972..321d77e07d4 100644 --- a/docs/system/riscv/virt.rst +++ b/docs/system/riscv/virt.rst @@ -1,7 +1,7 @@ 'virt' Generic Virtual Platform (``virt``) ========================================== -The `virt` board is a platform which does not correspond to any real hardware; +The ``virt`` board is a platform which does not correspond to any real hardware; it is designed for use in virtual machines. It is the recommended board type if you simply want to run a guest such as Linux and do not care about reproducing the idiosyncrasies and limitations of a particular bit of From patchwork Mon Aug 2 11:58:06 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413773 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 25851C4338F for ; Mon, 2 Aug 2021 12:09:05 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id DEF5760EFD for ; Mon, 2 Aug 2021 12:09:04 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org DEF5760EFD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:41596 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWki-0003AA-3i for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:09:04 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50074) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaT-0000o3-SG for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:29 -0400 Received: from mail-wr1-x42a.google.com ([2a00:1450:4864:20::42a]:47078) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaQ-0003cS-68 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:29 -0400 Received: by mail-wr1-x42a.google.com with SMTP id c16so21141310wrp.13 for ; Mon, 02 Aug 2021 04:58:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=cZmxhO8Ua6HfhbJqYgf1vh7riK06m+t8EzfL2eNpEIM=; b=HZz1tywwGMZv+x6k+FqAovSZ02j1We5d+jrADsr/fx/ksfx8s/YantCSz6AVf4bbPg tEDzPZ14Zdy3Sk0PVa6zfbVquWp+JdAekThmGViNqGxE8lh7/X9br4KzIgkxMalhO8Rg bLy81oCjWmHqc3puB9qsnRFlUsRQo6JquNOHfePPldD/0L6AT0Yqjir3BmA1cQ/nfV53 x4zS4DTSzYvv+CHkKgnlqOoD+EDmu9q/QknRtoJdfznopC0cXRWpFJtJlLULGrOMPsUK aNrVhGSb38IXCDRG+X9ZwnP6arVwhPhMMDCbfvrhFywn3hGcNiLMx+u90C4bnAbOLETY VUAg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=cZmxhO8Ua6HfhbJqYgf1vh7riK06m+t8EzfL2eNpEIM=; b=JRyagguiBs5h+nD323W5TVJFKAc2a9W4QdqgxdV69HaVtx72BJo/Lz6jgnEXrJ7GMG T55/bmChSn+RBuo7Uw4AsNmoS6otOQgslYngPIJggnoqVw6FaxEVY5tw5b8hluSyTQiO wdPkJLWUZhRaEgDeQ7VlDwtdstRN4UKr3Ymkmq7f5U5JTvz3aAGmApovsUCasZQRIqdj Zu9NZvff6lUjmS5NiqxaWTUi+UviHl+OOkOdmsSKLgmObptDvlbskP6i1ybhSep7a1B0 penZFHm4klu07IgLqqiIMCwiHrQQDP5IjnlO5Z4ZvBUe9wHYgoLQONDl9vZx8+BMevgf ILxQ== X-Gm-Message-State: AOAM533aoB90dacWay5EGhN6QX1XkWRcJM+oI09snuU296uwELQZKa4i GW07lG9jxOfcFERduLL9lpqj8RSY0cnHnw== X-Google-Smtp-Source: ABdhPJxcQj6qlDW/EYup8cwJ8hQZ9H10ApE/SMZ9qEqxDi1p41zbc99iFIRyuPJdv230LLRQeBvCCQ== X-Received: by 2002:a5d:490b:: with SMTP id x11mr17103494wrq.322.1627905504750; Mon, 02 Aug 2021 04:58:24 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.24 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:24 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 15/21] docs/about/removed-features: Fix markup error Date: Mon, 2 Aug 2021 12:58:06 +0100 Message-Id: <20210802115812.10731-16-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42a; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42a.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" The section describing the removed feature "-usbdevice ccid" had a typo so the markup started with single backtick and ended with double backtick; fix it. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726142338.31872-10-peter.maydell@linaro.org --- docs/about/removed-features.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.rst index 28bb035043d..07d597847c9 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -124,7 +124,7 @@ devices. Drives the board doesn't pick up can no longer be used with ''''''''''''''''''''''''''''''''''''' This option was undocumented and not used in the field. -Use `-device usb-ccid`` instead. +Use ``-device usb-ccid`` instead. RISC-V firmware not booted by default (removed in 5.1) '''''''''''''''''''''''''''''''''''''''''''''''''''''' From patchwork Mon Aug 2 11:58:07 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413843 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 4FF63C4338F for ; Mon, 2 Aug 2021 12:15:51 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 0156C60EFD for ; Mon, 2 Aug 2021 12:15:50 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0156C60EFD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:59084 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWrG-0006zU-13 for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:15:50 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50064) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaT-0000m9-5O for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:29 -0400 Received: from mail-wr1-x42b.google.com ([2a00:1450:4864:20::42b]:42924) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaQ-0003cc-L4 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:28 -0400 Received: by mail-wr1-x42b.google.com with SMTP id j2so21114536wrx.9 for ; Mon, 02 Aug 2021 04:58:26 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=lH6HoKCZEt04PFtJPWHcakIzQ8ljYUVe30v5xbEBgvA=; b=kXxOutYZirkqNKNtBXJvWTUvNJQSHsi3SEMOatzkser5sZTtuS3Tc3ctkCtevKfMKr zopvhXK3dWq39BFX9lbLOtT8Qmk916Y/Nu8LppIvbSMvqpYKZTNFfW1tRqSgnFGmBmDX Wex5psFADu8FPmNHTCNdNb2YFkQt5V+3TVbcDDyngBWB3V1EU9oarTsfd7Kx+KDOVJow Tkj6nGgEpAm/KjJTBHp2WCyUBACSbHG/3ZddpKMRBzK94715XJCD+g3GxiaUwgvz1SPP SdIn6HDAR3SBBy9ZbiR7wlpAv950B5p558upVRn+tfNWglQq8cIqU7fSFsq4Cmjfm8HZ q2Tw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=lH6HoKCZEt04PFtJPWHcakIzQ8ljYUVe30v5xbEBgvA=; b=A7HwQRjEln2TbKSRa5yePq2ya5zmztsqI8wwwtxgt8Ks5Ux2SHS7jjADC3DXKz6Gjn liZy5fLYMmmn5NoZckzMFgfGyKbG0O6Ni7sU8Zk2JYDGKrk6H174LjCeS9CNbV1hl6Iq LQrwzZftK++guqfdBwo4nVqs9Ls3EmSTu8KgrTQegx1MIjBl7vrdKcQ02RcGwJ896qy0 XLILqEeSfrw+xx5q8kCx4/sDkW4dYlfUA7DsE4a7G3UkteTLiY7uEp05Omin+bSLlAbr UQ4hURYh5gLfbMfKSaLQjTXwZe/HlYR2oXaEtDYWCXXovAPwK3X5rUheDhY0pe4IcC9n +4hw== X-Gm-Message-State: AOAM5328GxY4kvoq4KM442QLmKJSY8OxEoWYA02XP7SrSBe08CiEQYeL ANG92N9yPLfb5EJw10duWZ618TZbmp8BjQ== X-Google-Smtp-Source: ABdhPJzu8KmOQ8UY9lgdqzrUsuGlmBxqMvnyVIROw7oBr/VuD7bD+uYXbMDS7QpJfHY479ufCnDmhw== X-Received: by 2002:adf:e60c:: with SMTP id p12mr17128008wrm.285.1627905505385; Mon, 02 Aug 2021 04:58:25 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.24 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:25 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 16/21] docs/tools/virtiofsd.rst: Delete stray backtick Date: Mon, 2 Aug 2021 12:58:07 +0100 Message-Id: <20210802115812.10731-17-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42b; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42b.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" The documentation of the posix_acl option has a stray backtick at the end of the text (which is rendered literally into the HTML). Delete it. Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Acked-by: Dr. David Alan Gilbert Message-id: 20210726142338.31872-11-peter.maydell@linaro.org --- docs/tools/virtiofsd.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tools/virtiofsd.rst b/docs/tools/virtiofsd.rst index c4ac7fdf38f..b208f2a6f05 100644 --- a/docs/tools/virtiofsd.rst +++ b/docs/tools/virtiofsd.rst @@ -102,7 +102,7 @@ Options default is ``no_xattr``. * posix_acl|no_posix_acl - - Enable/disable posix acl support. Posix ACLs are disabled by default`. + Enable/disable posix acl support. Posix ACLs are disabled by default. .. option:: --socket-path=PATH From patchwork Mon Aug 2 11:58:08 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413845 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-23.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 67AE0C4338F for ; Mon, 2 Aug 2021 12:18:26 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 0954460FC2 for ; Mon, 2 Aug 2021 12:18:26 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 0954460FC2 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:35230 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWtl-0001vr-0M for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:18:25 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50066) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaT-0000mx-D3 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:29 -0400 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]:39854) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaR-0003dO-Is for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:29 -0400 Received: by mail-wr1-x42e.google.com with SMTP id b11so15836089wrx.6 for ; Mon, 02 Aug 2021 04:58:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=9Zd5jGrXd/MszzUgD83YI5QFWhpJS0mgO3uwRqRD1nw=; b=J+QW6OiABTPIpuUTV8cWhVYJ5Amzp2gRnQihTrVaN5HwqgUREHqDkwM+sryejkT5MZ oMYWeWkOFxunaa0+U5FZ9Wb2UH4PlsLbsUmx8ItvGlr9RYnbrhh2nfvgEykprU4kTsnB 8wgxIp7ybFtiEerAbsOW+YjRQG6RGnzeAjhNaX/Me4AXwVGROC4bzSB9XJyvZIdz/A3i +E5Y6O2N6cXqxF6iFyJqa3F4I4wXzymhawxFelYAiMctLo9rsdg42RWDUlHfX3GJAmJG dIulohDFWFmW+AOnzgmsNGeqpFgLpK2ViB6jRi7VbfxCqthx4/F7S8FX0PLt9t6bUMza Y0sA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=9Zd5jGrXd/MszzUgD83YI5QFWhpJS0mgO3uwRqRD1nw=; b=VosJoaFl6bTDNA0ZtgWJ0WacqLn2Ld4viQJf7HwhWuZZ19OnAp20PoVtv+orwiEhAW 0qIvI8SRhPnCGiE1RkbqMD2Zq92EiO3wE2zn/ZVZylCAQ0FuVXq1IzRn7HYVRwUkJW0T SMm+sy+mr0QBWpBBFwFw5hN+0vpAvhnlhxOi6qYvSuGJBmNfwv0dWXJnkyE6N/kmQHyB 7IQrBIrwAxhHDEh4vwXXbZ3eYI4ZSHP2HGc3yCq+5/6f0YV0lFp94ZvvW/MYt+g8VWan W1Bh20zrNHfVtZVNTyJGZmR0UxsTg/kfuKgt+qYmAsyyYFnc7K68L1TwEmmod0NhQqq5 I/QQ== X-Gm-Message-State: AOAM532WvK+Na578D0Ununm0/SI7znBT4DB/TvxpyWzUgWYFvmdE1x00 axiXiLWpn3q1I4DBswWENtQKZe1g4T9lvA== X-Google-Smtp-Source: ABdhPJzXz6vK962lHi8euVyJIHYBYJDjauRKL614poI8OpsZRCDwMtlwISay7ff+XbuS9LxJQeCamg== X-Received: by 2002:adf:d1e4:: with SMTP id g4mr3834468wrd.371.1627905506178; Mon, 02 Aug 2021 04:58:26 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.25 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:25 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 17/21] hw/arm/boot: Report error if there is no fw_cfg device in the machine Date: Mon, 2 Aug 2021 12:58:08 +0100 Message-Id: <20210802115812.10731-18-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42e; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x42e.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" If the user provides both a BIOS/firmware image and also a guest kernel filename, arm_setup_firmware_boot() will pass the kernel image to the firmware via the fw_cfg device. However we weren't checking whether there really was a fw_cfg device present, and if there wasn't we would crash. This crash can be provoked with a command line such as qemu-system-aarch64 -M raspi3 -kernel /dev/null -bios /dev/null -display none It is currently only possible on the raspi3 machine, because unless the machine sets info->firmware_loaded we won't call arm_setup_firmware_boot(), and the only machines which set that are: * virt (has a fw-cfg device) * sbsa-ref (checks itself for kernel_filename && firmware_loaded) * raspi3 (crashes) But this is an unfortunate beartrap to leave for future machine model implementors, so we should handle this situation in boot.c. Check in arm_setup_firmware_boot() whether the fw-cfg device exists before trying to load files into it, and if it doesn't exist then exit with a hopefully helpful error message. Because we now handle this check in a machine-agnostic way, we can remove the check from sbsa-ref. Resolves: https://gitlab.com/qemu-project/qemu/-/issues/503 Signed-off-by: Peter Maydell Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210726163351.32086-1-peter.maydell@linaro.org --- hw/arm/boot.c | 9 +++++++++ hw/arm/sbsa-ref.c | 7 ------- 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/hw/arm/boot.c b/hw/arm/boot.c index d7b059225e6..57efb61ee41 100644 --- a/hw/arm/boot.c +++ b/hw/arm/boot.c @@ -1243,6 +1243,15 @@ static void arm_setup_firmware_boot(ARMCPU *cpu, struct arm_boot_info *info) bool try_decompressing_kernel; fw_cfg = fw_cfg_find(); + + if (!fw_cfg) { + error_report("This machine type does not support loading both " + "a guest firmware/BIOS image and a guest kernel at " + "the same time. You should change your QEMU command " + "line to specify one or the other, but not both."); + exit(1); + } + try_decompressing_kernel = arm_feature(&cpu->env, ARM_FEATURE_AARCH64); diff --git a/hw/arm/sbsa-ref.c b/hw/arm/sbsa-ref.c index 43c19b49234..c1629df6031 100644 --- a/hw/arm/sbsa-ref.c +++ b/hw/arm/sbsa-ref.c @@ -691,13 +691,6 @@ static void sbsa_ref_init(MachineState *machine) firmware_loaded = sbsa_firmware_init(sms, sysmem, secure_sysmem); - if (machine->kernel_filename && firmware_loaded) { - error_report("sbsa-ref: No fw_cfg device on this machine, " - "so -kernel option is not supported when firmware loaded, " - "please load OS from hard disk instead"); - exit(1); - } - /* * This machine has EL3 enabled, external firmware should supply PSCI * implementation, so the QEMU's internal PSCI is disabled. From patchwork Mon Aug 2 11:58:09 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413751 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id C7228C4338F for ; Mon, 2 Aug 2021 12:04:57 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 4733F60EFD for ; Mon, 2 Aug 2021 12:04:57 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 4733F60EFD Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:57464 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWgi-00039D-B1 for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:04:56 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50110) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaW-0000tx-1E for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:32 -0400 Received: from mail-wr1-x432.google.com ([2a00:1450:4864:20::432]:43651) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaS-0003dX-Lz for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:31 -0400 Received: by mail-wr1-x432.google.com with SMTP id h14so21135637wrx.10 for ; Mon, 02 Aug 2021 04:58:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=2q93MWkGScylGxqZKXmfrlqZp6+ohhIWphT95erG1oo=; b=SWi6uiUyuTA1+8XcFjIs7hOiRH9WGaZJUOsIuAmWGcQlpXbJljkxDclNGdbkJ6Wju1 AQvQ0obdzLlM2GHNPtOpUAa1x6ysWSDu67e629MWhmnhoqKY/5wMGFqhNY+DjJAFXdxg LXCweJkOarJO4isGL/zRs8qc0UrWrArxFAizq/7e91ORHPT/Dd9pLwWac/3gBjJcUVvK yUPr/bRAfK/mrVrxy/dRTZU/Sw42bV/pIkT3J71HSI5Gu2NzVFaAHwpIZOu6d8rkNXqr ZNJlieLyxOy4Ehje4jjZwYjA4oGzg3cnfGUcaqjZfUWUGjZQCIhc/5F5TvRbs+D0+HAM 6XZg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=2q93MWkGScylGxqZKXmfrlqZp6+ohhIWphT95erG1oo=; b=ljXUWLi9iIbpHeEliDomd17OoyGwn5GqUXdYZjk5KtPgU3HV2tgW4SrCSCken/8hYa nEa7X/S0PDgpOopUPsvpoAAQ41Y/H0L5Kxtl8SGXMPdsocmtvaFxNqss10rsgReGVQY3 EZYE00Bvc/bplY7klsN0Nwts2dqoahTEs3NwlJbyNiz/V9x9+rBZm1EpZ0XEVHbd6Mzu weHdbFunpSF2OwGdZb9gsy8wCXQyTujig7Z/qAeYAlfcb28PwZ6QX4ATXYhwhA5lPzmI aKdxRj4muxm3o2kchXdGh8r8JV91DscI4flcMaGM/oTZFoORqIV+aRlGHVEhk/WO1KXa McQw== X-Gm-Message-State: AOAM532DLBNfLvd3vW0wbSVO6TUbDBigt1kBEnUpI3BYCnV/6ZrRfREr 7D/CM3bIVS10U5sF42UaKNFO3lZyfI50LA== X-Google-Smtp-Source: ABdhPJx7KCfI3gUta57uQZtFaxcFWWxOdxOt3i0+fDIzf6hmisl5h6OuneWls3D/pozz0yL4hVqnog== X-Received: by 2002:adf:c549:: with SMTP id s9mr17318944wrf.344.1627905507306; Mon, 02 Aug 2021 04:58:27 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.26 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:26 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 18/21] docs: Move bootindex.txt into system section and rstify Date: Mon, 2 Aug 2021 12:58:09 +0100 Message-Id: <20210802115812.10731-19-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::432; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x432.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Move bootindex.txt into the system section of the manual and turn it into rST format. To make the document make more sense in the context of the system manual, expand the title and introductory paragraphs to give more context. Signed-off-by: Peter Maydell Reviewed-by: Markus Armbruster Message-id: 20210727194955.7764-1-peter.maydell@linaro.org --- docs/bootindex.txt | 52 --------------------------- docs/system/bootindex.rst | 76 +++++++++++++++++++++++++++++++++++++++ docs/system/index.rst | 1 + 3 files changed, 77 insertions(+), 52 deletions(-) delete mode 100644 docs/bootindex.txt create mode 100644 docs/system/bootindex.rst diff --git a/docs/bootindex.txt b/docs/bootindex.txt deleted file mode 100644 index 6937862ba0d..00000000000 --- a/docs/bootindex.txt +++ /dev/null @@ -1,52 +0,0 @@ -= Bootindex property = - -Block and net devices have bootindex property. This property is used to -determine the order in which firmware will consider devices for booting -the guest OS. If the bootindex property is not set for a device, it gets -lowest boot priority. There is no particular order in which devices with -unset bootindex property will be considered for booting, but they will -still be bootable. - -== Example == - -Let's assume we have a QEMU machine with two NICs (virtio, e1000) and two -disks (IDE, virtio): - -qemu -drive file=disk1.img,if=none,id=disk1 - -device ide-hd,drive=disk1,bootindex=4 - -drive file=disk2.img,if=none,id=disk2 - -device virtio-blk-pci,drive=disk2,bootindex=3 - -netdev type=user,id=net0 -device virtio-net-pci,netdev=net0,bootindex=2 - -netdev type=user,id=net1 -device e1000,netdev=net1,bootindex=1 - -Given the command above, firmware should try to boot from the e1000 NIC -first. If this fails, it should try the virtio NIC next; if this fails -too, it should try the virtio disk, and then the IDE disk. - -== Limitations == - -1. Some firmware has limitations on which devices can be considered for -booting. For instance, the PC BIOS boot specification allows only one -disk to be bootable. If boot from disk fails for some reason, the BIOS -won't retry booting from other disk. It can still try to boot from -floppy or net, though. - -2. Sometimes, firmware cannot map the device path QEMU wants firmware to -boot from to a boot method. It doesn't happen for devices the firmware -can natively boot from, but if firmware relies on an option ROM for -booting, and the same option ROM is used for booting from more then one -device, the firmware may not be able to ask the option ROM to boot from -a particular device reliably. For instance with the PC BIOS, if a SCSI HBA -has three bootable devices target1, target3, target5 connected to it, -the option ROM will have a boot method for each of them, but it is not -possible to map from boot method back to a specific target. This is a -shortcoming of the PC BIOS boot specification. - -== Mixing bootindex and boot order parameters == - -Note that it does not make sense to use the bootindex property together -with the "-boot order=..." (or "-boot once=...") parameter. The guest -firmware implementations normally either support the one or the other, -but not both parameters at the same time. Mixing them will result in -undefined behavior, and thus the guest firmware will likely not boot -from the expected devices. diff --git a/docs/system/bootindex.rst b/docs/system/bootindex.rst new file mode 100644 index 00000000000..8b057f812f2 --- /dev/null +++ b/docs/system/bootindex.rst @@ -0,0 +1,76 @@ +Managing device boot order with bootindex properties +==================================================== + +QEMU can tell QEMU-aware guest firmware (like the x86 PC BIOS) +which order it should look for a bootable OS on which devices. +A simple way to set this order is to use the ``-boot order=`` option, +but you can also do this more flexibly, by setting a ``bootindex`` +property on the individual block or net devices you specify +on the QEMU command line. + +The ``bootindex`` properties are used to determine the order in which +firmware will consider devices for booting the guest OS. If the +``bootindex`` property is not set for a device, it gets the lowest +boot priority. There is no particular order in which devices with no +``bootindex`` property set will be considered for booting, but they +will still be bootable. + +Some guest machine types (for instance the s390x machines) do +not support ``-boot order=``; on those machines you must always +use ``bootindex`` properties. + +There is no way to set a ``bootindex`` property if you are using +a short-form option like ``-hda`` or ``-cdrom``, so to use +``bootindex`` properties you will need to expand out those options +into long-form ``-drive`` and ``-device`` option pairs. + +Example +------- + +Let's assume we have a QEMU machine with two NICs (virtio, e1000) and two +disks (IDE, virtio): + +.. parsed-literal:: + + |qemu_system| -drive file=disk1.img,if=none,id=disk1 \\ + -device ide-hd,drive=disk1,bootindex=4 \\ + -drive file=disk2.img,if=none,id=disk2 \\ + -device virtio-blk-pci,drive=disk2,bootindex=3 \\ + -netdev type=user,id=net0 \\ + -device virtio-net-pci,netdev=net0,bootindex=2 \\ + -netdev type=user,id=net1 \\ + -device e1000,netdev=net1,bootindex=1 + +Given the command above, firmware should try to boot from the e1000 NIC +first. If this fails, it should try the virtio NIC next; if this fails +too, it should try the virtio disk, and then the IDE disk. + +Limitations +----------- + +Some firmware has limitations on which devices can be considered for +booting. For instance, the PC BIOS boot specification allows only one +disk to be bootable. If boot from disk fails for some reason, the BIOS +won't retry booting from other disk. It can still try to boot from +floppy or net, though. + +Sometimes, firmware cannot map the device path QEMU wants firmware to +boot from to a boot method. It doesn't happen for devices the firmware +can natively boot from, but if firmware relies on an option ROM for +booting, and the same option ROM is used for booting from more then one +device, the firmware may not be able to ask the option ROM to boot from +a particular device reliably. For instance with the PC BIOS, if a SCSI HBA +has three bootable devices target1, target3, target5 connected to it, +the option ROM will have a boot method for each of them, but it is not +possible to map from boot method back to a specific target. This is a +shortcoming of the PC BIOS boot specification. + +Mixing bootindex and boot order parameters +------------------------------------------ + +Note that it does not make sense to use the bootindex property together +with the ``-boot order=...`` (or ``-boot once=...``) parameter. The guest +firmware implementations normally either support the one or the other, +but not both parameters at the same time. Mixing them will result in +undefined behavior, and thus the guest firmware will likely not boot +from the expected devices. diff --git a/docs/system/index.rst b/docs/system/index.rst index 64a424ae99b..650409d1566 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -26,6 +26,7 @@ or Hypervisor.Framework. authz gdb managed-startup + bootindex cpu-hotplug pr-manager targets From patchwork Mon Aug 2 11:58:10 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413873 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-23.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id BD70BC4338F for ; Mon, 2 Aug 2021 12:20:46 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 4ED4160FC2 for ; Mon, 2 Aug 2021 12:20:46 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 4ED4160FC2 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:41624 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWw1-0006XK-Ec for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:20:45 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50122) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaW-0000wE-J4 for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:32 -0400 Received: from mail-wr1-x435.google.com ([2a00:1450:4864:20::435]:43654) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaT-0003dt-RB for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:32 -0400 Received: by mail-wr1-x435.google.com with SMTP id h14so21135704wrx.10 for ; Mon, 02 Aug 2021 04:58:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=aypbuCkXg4mRE91Ka+IebcFEmi1TOPTuW9gsne4BRxE=; b=Y+xxBOrWJTreODgsZLkd1X6beKsQzPucAZLoF4YiEf1cZYbD8D+eAN/9vckjXfixPx S0xGGosBeq1dCbB1ftv3hw3JldlCg6iUt3bMiTixckYkLiRVVJf7VcprTFwCPYjzvIil CRSqjHC7vWQtxZI7QX7SHpOkAb/o2NGYVrEYBAPBA8dEzYr5Obm/qJlHH+zHj0YcH3Ij z8CL4WI74NqNIeKSfPHsTpm/0fwF8L0OggvhrMtL90ijeR/rkjZmNtynTJ4WSLap22Go +i3KY4n08FLUBKTFtBO3dee29urSL/SjqcELH3hh6zmkg6TbV3WoQ2t2p8pmXkKfXOPR b43A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=aypbuCkXg4mRE91Ka+IebcFEmi1TOPTuW9gsne4BRxE=; b=YyXg5cFP6j/lfSvfXfRBNxS+qhlu4ef9WxrKrDAPvlbmRGR3WLDJucWvSxbUsl/a5s EuT17u+4vAapdf81d541/lZB26mP3w6vHlFJxE7ZGbf+Q83C2hlkcyeAV5qEvL/7xsLe qlXGm81meuyPGwooWlGou3Sp1xbrltPhW9UNlZl5DbyUagtgDk8ik/U3h4pn46OBdtfS aqBouU+gmNKcLgKCLmpt5k9XqvmHGtZcDlbrK2xQ2nSP2rfePaHE/YfttXJsmCGPF+2Z nyDJ6r8wo17KJNWmqXJVKovQbne0kEw0f1pCoPEy6seYUf9MKLtAPFtkl1jLcXV1wo6J y1Vw== X-Gm-Message-State: AOAM532gNs6QbzUgJLMB2vtIbdacPQKEmT1MJ3YMp/ii7G5g9tjOxqG9 atNbLPvlZkE02/o52ro+9HI1hlZXCE2OEA== X-Google-Smtp-Source: ABdhPJxhzXKBfHPouPldtv/bg6sOF+lInqSrdwPJXIKN3+0cnRhh5MPmvP4rsWuBXmI4fX9jxsEpjg== X-Received: by 2002:a5d:4d85:: with SMTP id b5mr16896292wru.317.1627905508325; Mon, 02 Aug 2021 04:58:28 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.27 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:28 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 19/21] docs: Move the protocol part of barrier.txt into interop Date: Mon, 2 Aug 2021 12:58:10 +0100 Message-Id: <20210802115812.10731-20-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::435; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x435.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Most of docs/barrier.txt is describing the protocol implemented by the input-barrier device. Move this into the interop section of the manual, and rstify it. Signed-off-by: Peter Maydell Reviewed-by: Paolo Bonzini Reviewed-by: Laurent Vivier Message-id: 20210727204112.12579-2-peter.maydell@linaro.org --- docs/barrier.txt | 318 ----------------------------- docs/interop/barrier.rst | 426 +++++++++++++++++++++++++++++++++++++++ docs/interop/index.rst | 1 + 3 files changed, 427 insertions(+), 318 deletions(-) create mode 100644 docs/interop/barrier.rst diff --git a/docs/barrier.txt b/docs/barrier.txt index b21d15015d9..376d0b2d709 100644 --- a/docs/barrier.txt +++ b/docs/barrier.txt @@ -45,324 +45,6 @@ (qemu) object_del barrier0 (qemu) object_add input-barrier,id=barrier0,name=VM-1 - -* Message format - - Message format between the server and client is in two parts: - - 1- the payload length is a 32bit integer in network endianness, - 2- the payload - - The payload starts with a 4byte string (without NUL) which is the - command. The first command between the server and the client - is the only command not encoded on 4 bytes ("Barrier"). - The remaining part of the payload is decoded according to the command. - -* Protocol Description (from barrier/src/lib/barrier/protocol_types.h) - - - barrierCmdHello "Barrier" - - Direction: server -> client - Parameters: { int16_t minor, int16_t major } - Description: - - Say hello to client - minor = protocol major version number supported by server - major = protocol minor version number supported by server - - - barrierCmdHelloBack "Barrier" - - Direction: client ->server - Parameters: { int16_t minor, int16_t major, char *name} - Description: - - Respond to hello from server - minor = protocol major version number supported by client - major = protocol minor version number supported by client - name = client name - - - barrierCmdDInfo "DINF" - - Direction: client ->server - Parameters: { int16_t x_origin, int16_t y_origin, int16_t width, int16_t height, int16_t x, int16_t y} - Description: - - The client screen must send this message in response to the - barrierCmdQInfo message. It must also send this message when the - screen's resolution changes. In this case, the client screen should - ignore any barrierCmdDMouseMove messages until it receives a - barrierCmdCInfoAck in order to prevent attempts to move the mouse off - the new screen area. - - - barrierCmdCNoop "CNOP" - - Direction: client -> server - Parameters: None - Description: - - No operation - - - barrierCmdCClose "CBYE" - - Direction: server -> client - Parameters: None - Description: - - Close connection - - - barrierCmdCEnter "CINN" - - Direction: server -> client - Parameters: { int16_t x, int16_t y, int32_t seq, int16_t modifier } - Description: - - Enter screen. - x,y = entering screen absolute coordinates - seq = sequence number, which is used to order messages between - screens. the secondary screen must return this number - with some messages - modifier = modifier key mask. this will have bits set for each - toggle modifier key that is activated on entry to the - screen. the secondary screen should adjust its toggle - modifiers to reflect that state. - - - barrierCmdCLeave "COUT" - - Direction: server -> client - Parameters: None - Description: - - Leaving screen. the secondary screen should send clipboard data in - response to this message for those clipboards that it has grabbed - (i.e. has sent a barrierCmdCClipboard for and has not received a - barrierCmdCClipboard for with a greater sequence number) and that - were grabbed or have changed since the last leave. - - - barrierCmdCClipboard "CCLP" - - Direction: server -> client - Parameters: { int8_t id, int32_t seq } - Description: - - Grab clipboard. Sent by screen when some other app on that screen - grabs a clipboard. - id = the clipboard identifier - seq = sequence number. Client must use the sequence number passed in - the most recent barrierCmdCEnter. the server always sends 0. - - - barrierCmdCScreenSaver "CSEC" - - Direction: server -> client - Parameters: { int8_t started } - Description: - - Screensaver change. - started = Screensaver on primary has started (1) or closed (0) - - - barrierCmdCResetOptions "CROP" - - Direction: server -> client - Parameters: None - Description: - - Reset options. Client should reset all of its options to their - defaults. - - - barrierCmdCInfoAck "CIAK" - - Direction: server -> client - Parameters: None - Description: - - Resolution change acknowledgment. Sent by server in response to a - client screen's barrierCmdDInfo. This is sent for every - barrierCmdDInfo, whether or not the server had sent a barrierCmdQInfo. - - - barrierCmdCKeepAlive "CALV" - - Direction: server -> client - Parameters: None - Description: - - Keep connection alive. Sent by the server periodically to verify - that connections are still up and running. clients must reply in - kind on receipt. if the server gets an error sending the message or - does not receive a reply within a reasonable time then the server - disconnects the client. if the client doesn't receive these (or any - message) periodically then it should disconnect from the server. the - appropriate interval is defined by an option. - - - barrierCmdDKeyDown "DKDN" - - Direction: server -> client - Parameters: { int16_t keyid, int16_t modifier [,int16_t button] } - Description: - - Key pressed. - keyid = X11 key id - modified = modified mask - button = X11 Xkb keycode (optional) - - - barrierCmdDKeyRepeat "DKRP" - - Direction: server -> client - Parameters: { int16_t keyid, int16_t modifier, int16_t repeat [,int16_t button] } - Description: - - Key auto-repeat. - keyid = X11 key id - modified = modified mask - repeat = number of repeats - button = X11 Xkb keycode (optional) - - - barrierCmdDKeyUp "DKUP" - - Direction: server -> client - Parameters: { int16_t keyid, int16_t modifier [,int16_t button] } - Description: - - Key released. - keyid = X11 key id - modified = modified mask - button = X11 Xkb keycode (optional) - - - barrierCmdDMouseDown "DMDN" - - Direction: server -> client - Parameters: { int8_t button } - Description: - - Mouse button pressed. - button = button id - - - barrierCmdDMouseUp "DMUP" - - Direction: server -> client - Parameters: { int8_t button } - Description: - - Mouse button release. - button = button id - - - barrierCmdDMouseMove "DMMV" - - Direction: server -> client - Parameters: { int16_t x, int16_t y } - Description: - - Absolute mouse moved. - x,y = absolute screen coordinates - - - barrierCmdDMouseRelMove "DMRM" - - Direction: server -> client - Parameters: { int16_t x, int16_t y } - Description: - - Relative mouse moved. - x,y = r relative screen coordinates - - - barrierCmdDMouseWheel "DMWM" - - Direction: server -> client - Parameters: { int16_t x , int16_t y } or { int16_t y } - Description: - - Mouse scroll. The delta should be +120 for one tick forward (away - from the user) or right and -120 for one tick backward (toward the - user) or left. - x = x delta - y = y delta - - - barrierCmdDClipboard "DCLP" - - Direction: server -> client - Parameters: { int8_t id, int32_t seq, int8_t mark, char *data } - Description: - - Clipboard data. - id = clipboard id - seq = sequence number. The sequence number is 0 when sent by the - server. Client screens should use the/ sequence number from - the most recent barrierCmdCEnter. - - - barrierCmdDSetOptions "DSOP" - - Direction: server -> client - Parameters: { int32 t nb, { int32_t id, int32_t val }[] } - Description: - - Set options. Client should set the given option/value pairs. - nb = numbers of { id, val } entries - id = option id - val = option new value - - - barrierCmdDFileTransfer "DFTR" - - Direction: server -> client - Parameters: { int8_t mark, char *content } - Description: - - Transfer file data. - mark = 0 means the content followed is the file size - 1 means the content followed is the chunk data - 2 means the file transfer is finished - - - barrierCmdDDragInfo "DDRG" int16_t char * - - Direction: server -> client - Parameters: { int16_t nb, char *content } - Description: - - Drag information. - nb = number of dragging objects - content = object's directory - - - barrierCmdQInfo "QINF" - - Direction: server -> client - Parameters: None - Description: - - Query screen info - Client should reply with a barrierCmdDInfo - - - barrierCmdEIncompatible "EICV" - - Direction: server -> client - Parameters: { int16_t nb, major *minor } - Description: - - Incompatible version. - major = major version - minor = minor version - - - barrierCmdEBusy "EBSY" - - Direction: server -> client - Parameters: None - Description: - - Name provided when connecting is already in use. - - - barrierCmdEUnknown "EUNK" - - Direction: server -> client - Parameters: None - Description: - - Unknown client. Name provided when connecting is not in primary's - screen configuration map. - - - barrierCmdEBad "EBAD" - - Direction: server -> client - Parameters: None - Description: - - Protocol violation. Server should disconnect after sending this - message. - * TO DO - Enable SSL diff --git a/docs/interop/barrier.rst b/docs/interop/barrier.rst new file mode 100644 index 00000000000..055f2c1aef3 --- /dev/null +++ b/docs/interop/barrier.rst @@ -0,0 +1,426 @@ +Barrier client protocol +======================= + +QEMU's ``input-barrier`` device implements the client end of +the KVM (Keyboard-Video-Mouse) software +`Barrier `__. + +This document briefly describes the protocol as we implement it. + +Message format +-------------- + +Message format between the server and client is in two parts: + +#. the payload length, a 32bit integer in network endianness +#. the payload + +The payload starts with a 4byte string (without NUL) which is the +command. The first command between the server and the client +is the only command not encoded on 4 bytes ("Barrier"). +The remaining part of the payload is decoded according to the command. + +Protocol Description +-------------------- + +This comes from ``barrier/src/lib/barrier/protocol_types.h``. + +barrierCmdHello "Barrier" +^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t minor, int16_t major }`` +Description: + Say hello to client + + ``minor`` = protocol major version number supported by server + + ``major`` = protocol minor version number supported by server + +barrierCmdHelloBack "Barrier" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + client ->server +Parameters: + ``{ int16_t minor, int16_t major, char *name}`` +Description: + Respond to hello from server + + ``minor`` = protocol major version number supported by client + + ``major`` = protocol minor version number supported by client + + ``name`` = client name + +barrierCmdDInfo "DINF" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + client ->server +Parameters: + ``{ int16_t x_origin, int16_t y_origin, int16_t width, int16_t height, int16_t x, int16_t y}`` +Description: + The client screen must send this message in response to the + barrierCmdQInfo message. It must also send this message when the + screen's resolution changes. In this case, the client screen should + ignore any barrierCmdDMouseMove messages until it receives a + barrierCmdCInfoAck in order to prevent attempts to move the mouse off + the new screen area. + +barrierCmdCNoop "CNOP" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + client -> server +Parameters: + None +Description: + No operation + +barrierCmdCClose "CBYE" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Close connection + +barrierCmdCEnter "CINN" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t x, int16_t y, int32_t seq, int16_t modifier }`` +Description: + Enter screen. + + ``x``, ``y`` = entering screen absolute coordinates + + ``seq`` = sequence number, which is used to order messages between + screens. the secondary screen must return this number + with some messages + + ``modifier`` = modifier key mask. this will have bits set for each + toggle modifier key that is activated on entry to the + screen. the secondary screen should adjust its toggle + modifiers to reflect that state. + +barrierCmdCLeave "COUT" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Leaving screen. the secondary screen should send clipboard data in + response to this message for those clipboards that it has grabbed + (i.e. has sent a barrierCmdCClipboard for and has not received a + barrierCmdCClipboard for with a greater sequence number) and that + were grabbed or have changed since the last leave. + +barrierCmdCClipboard "CCLP" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int8_t id, int32_t seq }`` +Description: + Grab clipboard. Sent by screen when some other app on that screen + grabs a clipboard. + + ``id`` = the clipboard identifier + + ``seq`` = sequence number. Client must use the sequence number passed in + the most recent barrierCmdCEnter. the server always sends 0. + +barrierCmdCScreenSaver "CSEC" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int8_t started }`` +Description: + Screensaver change. + + ``started`` = Screensaver on primary has started (1) or closed (0) + +barrierCmdCResetOptions "CROP" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Reset options. Client should reset all of its options to their + defaults. + +barrierCmdCInfoAck "CIAK" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Resolution change acknowledgment. Sent by server in response to a + client screen's barrierCmdDInfo. This is sent for every + barrierCmdDInfo, whether or not the server had sent a barrierCmdQInfo. + +barrierCmdCKeepAlive "CALV" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Keep connection alive. Sent by the server periodically to verify + that connections are still up and running. clients must reply in + kind on receipt. if the server gets an error sending the message or + does not receive a reply within a reasonable time then the server + disconnects the client. if the client doesn't receive these (or any + message) periodically then it should disconnect from the server. the + appropriate interval is defined by an option. + +barrierCmdDKeyDown "DKDN" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t keyid, int16_t modifier [,int16_t button] }`` +Description: + Key pressed. + + ``keyid`` = X11 key id + + ``modified`` = modified mask + + ``button`` = X11 Xkb keycode (optional) + +barrierCmdDKeyRepeat "DKRP" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t keyid, int16_t modifier, int16_t repeat [,int16_t button] }`` +Description: + Key auto-repeat. + + ``keyid`` = X11 key id + + ``modified`` = modified mask + + ``repeat`` = number of repeats + + ``button`` = X11 Xkb keycode (optional) + +barrierCmdDKeyUp "DKUP" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t keyid, int16_t modifier [,int16_t button] }`` +Description: + Key released. + + ``keyid`` = X11 key id + + ``modified`` = modified mask + + ``button`` = X11 Xkb keycode (optional) + +barrierCmdDMouseDown "DMDN" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int8_t button }`` +Description: + Mouse button pressed. + + ``button`` = button id + +barrierCmdDMouseUp "DMUP" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int8_t button }`` +Description: + Mouse button release. + + ``button`` = button id + +barrierCmdDMouseMove "DMMV" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t x, int16_t y }`` +Description: + Absolute mouse moved. + + ``x``, ``y`` = absolute screen coordinates + +barrierCmdDMouseRelMove "DMRM" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t x, int16_t y }`` +Description: + Relative mouse moved. + + ``x``, ``y`` = r relative screen coordinates + +barrierCmdDMouseWheel "DMWM" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t x , int16_t y }`` or ``{ int16_t y }`` +Description: + Mouse scroll. The delta should be +120 for one tick forward (away + from the user) or right and -120 for one tick backward (toward the + user) or left. + + ``x`` = x delta + + ``y`` = y delta + +barrierCmdDClipboard "DCLP" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int8_t id, int32_t seq, int8_t mark, char *data }`` +Description: + Clipboard data. + + ``id`` = clipboard id + + ``seq`` = sequence number. The sequence number is 0 when sent by the + server. Client screens should use the/ sequence number from + the most recent barrierCmdCEnter. + +barrierCmdDSetOptions "DSOP" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int32 t nb, { int32_t id, int32_t val }[] }`` +Description: + Set options. Client should set the given option/value pairs. + + ``nb`` = numbers of ``{ id, val }`` entries + + ``id`` = option id + + ``val`` = option new value + +barrierCmdDFileTransfer "DFTR" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int8_t mark, char *content }`` +Description: + Transfer file data. + + * ``mark`` = 0 means the content followed is the file size + * 1 means the content followed is the chunk data + * 2 means the file transfer is finished + +barrierCmdDDragInfo "DDRG" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t nb, char *content }`` +Description: + Drag information. + + ``nb`` = number of dragging objects + + ``content`` = object's directory + +barrierCmdQInfo "QINF" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Query screen info + + Client should reply with a barrierCmdDInfo + +barrierCmdEIncompatible "EICV" +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + ``{ int16_t nb, major *minor }`` +Description: + Incompatible version. + + ``major`` = major version + + ``minor`` = minor version + +barrierCmdEBusy "EBSY" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Name provided when connecting is already in use. + +barrierCmdEUnknown "EUNK" +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Unknown client. Name provided when connecting is not in primary's + screen configuration map. + +barrierCmdEBad "EBAD" +^^^^^^^^^^^^^^^^^^^^^^^ + +Direction: + server -> client +Parameters: + None +Description: + Protocol violation. Server should disconnect after sending this + message. + diff --git a/docs/interop/index.rst b/docs/interop/index.rst index b1bab81e2ee..f9801a9c202 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -7,6 +7,7 @@ are useful for making QEMU interoperate with other software. .. toctree:: :maxdepth: 2 + barrier bitmaps dbus dbus-vmstate From patchwork Mon Aug 2 11:58:11 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413743 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 54685C4338F for ; Mon, 2 Aug 2021 12:01:21 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 1AA1060EBC for ; Mon, 2 Aug 2021 12:01:21 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 1AA1060EBC Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:48854 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWdC-0005q8-NY for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:01:18 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50106) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaV-0000sz-LA for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:31 -0400 Received: from mail-wr1-x430.google.com ([2a00:1450:4864:20::430]:36490) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaU-0003eE-7U for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:31 -0400 Received: by mail-wr1-x430.google.com with SMTP id b13so10310611wrs.3 for ; Mon, 02 Aug 2021 04:58:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=9dbyq1yCrycHM80bLpDWIuG3WyndUcqs1WyZ9Er/ZQc=; b=f+TQGJrljWqI9gvMnmZe/gNs2kuoEiMJaZ9vJlhCiY2Xg7Df5lD4S6DG1vVyuuT1Mq xlZMPH2AA4vJw8nZFhULTPbDSmmyRq4cYGs/javuJuKufkYx8WbMDhI5IlyE9uR95f9Z kyWXguN4doqXE2VGisr0vR2LkT4OW1gh2Iv6uLB3iw4Ukh/FCA5ySYjf8pzjV3Jf8wzc fZ6ZFWODkNq0vNOSIKeykYN1t+GcxDH7m+Aef61pQQGut6YrlTSJDgiydO8aUxPHK/MW g0QtF/8425UkoM4dP4+UP3sRg7h+sfS+pDaVjrAWLdgW5/iwqFJJjKowFhVI4sHiaAtl tW0A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=9dbyq1yCrycHM80bLpDWIuG3WyndUcqs1WyZ9Er/ZQc=; b=LUkaqo5lJNvijmVe5a5OygGL6HgXhO2F5Yh1jbE6oaX56/1vATWAQKam5lpiR5QVwU bkjs8KKvPDFSQShN2AX2p7/ZjD3nIpmRWRxRxgyiyEyMmMN9+LsGuqKWE1dX1q+sDsbD VhLVxUnk/1RR0voCKNJb2DW8eCn9bSsl3qWjv+nlNwIrkrkXuYMIVxoYm2ofkenebsOy kvZgT2WN5vPf+j0tAlbUb2apN37w6k3lvk2bpoCYLUxGAKGnULIIcmjRAQaFbR1bhWT/ ReL/7eZvF/FCYHAL2hykIKP47jP6SYSew6/GPohAl9szxuzhtOpF99FdI98FbTvBkMv3 HfBQ== X-Gm-Message-State: AOAM530E9WWzPyGHjSMyfFZfhHJYE8rLs0SLWp4NvziWUtMCGlkJJ9gZ sueeFVJcexUtqPjsVUxBS8rnm4tu9Ittpg== X-Google-Smtp-Source: ABdhPJz5wYoJYlTs/x2/YV03b3J0eGcLPmDoo/kxOIxAlN4S/faOTJHUhmSBQ909tw2wCJZmwHMDhA== X-Received: by 2002:a5d:540d:: with SMTP id g13mr16871132wrv.329.1627905508971; Mon, 02 Aug 2021 04:58:28 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.28 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:28 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 20/21] ui/input-barrier: Move TODOs from barrier.txt to a comment Date: Mon, 2 Aug 2021 12:58:11 +0100 Message-Id: <20210802115812.10731-21-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::430; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x430.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" docs/barrier.txt has a couple of TODO notes about things to be implemented in this device; move them into a comment in the source code. Signed-off-by: Peter Maydell Reviewed-by: Paolo Bonzini Reviewed-by: Laurent Vivier Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210727204112.12579-3-peter.maydell@linaro.org --- docs/barrier.txt | 4 ---- ui/input-barrier.c | 5 +++++ 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/barrier.txt b/docs/barrier.txt index 376d0b2d709..54cb5fd8efc 100644 --- a/docs/barrier.txt +++ b/docs/barrier.txt @@ -45,8 +45,4 @@ (qemu) object_del barrier0 (qemu) object_add input-barrier,id=barrier0,name=VM-1 -* TO DO - - - Enable SSL - - Manage SetOptions/ResetOptions commands diff --git a/ui/input-barrier.c b/ui/input-barrier.c index 81b8d04ec8d..2d57ca70791 100644 --- a/ui/input-barrier.c +++ b/ui/input-barrier.c @@ -3,6 +3,11 @@ * * This work is licensed under the terms of the GNU GPL, version 2 or later. * See the COPYING file in the top-level directory. + * + * TODO: + * + * - Enable SSL + * - Manage SetOptions/ResetOptions commands */ #include "qemu/osdep.h" From patchwork Mon Aug 2 11:58:12 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 12413841 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-23.7 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_HELO_NONE,SPF_PASS, URIBL_BLOCKED,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 918CEC4338F for ; Mon, 2 Aug 2021 12:15:33 +0000 (UTC) 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 mail.kernel.org (Postfix) with ESMTPS id 3B24860FA0 for ; Mon, 2 Aug 2021 12:15:33 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.4.1 mail.kernel.org 3B24860FA0 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=linaro.org Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=nongnu.org Received: from localhost ([::1]:58828 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mAWqy-0006pN-1R for qemu-devel@archiver.kernel.org; Mon, 02 Aug 2021 08:15:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:50130) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mAWaX-0000y3-5h for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:33 -0400 Received: from mail-wr1-x436.google.com ([2a00:1450:4864:20::436]:33643) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1mAWaU-0003en-SM for qemu-devel@nongnu.org; Mon, 02 Aug 2021 07:58:32 -0400 Received: by mail-wr1-x436.google.com with SMTP id k4so10353243wrc.0 for ; Mon, 02 Aug 2021 04:58:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:subject:date:message-id:in-reply-to:references:mime-version :content-transfer-encoding; bh=nGpfpSEqJjfEaG1N2BaqzOf+zX9fc5AolwWGoQxIdJg=; b=Ss/mBjYikQSQbyqi8kwR1W7m3JHs7fcLCDQ5LQtpfF0+zHsEe8Rhasisu2J3Fhxp5S ix2Sfq7Fy2hVHJ3Gyvi1DyYH80iKrxj/Yi2YOcLXanDoVsR1i3z4I4Iz4ew37XFHOrIT wTZ2CcVy1lX7ntdu1CcUwXo9cLRTi2ZWy3LPeDBY8OlpqZkk1nbOlO52Lsbu6n6bxSfm +P1cpu0kq+juAVyQtqOFZEg0qlVFxoWSx5ILHnf7+zeXuqaI2unHQOlAJ4JRmS4X76K5 R5DF5guLqc9Xco4Td/HWiylWjGeyiCRqoCgQiWCCoUM8wD8+gVlJZVIThrlJq+/Xbpvy vLuQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=nGpfpSEqJjfEaG1N2BaqzOf+zX9fc5AolwWGoQxIdJg=; b=ntAvMs+jwHJlfj7b86LQgAVzwuzBjTeMKq1mWSbhQsHMc8SzkW8dsHz4q+vYc1zBRf dJqhx1U8BBSjZyP5k+aKUko72AtpuwSVSO498RnQGYEKve55kR9vhJvDegVBe3SP4127 wTieLZ4qMDKlGoa/RfTJoEMTCCa6IC92LOaiV+Se5AlIeZv3nMTdmqiYdLK5pnAn/9lx EdqLNzIqhklTesyfHXRW2q7sNf2fZSMxmW4Hfn24MUy6Tb89VtsBIw4RxWn2F2UIuNwS aHFJ2mIBfiHdlDTzGMArQerVWhIzfXud1xb4IVT+PTgn8Gdf03MMgHU+z0kdksJ3gsM+ EesA== X-Gm-Message-State: AOAM530lxwjJiaklKRMxdKAtaJtnBmPaQpYEucZef2zlZzWXk/l8gFq1 TDdEhTMurFYDS+CNyYGQNtXKYGbCbvB5Tg== X-Google-Smtp-Source: ABdhPJzX8UAP0Lx+lEmPEy/XjmlZr88msGdhegztmsOXW4Y8bRMoLL4mY4VUJQzqocKK6PLqSBgNIw== X-Received: by 2002:a5d:4b48:: with SMTP id w8mr17322681wrs.109.1627905509595; Mon, 02 Aug 2021 04:58:29 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id y66sm10102772wmy.39.2021.08.02.04.58.29 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 02 Aug 2021 04:58:29 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Subject: [PULL 21/21] docs: Move user-facing barrier docs into system manual Date: Mon, 2 Aug 2021 12:58:12 +0100 Message-Id: <20210802115812.10731-22-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210802115812.10731-1-peter.maydell@linaro.org> References: <20210802115812.10731-1-peter.maydell@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::436; envelope-from=peter.maydell@linaro.org; helo=mail-wr1-x436.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.23 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" The remaining text in docs/barrier.txt is user-facing description of what the device is and how to use it. Move this into the system manual and rstify it. Signed-off-by: Peter Maydell Reviewed-by: Paolo Bonzini Reviewed-by: Laurent Vivier Reviewed-by: Philippe Mathieu-Daudé Message-id: 20210727204112.12579-4-peter.maydell@linaro.org --- docs/barrier.txt | 48 ----------------------------------------- docs/system/barrier.rst | 44 +++++++++++++++++++++++++++++++++++++ docs/system/index.rst | 1 + 3 files changed, 45 insertions(+), 48 deletions(-) delete mode 100644 docs/barrier.txt create mode 100644 docs/system/barrier.rst diff --git a/docs/barrier.txt b/docs/barrier.txt deleted file mode 100644 index 54cb5fd8efc..00000000000 --- a/docs/barrier.txt +++ /dev/null @@ -1,48 +0,0 @@ - QEMU Barrier Client - - -* About - - Barrier is a KVM (Keyboard-Video-Mouse) software forked from Symless's - synergy 1.9 codebase. - - See https://github.com/debauchee/barrier - -* QEMU usage - - Generally, mouse and keyboard are grabbed through the QEMU video - interface emulation. - - But when we want to use a video graphic adapter via a PCI passthrough - there is no way to provide the keyboard and mouse inputs to the VM - except by plugging a second set of mouse and keyboard to the host - or by installing a KVM software in the guest OS. - - The QEMU Barrier client avoids this by implementing directly the Barrier - protocol into QEMU. - - This protocol is enabled by adding an input-barrier object to QEMU. - - Syntax: input-barrier,id=,name= - [,server=][,port=] - [,x-origin=][,y-origin=] - [,width=][,height=] - - The object can be added on the QEMU command line, for instance with: - - ... -object input-barrier,id=barrier0,name=VM-1 ... - - where VM-1 is the name the display configured int the Barrier server - on the host providing the mouse and the keyboard events. - - by default is "localhost", port is 24800, - and are set to 0, and to - 1920 and 1080. - - If Barrier server is stopped QEMU needs to be reconnected manually, - by removing and re-adding the input-barrier object, for instance - with the help of the HMP monitor: - - (qemu) object_del barrier0 - (qemu) object_add input-barrier,id=barrier0,name=VM-1 - diff --git a/docs/system/barrier.rst b/docs/system/barrier.rst new file mode 100644 index 00000000000..155d7d29013 --- /dev/null +++ b/docs/system/barrier.rst @@ -0,0 +1,44 @@ +QEMU Barrier Client +=================== + +Generally, mouse and keyboard are grabbed through the QEMU video +interface emulation. + +But when we want to use a video graphic adapter via a PCI passthrough +there is no way to provide the keyboard and mouse inputs to the VM +except by plugging a second set of mouse and keyboard to the host +or by installing a KVM software in the guest OS. + +The QEMU Barrier client avoids this by implementing directly the Barrier +protocol into QEMU. + +`Barrier `__ +is a KVM (Keyboard-Video-Mouse) software forked from Symless's +synergy 1.9 codebase. + +This protocol is enabled by adding an input-barrier object to QEMU. + +Syntax:: + + input-barrier,id=,name= + [,server=][,port=] + [,x-origin=][,y-origin=] + [,width=][,height=] + +The object can be added on the QEMU command line, for instance with:: + + -object input-barrier,id=barrier0,name=VM-1 + +where VM-1 is the name the display configured in the Barrier server +on the host providing the mouse and the keyboard events. + +by default ```` is ``localhost``, +```` is ``24800``, ```` and ```` are set to ``0``, +```` and ```` to ``1920`` and ``1080``. + +If the Barrier server is stopped QEMU needs to be reconnected manually, +by removing and re-adding the input-barrier object, for instance +with the help of the HMP monitor:: + + (qemu) object_del barrier0 + (qemu) object_add input-barrier,id=barrier0,name=VM-1 diff --git a/docs/system/index.rst b/docs/system/index.rst index 650409d1566..7b9276c05f0 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -20,6 +20,7 @@ or Hypervisor.Framework. linuxboot generic-loader guest-loader + barrier vnc-security tls secrets