From patchwork Thu Apr 20 15:57:15 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675636 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp394457wrs; Thu, 20 Apr 2023 08:58:01 -0700 (PDT) X-Google-Smtp-Source: AKy350b2m7pU6QMnEo5ZM2Q9XnArt0GQGFUaBZPvgx7bRUocC+hyxTePo61adSAp9fkSCzbLz0ik X-Received: by 2002:a05:622a:101:b0:3e4:e8be:c3a4 with SMTP id u1-20020a05622a010100b003e4e8bec3a4mr3021574qtw.56.1682006281509; Thu, 20 Apr 2023 08:58:01 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006281; cv=none; d=google.com; s=arc-20160816; b=H+LOQLQIGMFoCdxVcAi8q0gJgT8n3NcuE+RyV5lSXeFvisU9v22xSKkbyk/N61zdhs uGH/xajJvzRclS0BeDv6SHUnggkA2yjn5BCOLCPO3Vxy+wZkgxcALN76RKq6R9jHUY8S akp1egjb2vsStAOW8x2d+4ZF20uA35AwAMR/ZIvx0DiFZN56o5UmGk0vh+3BrCcyTDAH jS903XItxVsQ4sHRs4HzphLS6BrYmm2EmdCi/m4OGZoH6ldiWQprJNATHh5Q4XAPtA9S rhx/eQM+O2slOEDeOChKLuxqwhv8xxDQAbvgel9wzydclhYTmzzgRvT4vDX4M2fehnDz RdFw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=HYJcS3iHeEAwGWypbyjBIxEOx4FrubTVVdwDYF4Gy2c=; b=n68KMwKCaRSoSI7L+M79k2oZ7e9MAX+jkEDk0HkYf58pc0dhijz41sU9me+T8OKNN/ pJ3awYUxgfWXhktTgIW21a5zipQfLRAZd267AMtCs1qjItsaZQc0CM3va5eVm3RdnwEG e+VLbEQEZf7tam0o8epOoGYHs8meAdY8U85+QopuEviOrqTl2kP1W+sJ+TAMMeU19B5B GqeYLE55cPhtwEHTt8FtW51zjuDne0fTDiNY35fvMXuVZ+ACPVOZDvIl9zrB8Ukzed05 mgGvgAI/M39PlXfebilRrENsk+sasN6cfbLF2lt839qbQ02twJyVzh2mY/FFFShQs0Cs GKUQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=bzPEdQeL; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id s1-20020a05622a1a8100b003ef2f9ac3cdsi1593563qtc.139.2023.04.20.08.58.01 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:58:01 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=bzPEdQeL; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf3-0000Aa-Pq; Thu, 20 Apr 2023 11:57:29 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf1-00009r-QE for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:27 -0400 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf0-0007tg-5H for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:27 -0400 Received: by mail-wm1-x334.google.com with SMTP id 5b1f17b1804b1-3f17b967bfbso22937985e9.1 for ; Thu, 20 Apr 2023 08:57:25 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006244; x=1684598244; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=HYJcS3iHeEAwGWypbyjBIxEOx4FrubTVVdwDYF4Gy2c=; b=bzPEdQeLqUssfR1GMDY0w1UTXat/Us5iWwL5c9njHwNb9d6BKT+2XzwtrASCY5e1Vw LrJ7zTeYYZBw+09tca9uKweq7CvjWDA6ydwWgdVMgAY1wPixguZYB/S4Y+G9v56Zvfhw LIRI0OFg4udgNujHtBGf57eTltDAtejZVIhDIh5nndYghcy7vy1fkQfSWIVj57nCdlhS Fv7reO2XZippAHz9EBHsEjGqFdxj1C8P55TGBn1mZiiMEQVY2Qkdw4dwUKxSvfE8hBsE 72x7U1Gh6JCXZX41Us17wjDqJvrqb1hVRisIDVO51gCJWY51q72gqLIvGZ0EUbm/bX5o t7Sg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006244; x=1684598244; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=HYJcS3iHeEAwGWypbyjBIxEOx4FrubTVVdwDYF4Gy2c=; b=PAGWNIO4BNQgvB4Ko2kb75IHX5x1L+Gd2qKG0sSmvrhdJu6C5YeFDJrtJIQG738Koe TayFpaRD2HFhzXqC124uY+nOS5l1hPOhgnCd4geXRPVloC5YwVYBjKTNLCjZEwZT6xBg bXlL8cbg9M5llpYpYG0lQJE/Nhz6vvag+rUXLUAOPCm/Ox141lOx6vVPpMarAMrxJq/6 I7ob3Tm/iQXfXKMDg2zb8eRiOPQkkLh6BUx/Yepu4fDgpNulbLiyfOOMCAhXMVDwzTUk Z3hKj4SDB1bp2RC6WiL+iVsnfAVVQSFQ5SdRNuZUpo9u3xmhavVFzi/Ezk1/iyhXV8mj UPlQ== X-Gm-Message-State: AAQBX9dReVzEUjts5gKPbvXB7mvJg0EFb5b3hii90Fh73EtWQpk/VTpm OblAi9im0DtOxVGCz0MvBaLfGA== X-Received: by 2002:a5d:4603:0:b0:2fa:a8ad:c49b with SMTP id t3-20020a5d4603000000b002faa8adc49bmr1661016wrq.1.1682006244395; Thu, 20 Apr 2023 08:57:24 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id f11-20020adffccb000000b002f90a75b843sm2249945wrs.117.2023.04.20.08.57.23 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:24 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 9931C1FFB8; Thu, 20 Apr 2023 16:57:23 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour Subject: [PATCH 1/9] docs/devel/kconfig.rst: Fix incorrect markup Date: Thu, 20 Apr 2023 16:57:15 +0100 Message-Id: <20230420155723.1711048-2-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::334; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x334.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Peter Maydell In rST markup syntax, the inline markup (*italics*, **bold** and ``monospaced``) must be separated from the surrending text by non-word characters, otherwise it is not interpreted as markup. To force interpretation as markup in the middle of a word, you need to use a backslash-escaped space (which will not appear as a space in the output). Fix a missing backslash-space in this file, which meant that the `` after "select" was output literally and the monospacing was incorrectly extended all the way to the end of the next monospaced word. Signed-off-by: Peter Maydell Message-Id: <20230411105424.3994585-1-peter.maydell@linaro.org> Reviewed-by: Juan Quintela --- docs/devel/kconfig.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/devel/kconfig.rst b/docs/devel/kconfig.rst index cc1a456edf..ac9453eba9 100644 --- a/docs/devel/kconfig.rst +++ b/docs/devel/kconfig.rst @@ -274,7 +274,7 @@ or commenting out lines in the second group. It is also possible to run QEMU's configure script with the ``--without-default-devices`` option. When this is done, everything defaults -to ``n`` unless it is ``select``ed or explicitly switched on in the +to ``n`` unless it is ``select``\ ed or explicitly switched on in the ``.mak`` files. In other words, ``default`` and ``imply`` directives are disabled. When QEMU is built with this option, the user will probably want to change some lines in the first group, for example like this:: From patchwork Thu Apr 20 15:57:16 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675639 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp394821wrs; Thu, 20 Apr 2023 08:58:57 -0700 (PDT) X-Google-Smtp-Source: AKy350ZIOATu6xCcq621i80XKA7bJRmv+zb3TJqkH4IzPAs2Nn+7uIKSlv9bCyFawA1bhHL/BLNj X-Received: by 2002:ac8:5d8f:0:b0:3ef:3f22:7117 with SMTP id d15-20020ac85d8f000000b003ef3f227117mr3037154qtx.29.1682006337488; Thu, 20 Apr 2023 08:58:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006337; cv=none; d=google.com; s=arc-20160816; b=Gh/d7FjMT6sTqwP1mfwLBgN/SQ+auINM7EXTYiXGSV/DXtBqIJ+qECU2PApHxHpkRT lCOm4AHfm5EP/XL3ndiUQneDvuBwC3h4X0idpo/k6v09f6+2LyJdjtSsVsxfxvZXW+Xz 505mtPFHiHnzRuDtv12+7Ywld31DVnnWiDudVOA6oCF/Jh1JZ5sUpHEMlq8vXT2aYmU7 +6iVP90MaLOSQ49NOeIebabq4/MSw3Gd3mY/zS3o//+6hj1est9A7Kiofg7Z51gjSQnO cvy5AEswbKVQl8c8BW47rfX6pMhvcCTNvYOhPBM9XIxJfbaTC94tkE9BscxpDFyLHMq0 W52A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=qYO+kvYzx9y+m5senjguoiZ6X2J42iIij0ImX9gESJE=; b=Yg/QKGJW4lmPlfpKpOD0/y6/JnFU8Ki81TqB9bFV5xVsCtFjbc5TlT9NNylQcr3aU+ i6FtmWIgrhWsIodeW6IPFGWD+gkErDbyKs1wdagMlwqUk0Vqy7vm8ohIsVBmJnn5rI3b RnCidSt2hfzJQl8flo6KdWXARyT5q8NxAR5iBkkFw6HmTEIcxU/yXh+KW8ncxUIZN158 J8I9MYQu2NLH+2Wm4wbhKVnPlfUFHcKb7nqPJrVgd0x94Uj19dlNTb7VbKNNha5Ve7Lz GdqLm5wp8cXEQ2QPepsXV16Gvx29NCZKQp/UE8j+r48plSwpo0iv06E6gwl1iIuA79L+ YF8A== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=BqZCICpc; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id c9-20020ac87dc9000000b003e3821d43c5si1551523qte.193.2023.04.20.08.58.57 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:58:57 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=BqZCICpc; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf7-0000CO-RO; Thu, 20 Apr 2023 11:57:33 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf3-0000Ab-SR for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:29 -0400 Received: from mail-wr1-x42e.google.com ([2a00:1450:4864:20::42e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf2-0007uD-15 for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:29 -0400 Received: by mail-wr1-x42e.google.com with SMTP id ffacd0b85a97d-2fc3f1d6f8cso485724f8f.3 for ; Thu, 20 Apr 2023 08:57:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006246; x=1684598246; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=qYO+kvYzx9y+m5senjguoiZ6X2J42iIij0ImX9gESJE=; b=BqZCICpchzY2N2hVapKo04csHRSKXTcYZsKGuudQCG57D2E/GuYwYuV6UBZollkFo7 PW0RnRvSmo4Cvt1VynzLvcoUnrnre44HAowgjGK+fgTecSgZixPP39ZeChbKc6C/O13q mGj2nnmhb/DON85upR1Z9wbbrFurMpidzwsYTY7wgK498Vf1zStYIa1gbAMDG482kjxM hb1K3HGer9S/SJd2qZL94y/CLwWqedG01yeWc9qmtMjHYctp1s+5WjnGml59sx51JuRT 91qk/W8fL/Ifgyc6GRU1sgu4RTnLYQMUoJEvrFI9RUav0NiqKmS56k7soZV6B7w/EzGR H9Wg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006246; x=1684598246; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=qYO+kvYzx9y+m5senjguoiZ6X2J42iIij0ImX9gESJE=; b=N5hPMTImI98Qr9vuBLUHkSA+xkoIvuHrHDlqjB/kmum5P9ot5giBIx+ZwittcJJL17 UBilLsr0qqRkdgMmbNnLaIlcTgmAWVMSbU7Cw8kFNtU0VJ226BbubWm3SHa6C4rSl7Ec UWgMVBmn3tkWhIAtypmn4tE7mQRNe4vSesrIKvjhS52j4L2AXfsJGs/ECcUhvO4unIxh 46g8rYUmCv4yYSGyuehB0R1Gw+i6PdYndyFVNMVV+suR5BfH0A0iDZ9C0F7PvbPArUHC Ixi2JLC748fI2dJl5T6U0LM8MRK6lTJ22vyGDDBffR3YypvUGOqUsOQ6E9x0tPkD2QHj x7vQ== X-Gm-Message-State: AAQBX9cxWSsf80MT1SX8kAt1ueUlN97g43r2Y+bSxJ10CI07E4u0xxSo o7mJqSev1E80RS2QqEgzkbq7GQ== X-Received: by 2002:adf:e268:0:b0:2f5:9aa2:e5fc with SMTP id bl40-20020adfe268000000b002f59aa2e5fcmr1328060wrb.28.1682006246075; Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id f4-20020a0560001b0400b002ffbf2213d4sm2257630wrz.75.2023.04.20.08.57.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:24 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id B1A891FFBA; Thu, 20 Apr 2023 16:57:23 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour , Yohei Kojima Subject: [PATCH 2/9] qemu-options.hx: Update descriptions of memory options for NUMA node Date: Thu, 20 Apr 2023 16:57:16 +0100 Message-Id: <20230420155723.1711048-3-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42e; envelope-from=alex.bennee@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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Yohei Kojima This commit adds the following description: 1. `memdev` option is recommended over `mem` option (see [1,2]) 2. users must specify memory for all NUMA nodes (see [2]) This commit also separates descriptions for `mem` and `memdev` into two paragraphs. The old doc describes legacy `mem` option first, and it was a bit confusing. Related documantations: [1] https://wiki.qemu.org/ChangeLog/5.1#Incompatible_changes [2] https://www.qemu.org/docs/master/about/removed-features.html Signed-off-by: Yohei Kojima Message-Id: Reviewed-by: Juan Quintela --- qemu-options.hx | 25 ++++++++++++++++--------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/qemu-options.hx b/qemu-options.hx index 59bdf67a2c..174f0d0c2d 100644 --- a/qemu-options.hx +++ b/qemu-options.hx @@ -405,15 +405,22 @@ SRST -numa node,nodeid=0 -numa node,nodeid=1 \ -numa cpu,node-id=0,socket-id=0 -numa cpu,node-id=1,socket-id=1 - Legacy '\ ``mem``\ ' assigns a given RAM amount to a node (not supported - for 5.1 and newer machine types). '\ ``memdev``\ ' assigns RAM from - a given memory backend device to a node. If '\ ``mem``\ ' and - '\ ``memdev``\ ' are omitted in all nodes, RAM is split equally between them. - - - '\ ``mem``\ ' and '\ ``memdev``\ ' are mutually exclusive. - Furthermore, if one node uses '\ ``memdev``\ ', all of them have to - use it. + '\ ``memdev``\ ' option assigns RAM from a given memory backend + device to a node. It is recommended to use '\ ``memdev``\ ' option + over legacy '\ ``mem``\ ' option. This is because '\ ``memdev``\ ' + option provides better performance and more control over the + backend's RAM (e.g. '\ ``prealloc``\ ' parameter of + '\ ``-memory-backend-ram``\ ' allows memory preallocation). + + For compatibility reasons, legacy '\ ``mem``\ ' option is + supported in 5.0 and older machine types. Note that '\ ``mem``\ ' + and '\ ``memdev``\ ' are mutually exclusive. If one node uses + '\ ``memdev``\ ', the rest nodes have to use '\ ``memdev``\ ' + option, and vice versa. + + Users must specify memory for all NUMA nodes by '\ ``memdev``\ ' + (or legacy '\ ``mem``\ ' if available). In QEMU 5.2, the support + for '\ ``-numa node``\ ' without memory specified was removed. '\ ``initiator``\ ' is an additional option that points to an initiator NUMA node that has best performance (the lowest latency or From patchwork Thu Apr 20 15:57:17 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675638 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp394744wrs; Thu, 20 Apr 2023 08:58:44 -0700 (PDT) X-Google-Smtp-Source: AKy350bjpTmI/I9iwGQUPBUVz76Ph/7V4dcUA+Ri2v7mEBnOpkH9h+dFXk77cW2NsdCQbK81p1jw X-Received: by 2002:ac8:4e41:0:b0:3e6:3ba9:3c8d with SMTP id e1-20020ac84e41000000b003e63ba93c8dmr2745537qtw.13.1682006324598; Thu, 20 Apr 2023 08:58:44 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006324; cv=none; d=google.com; s=arc-20160816; b=C7M64mpSear+/gDtPoRO3d5dWPMWG5a7j6rY0XTHcKvQIwchGiJDGxOXbB66xJksPk BAVEc+pwPK5CFIDgkYJbj3M3asvSGCIaD/BtAzKwEN4hYT5ZwCv+oNLrp3YgGNqVLh7l 27O1VtH5tU2JWunWPyvj/iFL6ORI9nmleT66DVt2XOvdlOZBNvRZEy3tPFNSj2wNj3u/ UDTWvC9Zr/UAmBe6V2ap90bo0co2WLTTdYv29XDdvrbu7M9GmttKDTG4NlCXWfMuhIIk 5gfhbiHz5JhYp6bL/LJGSPlYfJb3putPA82kUhmce15hc1Mg3JUFe2CKAkR0epuAgKyc RsQg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=R59KmhBE1ju4nQIU2ym/eqgcBqBFRDfoZfCOJrQ0/j0=; b=rJ9veKUZseQVhU7jhhhsJ283xYAcLm62+4ibSHmhJ+UQHYE684oeiR5J3rngRBkR32 z7M1Cs9JwVXwttNo5PPozunriwWchGkEbdqLKxM1SaSn1DPJtqkv+ZOyplqO/DSZJ1f1 WqZP+iALYvUEQOKaw911wDPDrPWGRvgjXIhhKRcWQmWzqOh+6uUbLc43Bw7I2icuwuTH ZrOe4SWu2ohXYPLwWSSvDEsaCc8Oi8sKGGaxmNVuxIbQ1asSYdLM8THKtj1+g0aGcaFc AMHTZpGtAQwYKsEP/VyWgAHy1dUEZ1nFEXVha5vSjvMYFO4UMfpa3ZPJ+WLEDtxYECQS LaoA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=PNSk7vpv; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id i4-20020ac85c04000000b003e43016c09esi1597625qti.52.2023.04.20.08.58.44 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:58:44 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=PNSk7vpv; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf7-0000CJ-BN; Thu, 20 Apr 2023 11:57:33 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0000Ai-R9 for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:30 -0400 Received: from mail-wr1-x429.google.com ([2a00:1450:4864:20::429]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf2-0007u8-1x for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:30 -0400 Received: by mail-wr1-x429.google.com with SMTP id ffacd0b85a97d-2f625d52275so700667f8f.3 for ; Thu, 20 Apr 2023 08:57:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006246; x=1684598246; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=R59KmhBE1ju4nQIU2ym/eqgcBqBFRDfoZfCOJrQ0/j0=; b=PNSk7vpvRGHBpnQCP1aCoMvZfMNYBAJdhDESsErI647MISQQD4f3m6gFG+mbL4JZuE 603aCdF/Gw7uged1l9jfRW2OkstJXnX9rn4pliIx4xoP3O8Q6qcwqk3ZFNZaE9DDkLrv SHzg+qfC6U5EGkwJ7Mw/3iqW2mUeaRqjU9g0tJ4mIU7o0fuGxRoJgzQcmlbu/yxxbLDj 7hYm2sV8QUVa3MwSYdKBE8d+AN1IMQyTsOKZndr4mQ8Rb13tWZZ5Dz3+6/l9Y1ne7hxD 74uA90mDKSkaZHzERzZ7st/Jtyenw9MMq7/zRs/rruasdzvKyD5kl74mAlGRWbGGQiuH LZhg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006246; x=1684598246; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=R59KmhBE1ju4nQIU2ym/eqgcBqBFRDfoZfCOJrQ0/j0=; b=daIX7ci7x+9v+rxVt1AhPpM/N6UMDr37/ujeXDIyrl0og9PWR0JgnF6JcSHG9BmP6u NNHs6vVhEUoAIO5HIv5Be3qybumVtMl66wKolNACwBOZP00yEhVSyJId2NYfdVSXv9sg GQELx2688/5NWvHIHx94hby9j7lVhfkROngfkJEpszydsE7C436uXkjBtujzAHT+mmmG 9MNuUYxpQ9K+tBHvKDupmdQUNRG+ISeieypjqYtmzOjmAnEhw4wT3buHitIj30miXdhJ fUFqigO6WbAOmBpVQ84dWrZNXtAouW8a7FixfLS4vNx7KPpTnNE5dJ09rGR9sys2Mnnr 2igg== X-Gm-Message-State: AAQBX9fgdQ2lqhoP3PPRum+Pd30h3/JDJ8sipecwZUKmpOFHFCork9Qo TIUkjAnV3itsQnSYlbKTOQO80A== X-Received: by 2002:a5d:40c6:0:b0:2c8:9cfe:9e29 with SMTP id b6-20020a5d40c6000000b002c89cfe9e29mr1780944wrq.38.1682006245942; Thu, 20 Apr 2023 08:57:25 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id u9-20020adfdd49000000b002fe33e42c85sm2269503wrm.72.2023.04.20.08.57.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:24 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id CA6FE1FFBB; Thu, 20 Apr 2023 16:57:23 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour , Stefan Weil Subject: [PATCH 3/9] docs: Fix typo (wphx => whpx) Date: Thu, 20 Apr 2023 16:57:17 +0100 Message-Id: <20230420155723.1711048-4-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::429; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x429.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Stefan Weil via Resolves: https://gitlab.com/qemu-project/qemu/-/issues/1529 Signed-off-by: Stefan Weil Reviewed-by: Richard Henderson Reviewed-by: Philippe Mathieu-Daudé Message-Id: <20230409201007.1157671-1-sw@weilnetz.de> Signed-off-by: Alex Bennée --- docs/system/introduction.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/system/introduction.rst b/docs/system/introduction.rst index c8a9fe6c1d..3e256f8326 100644 --- a/docs/system/introduction.rst +++ b/docs/system/introduction.rst @@ -27,7 +27,7 @@ Tiny Code Generator (TCG) capable of emulating many CPUs. * - Hypervisor Framework (hvf) - MacOS - x86 (64 bit only), Arm (64 bit only) - * - Windows Hypervisor Platform (wphx) + * - Windows Hypervisor Platform (whpx) - Windows - x86 * - NetBSD Virtual Machine Monitor (nvmm) From patchwork Thu Apr 20 15:57:18 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675637 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp394679wrs; Thu, 20 Apr 2023 08:58:37 -0700 (PDT) X-Google-Smtp-Source: AKy350YNLmluX8FJ96E6srAr3fwCQHZZxSpxoISrnbP3/NwfVFLRC3WeP5bMi/32x2X29CoeXZGe X-Received: by 2002:a05:622a:1184:b0:3e6:38cf:fc93 with SMTP id m4-20020a05622a118400b003e638cffc93mr3162661qtk.19.1682006316859; Thu, 20 Apr 2023 08:58:36 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006316; cv=none; d=google.com; s=arc-20160816; b=l3dv6wFFGwSy9KNx4xLXaCIizxVMNRIlgUlMODk/Mq5GRW2w98YCaKJ3gKIrDpEPj+ I3S7dgb6LKEBAlOEEkVyY0ae5Hg57SbCgBykNO3Pv1dviSxVHmijE3oYLQd5S5UAvSvU QYL2lrnDgxf/FfXIPsuDlMp9FO6WFl0jctD4IOK3zqGk2EhMImypVDJTvzrYpEMlovkz srI9ryA0YGNonZWVI2TwhPGqlWOFLCIyU7POsckAwUssJW9qlmDV29OTA74Vr3WfjNYj xn00Ifs8iKHvw/VYCBPs5mU4/qa17rqYs92mrXd+PffOrZSDc8qJMk1dPc+HIojEjoOt xKtQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=Hii62K2Wc7QFsLVVFypLkGk3bZXI6Fmh1Q2b0Ws3wdo=; b=Ckfd8Gjkujh0SezUnilwCNl79FE/VhgM7QmzDh+/4TA73Vwje5d8nuLJ0IDiYYQdsu o58vtG2cZ2dPVmYqMraAUcl1Q9bXs0xalUbBIii2a3L6ZvC7bmSZNUHz5dmqBC6Zty+3 fR1DKrMIFzgvUh1I7xG6J3VlIHvsBXym0qy9m/LV7TBDdRvkR02NMw/EpbB64ZeQsHWM /3E8fhIAMQgS+6NzmmVXQszpO1l3ZIIfHnf13aDA3GI30GvgBzO23/AwaYPD5WD/3HOJ OSeDZ2YIsbUIui1w7VaOkkR28Z+UIcBKtf4t2V7+JssePnTuAs9eZIT5wGlC60cQTnug 3+Fw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=fnNdLtGN; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id t13-20020a05622a180d00b003ec491f376asi1595721qtc.706.2023.04.20.08.58.36 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:58:36 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=fnNdLtGN; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf4-0000Ah-T1; Thu, 20 Apr 2023 11:57:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf3-0000AG-9i for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:29 -0400 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf1-0007uH-Jp for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:29 -0400 Received: by mail-wm1-x334.google.com with SMTP id bi21-20020a05600c3d9500b003f17a8eaedbso3317115wmb.1 for ; Thu, 20 Apr 2023 08:57:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006246; x=1684598246; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Hii62K2Wc7QFsLVVFypLkGk3bZXI6Fmh1Q2b0Ws3wdo=; b=fnNdLtGNgHdbnZp298veUMGtIEH+ervXxQrKnl4gkb/brtA0YLsUAsQxCsK1y7VNi6 BTd8fK0Ir5HN+95CfoiI/uQazRJ3/w4n8OBCyOaQ/h1V3fNwRjWXCMPyc0/FObYy1Y5S HjtKESMvTqCZpRb57gj9S5Y4AcfCoyBd7PiSnwJLiJLzzQM513HAb3+v2TiD2vsFil8i d6JuQhFAV8gfbXGAIu3exmCtZg+G6kLomfBPoOEjdGamAxLwSrmgdR5jk1WgVIonKc0Q v/JIkQwFtgQwEZtZNIqUYuJojZpxMZBz5KGy9KFYjnZqtR97ML4x5JtKzMOCYNmootLW vwLQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006246; x=1684598246; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Hii62K2Wc7QFsLVVFypLkGk3bZXI6Fmh1Q2b0Ws3wdo=; b=h0M9jBcw8jdIpXfibUZUOC2vu8GPMjm3Rn/kuj/KwFeSyzoYDi4Yx3sr3bcoZlccdQ XLesF5xMOMTlnh11x2hrSatNL1y56PeAeLSjL9zMKwPjVZaIL8Uwhjy5ilzFkaFcrjCr AlezfzFSp/OzJoMM5ICqZGkdlVLpncxVTjAbWmSpwTXdAhVhWBb6UR44NPo9y8a5iVl5 mIa/tQ1OBWPxdvvgJ1J2KaI7tmixccVWGfFUcJoGtVPdmu1w2z/37etkGRAbkNSy0wLJ qPpubj1WqAYrJOor8/zLUlPO83xH8SR1UbJu50e17EuUxkeAqE/+OU2RzmwXVIVonlYu F8Uw== X-Gm-Message-State: AAQBX9dXyi7H5128oB4X4D8nxUWr4AjDVHPu73an83YpnwpuIX68fWuO JjBIF98XVbSrTEDftlHLL6xRzQ== X-Received: by 2002:a7b:cc85:0:b0:3dc:5b88:e6dd with SMTP id p5-20020a7bcc85000000b003dc5b88e6ddmr1786798wma.10.1682006246346; Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id h1-20020a5d6e01000000b002fa834e1c69sm2263428wrz.52.2023.04.20.08.57.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:24 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id E21F51FFBC; Thu, 20 Apr 2023 16:57:23 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour , Stefan Weil , Jonathan Cameron Subject: [PATCH 4/9] docs/cxl: Fix sentence Date: Thu, 20 Apr 2023 16:57:18 +0100 Message-Id: <20230420155723.1711048-5-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::334; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x334.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Stefan Weil via Signed-off-by: Stefan Weil Reviewed-by: Richard Henderson Acked-by: Jonathan Cameron Message-Id: <20230409201828.1159568-1-sw@weilnetz.de> Signed-off-by: Alex Bennée --- docs/system/devices/cxl.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/system/devices/cxl.rst b/docs/system/devices/cxl.rst index f25783a4ec..4c38223069 100644 --- a/docs/system/devices/cxl.rst +++ b/docs/system/devices/cxl.rst @@ -111,7 +111,7 @@ Interfaces provided include: CXL Root Ports (CXL RP) ~~~~~~~~~~~~~~~~~~~~~~~ -A CXL Root Port servers te same purpose as a PCIe Root Port. +A CXL Root Port serves the same purpose as a PCIe Root Port. There are a number of CXL specific Designated Vendor Specific Extended Capabilities (DVSEC) in PCIe Configuration Space and associated component register access via PCI bars. From patchwork Thu Apr 20 15:57:19 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675642 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp395081wrs; Thu, 20 Apr 2023 08:59:33 -0700 (PDT) X-Google-Smtp-Source: AKy350Y7tjLfMfH7uQvKftYz+DOKg5IDeVm0v8Q//LGk10xyiILk2WMyYkV/zB/uoUK+DPdA2nUS X-Received: by 2002:a05:622a:406:b0:3ec:8c61:54d9 with SMTP id n6-20020a05622a040600b003ec8c6154d9mr4321790qtx.14.1682006373598; Thu, 20 Apr 2023 08:59:33 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006373; cv=none; d=google.com; s=arc-20160816; b=KwXbJbR/aQm6udc9oVfYf8p7vbYaXfi8vwNXKilwC+ACP7aeHN7wde+zYH8xowdfjp 9/prHxRJguBmxIWS6x6qugaSdW28q+icXuWmmSsRE1EUbUnLJr6k4cJVuNLJRDjZ8q0v AafPAclLtv7IuCukwTIczkRmveaeJodE4UHpy39jKGmJN7lH0G/7kamUKOsDvrHu7iak OFwt/prRWFtCkKCYJyYRd1Iq6U2OMV+xbUlGhyp6U9Zm8ezXbyv2tX8JEf4hzDXy1mrh QedDk4O4rfw+5tgjebMuBtgX5ic1Cw50JbcNXxF6YyxkeXTKPNlgY4FJ1ITg7NcfM20w jV9g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=Pvsbb/phYjqIHhkDoc+XfXTFKQuZBTz/m6mNyHE4+kM=; b=d8Kw4VK1xuE9TdShMFoVYep9JHZxrYLxoAy+HRIMj/p1OL46qTNut0KI+8EKHDW9Vs imLv1o1il9bNwh8/95+aPF9jHoztQlHam4HdOciVsPggdioLF35icWRmOOhG12TV2YMQ d1YOXCmhyZgLeTrxls/GXr/gWFdfpmfpQG9TY9KroYPb4R65tLLJBo9EST2KUswO9Wcv UCPPJqtKZWBg0Ei5ZCUuNp3idq/PrPjhECjqsrSaXcuIIJiFdyKCsuhueqz3lCNeDSCh /9XOlA1M9Hhp6ZPYgqyx66J/5dG0dZHB5rNWnElZFb8v8rO3b7CqFYJOLUKzgY2M0mdj Mzeg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=jh0RYM2e; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id m13-20020a05620a220d00b00742c8f669c0si1235205qkh.389.2023.04.20.08.59.33 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:59:33 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=jh0RYM2e; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWfA-0000EN-Mw; Thu, 20 Apr 2023 11:57:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000Bx-Sx for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: from mail-wm1-x334.google.com ([2a00:1450:4864:20::334]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0007v0-Pw for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: by mail-wm1-x334.google.com with SMTP id ay3-20020a05600c1e0300b003f17289710aso1366573wmb.5 for ; Thu, 20 Apr 2023 08:57:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006248; x=1684598248; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Pvsbb/phYjqIHhkDoc+XfXTFKQuZBTz/m6mNyHE4+kM=; b=jh0RYM2e1dLFRy6AjKmTi7HPrcNgNDHYOv3eXxz9suB/j8xLersdGgXei2RIwp6Grp ELwKPUAeGmKeoBn+KoT3H2zekTjBnF7Mk5afWj/ru+hNiMJZ4wqbvvY3rNpTWDzQkmlO elnSgts2Pk328lUyywxgdwW7oAAjT6BVtTM+QLFOUXS0lLT5SNQYnfm1jEhH+HAgNiMt 3ofgiiTyYNB1prklgDGlk4PlgF0eoAgAORizyqEqNM1rPz2hHiwl088avwftrpnrbMX8 xQZr1AwaQf+SiZf0nwRW2d11MF45s0HmDOOzzFzER1vNspfEIbLk5QYL3DC26NQR9isH DIJA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006248; x=1684598248; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Pvsbb/phYjqIHhkDoc+XfXTFKQuZBTz/m6mNyHE4+kM=; b=R+CP2EDXgWBqWwlbOXKftuK0BMFlR0EcJ7S8bVYAjw/1nc0IZVQdFiBlce9QrUBBcL LTip5iRQdDCte119DFoFt2saeFb8dUPskA7arKSdQpa0FnYELi1G6BFE4FiWAGpDIgFy JOI0opXohakpdlc4h3pIOZ5nfqsnsbdyGhAbFj9iIDBBEDaZic4mRDAORxKUghhCobfb VXJ/rCFJM11W8QtWYJPfP6u+CSrdECVrL5hRkCKknLyJy4Ur5tHOMPeSz0m4UsSAFjRQ 4agwJCYPUYNGiNXWHQwchkdQ3sgMx3vjWx3FIGJOB2xDFESAUUMfSvKeBRHiEs/DYxsP mgPA== X-Gm-Message-State: AAQBX9fFxG4AuPOiVwVn8lxziMQCGj0GEQXeIrg6z00eKXjmGpeLIRxJ zGgBEgOz5ESM9AKAI6c3zHV9ZQ== X-Received: by 2002:a7b:ca45:0:b0:3ef:7594:48cc with SMTP id m5-20020a7bca45000000b003ef759448ccmr1881591wml.23.1682006248415; Thu, 20 Apr 2023 08:57:28 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id g10-20020a7bc4ca000000b003f171234a08sm2372855wmk.20.2023.04.20.08.57.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 04CC11FFBD; Thu, 20 Apr 2023 16:57:24 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour Subject: [PATCH 5/9] MAINTAINERS: Add Juan Quintela to developer guides review Date: Thu, 20 Apr 2023 16:57:19 +0100 Message-Id: <20230420155723.1711048-6-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::334; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x334.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org From: Juan Quintela Signed-off-by: Juan Quintela Reviewed-by: Philippe Mathieu-Daudé Message-Id: <20230419163457.17175-1-quintela@redhat.com> Signed-off-by: Alex Bennée --- MAINTAINERS | 1 + 1 file changed, 1 insertion(+) diff --git a/MAINTAINERS b/MAINTAINERS index 2c2068ea5c..24154f5721 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -70,6 +70,7 @@ R: Daniel P. Berrangé R: Thomas Huth R: Markus Armbruster R: Philippe Mathieu-Daudé +R: Juan Quintela W: https://www.qemu.org/docs/master/devel/index.html S: Odd Fixes F: docs/devel/style.rst From patchwork Thu Apr 20 15:57:20 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675640 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp394862wrs; Thu, 20 Apr 2023 08:59:05 -0700 (PDT) X-Google-Smtp-Source: AKy350Yey8qP7K0SQbh8cqdsaCwsqzA1OW7qeO7KJz9loZ1DSkn0MWvJOLJV6DNaUs6qkwNhOXhF X-Received: by 2002:a05:622a:104c:b0:3ea:d941:2435 with SMTP id f12-20020a05622a104c00b003ead9412435mr3099942qte.42.1682006344872; Thu, 20 Apr 2023 08:59:04 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006344; cv=none; d=google.com; s=arc-20160816; b=w1ZZLl8aV+nhcTJ7iplYak3UB4llJHCz7s0jQ8xDKdC+OkPA1lrjMpqKNskwPLwVSi DscFDf7/LhjWgfFTl9vDcaNMgo2PtGcInGi7zuQzIPr+2GiNYHrasy5mCHOKw2WCG887 wFnc7Dh2Ms8JL8Te7uGaMDJ/I3vjr4SCcd6xmyja6DofxPLGV/r1LNJmcZVS16Y+Ar92 L96F0AqsbmWIaRU3+Zks4XH1iaZYXjtf1rpUyyYV+tjban1WzwqVJOkMSCkTzRZGG6Uc kuGwO7XU7QjGOw9jFQ5S1CIprgXcCRcCb7F8venxty44UbULO4wLpLmF+51yy2k33ieT Lw0A== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=zA2dADYFSqtV3gwOhvRaO97+ZK8AjTBqI4T+ZN/JW8Y=; b=hRhR49W1ZuvA5F9jb8atL2XjvFaJxp9PbAwi8N9VxZ1I33J0SVZLyfHtMZH4IrB99G ydXD/1vmp7fBKhB0ACZOJa9RpGzKlsIJn1jroSwLxnpM8j9/WwdWYDnBxpUunk29TYwg 8B9EIrw2jUJVhMGqtEJ8wi8D6L9tvRB77YrI9aaXIZII1rocZi9vnyLFNN5NIWFfgu9Q foDueuw3tA7CHlLG/a7Z/FzYSmAq2VVadxdG30iEJfALjX681q1xRZwCfK9yUkJ1saw/ QjQxzQdWMphQ+bLUmlExSrX9aai/gWmy9vd0LzVAulyT+NJBRsSjPz4NRnMJo+lVL3qY orTA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KfKWCWB+; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id q32-20020a05620a2a6000b0074df84fd550si1326201qkp.666.2023.04.20.08.59.04 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:59:04 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=KfKWCWB+; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000BP-7S; Thu, 20 Apr 2023 11:57:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0000Ak-Si for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:30 -0400 Received: from mail-wm1-x329.google.com ([2a00:1450:4864:20::329]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf2-0007ub-NA for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:30 -0400 Received: by mail-wm1-x329.google.com with SMTP id 5b1f17b1804b1-3f09b9ac51dso23308495e9.0 for ; Thu, 20 Apr 2023 08:57:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006247; x=1684598247; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=zA2dADYFSqtV3gwOhvRaO97+ZK8AjTBqI4T+ZN/JW8Y=; b=KfKWCWB+MVuwduMk9ZW5fLotww9Ps48XwK5Vm/FSDlgvJ65hABERI1udQ/HV4to/kW 7MzL+K0FqM3fLfO0OPcDmXqppnIDqTPDm579O1oxqD93oK5aroZ/NNhf9WBVhJC+Ko4A IigT6PjYkBj019mmTXNzAeIi5NTQtAxoI0wbafUeCayiiUoefA51s2raWFykLu5H3ONT LCW/XkfLaVIa6LoH0kDwBI9RZsSEdEw8QYXDc5mWb5WWAxeVIgricUuUQzMRGELdZTrQ JGqhPQue4tlIeD2U5f9kS3R7XqhdjS+jys/bqGwgSJrVuHaUFijHOS2lKziZilgdvEPw EzYg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006247; x=1684598247; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=zA2dADYFSqtV3gwOhvRaO97+ZK8AjTBqI4T+ZN/JW8Y=; b=DIyIRdIa0Vy2ODk5AUWkl8+Y2a11bALUG8gmHXVFFz56rV8HdtUKjjpcFhm0azjAma kUFvc9T5Idlsb+fdOCAkfGewYITu18+XG7CvhRGV+Y5bjfqzT/UG7a4uddDuhHX25uXL CVQK2ofQ7arUN3MeTEHqNBLsIEciPdY/3Pdr9ghMhZsALyXrB5JY9g9v3lImZ8b8hjXb MR6l6rbWwBJ8MxE9Au5LM+tXcsTVxnXdvM9xUMsI0uqK51E+LOd/J9oMHZ+kDtgXaupz EzOKBj8glcR/rCGheLDvcL41EjgzsmWpAQnOxVIbpXk6alh2LO2Sk2VxbQcFHqk3r2s/ oUHQ== X-Gm-Message-State: AAQBX9fwMvMMHYjTS0Sd4TsDXaDOM9AlDbAt79j0K880DjC5nQDXRUI5 7O3aF0Lhb1MChWr83j2mcUb9ViNkWeb1yt1uw50= X-Received: by 2002:a5d:594c:0:b0:2e5:8874:d883 with SMTP id e12-20020a5d594c000000b002e58874d883mr5302098wri.8.1682006247321; Thu, 20 Apr 2023 08:57:27 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id v17-20020a5d43d1000000b002fdf0f6b07csm2271875wrr.67.2023.04.20.08.57.24 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 1D83D1FFBE; Thu, 20 Apr 2023 16:57:24 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour Subject: [PATCH 6/9] docs/system: remove excessive punctuation from guest-loader docs Date: Thu, 20 Apr 2023 16:57:20 +0100 Message-Id: <20230420155723.1711048-7-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::329; envelope-from=alex.bennee@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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org A possessive its needs no ' whereas the contraction of it is does. Signed-off-by: Alex Bennée Reviewed-by: Thomas Huth Reviewed-by: Juan Quintela --- docs/system/guest-loader.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/system/guest-loader.rst b/docs/system/guest-loader.rst index 9ef9776bf0..304ee5d531 100644 --- a/docs/system/guest-loader.rst +++ b/docs/system/guest-loader.rst @@ -14,7 +14,7 @@ The guest loader does two things: - load blobs (kernels and initial ram disks) into memory - sets platform FDT data so hypervisors can find and boot them -This is what is typically done by a boot-loader like grub using it's +This is what is typically done by a boot-loader like grub using its multi-boot capability. A typical example would look like: .. parsed-literal:: @@ -25,9 +25,9 @@ multi-boot capability. A typical example would look like: -device guest-loader,addr=0x47000000,initrd=rootfs.cpio In the above example the Xen hypervisor is loaded by the -kernel -parameter and passed it's boot arguments via -append. The Dom0 guest +parameter and passed its 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 its location and size. Additional information can be passed with by using additional arguments. From patchwork Thu Apr 20 15:57:21 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675643 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp395086wrs; Thu, 20 Apr 2023 08:59:33 -0700 (PDT) X-Google-Smtp-Source: AKy350abfjPTrHFhvcal/PZCKmQyOUZuni14biXNWjQbY4Ta6wHlWwshDroXS1ulblUacmnTjbEU X-Received: by 2002:ac8:5d93:0:b0:3e2:4280:bc56 with SMTP id d19-20020ac85d93000000b003e24280bc56mr2893868qtx.41.1682006373773; Thu, 20 Apr 2023 08:59:33 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006373; cv=none; d=google.com; s=arc-20160816; b=C1q4uLtC+uNK36MBwNHGnOVy10tudd4e+PiqeXU20re31wN2drAwPzep01tkYNioMm mtXLrYx7Qi6xOkfODe9XmipjkSTPtpqP9TweacZHMt8xPgWex6zgZHP8rSU1I+4OI30D 5eC435MU9Smq3e/m7FsQ9O+oMSoYfd80aDcUUasmEbqfnu3EZWTuM0wcynssOZC/7HWa PhxqUrPRk+ookxE5RX9uv+c5tINKH14/20sCMgpFo87SFVzUjasIpKX7XajbwBuasJsV 6do8uCPTobMPjEH57hnVXv7NVcl/16IoroeoWGHqUO6bRk3G8OlqYsj1sewSpTMDGQxD KBlw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=Nrpom6SU9io6Y3gUibz5mchgZ9rlSkFFImeDW90ONAA=; b=X8ad/0XGViNq5cfp1FgKCLEY/ZMh0C1AS8KEHQKl1xshJ6zR7ghaHO89ZdXCLS4HBq kkyC+IZ4iVq+ywxZK+T5Pofw1u7d/cnEyGb7XFv2GDWDUUO9PAdPN17teV17WRrXIHtk j9biH2XOxKYWT/s3SGnsKZspykN3vffhgRTyHIFDZWChfEx9rmj5RdVuM/w/mAnOjNos VI6rI7mqyAa/PdJv9/YOWHveTj0Xj6bzDPqgR/7y38++qLDtEm6MpBgZE/rZdOJgoUQ5 znulxx/wIS6g6nv5aG80M3VZoWlJs16kDQ7wqv+fTZeWTe1YsJHbNpasy3+VJmCVUROU Z40Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=XcIhGUNa; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id b9-20020a05620a0f8900b0074698b29c54si1242599qkn.503.2023.04.20.08.59.33 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:59:33 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=XcIhGUNa; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000By-VO; Thu, 20 Apr 2023 11:57:32 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000BO-5E for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: from mail-wm1-x330.google.com ([2a00:1450:4864:20::330]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0007um-Jo for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:31 -0400 Received: by mail-wm1-x330.google.com with SMTP id a8-20020a05600c348800b003f17ddb04e3so1380975wmq.2 for ; Thu, 20 Apr 2023 08:57:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006247; x=1684598247; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=Nrpom6SU9io6Y3gUibz5mchgZ9rlSkFFImeDW90ONAA=; b=XcIhGUNaOemHzy+nxsyl+p9N4Z1KraBOcUHw3ogTymi2TmBfHdES6IOO3dokbYRz7A KOJV5Qhf9tEH5baUAfmyVY/eVGLQCsTZWkkxCbG950IiprLOCP/PXMot3tz5gaCq3m9b fB+/dq9/WsXHgzr3pET69BHHVSAOw4xGHlACvTo4aGF2EjRCf3NuWKjkaccwG8VFQby6 pCJqi1myWQHblE2BlIBpAvVdzfzKAIuArTeVlOtPYV83g3m0bqq0DOEdYfanmMxgt0Fq 9gxpRtWQasqoQJzaWGQizXghm29DqK35DJYtjaOoQBUe+rVOhMVc87gNDNGz0zkI+hzu 4pKw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006247; x=1684598247; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=Nrpom6SU9io6Y3gUibz5mchgZ9rlSkFFImeDW90ONAA=; b=UbmMkyowBYdplnW9Gys2Jm9rBkZLa8yzVNF7ZUd8Zwy76wicThpdQzg+J9wKzEjkh8 VdzCSGHhvskAp60J/bmjPx719nUs4FVeh+z7I2n4XRL/XwvkYOVlMyrvTQDwPPjlGltI UqOVMAvx1rBnTtDKiSuo3OCOHRRlwa0HcKVNpLZn0hdbVL1DRipUOMIptw2ZIjWfl9X/ CgipClQRo1urjWKDyt/tAneo3e5Y0bbrybTEJqXcqekh561XaPN/L8vxFZ+KfW3xnPnK CgqWLugD1WZTjRSw54EUcoviCINoYBkWaCKagUFIRBVO7HZlWOTw1C3QA3TsZDZ4Zp90 aArw== X-Gm-Message-State: AAQBX9cIh7fwJHS6WtF21jtZtdyKUB+y2gOYDbTnE26hwpEkKG5ftepU khLJRwywr/eT0bDsyHhFc0TE2g== X-Received: by 2002:a05:600c:258:b0:3f1:735b:9c4b with SMTP id 24-20020a05600c025800b003f1735b9c4bmr1768256wmj.37.1682006247508; Thu, 20 Apr 2023 08:57:27 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id h16-20020a05600c315000b003f173a2b2f6sm5828196wmo.12.2023.04.20.08.57.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 3617E1FFBF; Thu, 20 Apr 2023 16:57:24 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour Subject: [PATCH 7/9] docs/devel: make a statement about includes Date: Thu, 20 Apr 2023 16:57:21 +0100 Message-Id: <20230420155723.1711048-8-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::330; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x330.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org While not explicitly disallowing header macro abuse (because that would make us hypocrites) lets at least address some things to think about. Signed-off-by: Alex Bennée Reviewed-by: Juan Quintela --- docs/devel/style.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/devel/style.rst b/docs/devel/style.rst index 68aa776930..5bc6f2f095 100644 --- a/docs/devel/style.rst +++ b/docs/devel/style.rst @@ -300,6 +300,20 @@ putting those into qemu/typedefs.h instead of including the header. Cyclic inclusion is forbidden. +Generative Includes +------------------- + +QEMU makes fairly extensive use of the macro pre-processor to +instantiate multiple similar functions. While such abuse of the macro +processor isn't discouraged it can make debugging and code navigation +harder. You should consider carefully if the same effect can be +achieved by making it easy for the compiler to constant fold or using +python scripting to generate grep friendly code. + +If you do use template header files they should be named with the +``.c.inc`` or ``.h.inc`` suffix to make it clear they are being +included for expansion. + C types ======= From patchwork Thu Apr 20 15:57:22 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675635 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp394455wrs; Thu, 20 Apr 2023 08:58:01 -0700 (PDT) X-Google-Smtp-Source: AKy350biDXiC7P/esYub49w5MzfDICj4NK3WZ80mmIwqYn8Gr7UFedT33ChBzG2LklsPcGdSzdkD X-Received: by 2002:a05:6214:29cc:b0:5ca:6c32:f35 with SMTP id gh12-20020a05621429cc00b005ca6c320f35mr2001043qvb.39.1682006281390; Thu, 20 Apr 2023 08:58:01 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006281; cv=none; d=google.com; s=arc-20160816; b=qSCN+DHX82A0eCyDtUB7W4OM0CaLAILiMgNkl8K47xUY9Mo13UVPhMaccez3nVZ/N7 rF4HGt593MvLxaFzuz2WmQYnjMO5dRJVCA3oQvmLQafyJ2LqO3JmA8MsvNQTGjl2dq4L /06rpj4RwsiTAd9pAlXJ4xJ+nc03phiAhmUnIkBXjdEaDmUbnX2csFDt+24CcEBFWH05 YRUZq35geNOvFuWFR87VSrNzZZCxtRsImwBG8j05FuqkpO9mm/noNPQKYQBqfL8BvLXM KC2RXMbK8gSsROe6o6tOXaT33bK+/jousxYuY4027gXsrqReTm5OlOUgj25PfwCAE8cK 9OLg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=4pZT3Il0Z6ehRMXrKuFjhJyb9HkLDoEsCo9Ux/XBJuc=; b=YtXrSxm7O8taOIKoQxiWcSxfLpn716B75qK87Gd44IkBmslJISUwqfTd44rzvYz0qo Wy/vlpcw263rybtqF8MVGFK+3WeNyQzzOUTyqUMP+sWauUzo+6BQr2vXWOpTpKGWdp+q pycfkYORWI8HF6vcb3dELjEde63a3c9l5sxma6/2ZYYjGDir4MreCqxCcscPxE9brsbH 4W5Gv9gld3eLMT5Y1stIRuklGaO/eq620owinSTzAXjJNDqxIZCQBstAPpb8bw3yCtNe IJW8vL9iwwCR8wDiyUDqfKVWppomP1Rl3aGvpQRheQHfyYYqpG2KNsbA6h36oeW8zE7+ 2ZIQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=D9VRfp9M; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id ey3-20020a0562140b6300b005ef58580b80si1727897qvb.186.2023.04.20.08.58.01 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:58:01 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=D9VRfp9M; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWf7-0000CS-UU; Thu, 20 Apr 2023 11:57:33 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000BQ-FZ for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0007vB-KS for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: by mail-wm1-x32f.google.com with SMTP id n43-20020a05600c502b00b003f17466a9c1so3310472wmr.2 for ; Thu, 20 Apr 2023 08:57:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006248; x=1684598248; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=4pZT3Il0Z6ehRMXrKuFjhJyb9HkLDoEsCo9Ux/XBJuc=; b=D9VRfp9MtT/vYu6qDryy8LitOvu8IXhgzR0NR7+vQ9PYVYymyiMnA+cZdfgX07MTr5 jmplAVwDpBwRlsUuQePfj9Oob+lSuqGKRPFUSLyqtGxg5bWerNE96RHpQLzylb3NrhgB ca/KDhDkfrE1n/5EgMFznQGSoyH50ysvxh0/cPltKi6HYO6XVlvK8xwkYe2rCXz07nnb iFJXArJU0sQ7H5EpJQv6chooNWL4IV4REujZHzXlYK/3u36ngxcywFtHXvvJOToUOqig gjwsCOLJgy/D5PcZVOshTkRxD6ijFqyiVQqXpdclycA/HYHdb4Qi48XJSni4RsKEpF5X nwuA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006248; x=1684598248; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=4pZT3Il0Z6ehRMXrKuFjhJyb9HkLDoEsCo9Ux/XBJuc=; b=ln3kH+MOK3o+FytViW4MErNzL5hDMEbmN8hur9ifau1jjP9Xomh6Pm5G9UrjLudSLK BXgxWzo/sE7cWrOGyohiL111t4mQxYZbYkDg3jZFB4g49fq7js6c9giLmGEMZr8+xy+z /b1Ovo2lvsMXQGKehRpbhgXE2TQ5D4Tc04x2XsGlsO99RQ5+UrdkdBwYJkuV8p7H9oLY OuDUfsegJx5HkotElQiZKmpRWgqUxUHwSxz5Olbe/PIi686YiFw7+SshKuEGPG2ARczk jomEbRADH1hoR+kHenSsXzPyTeuTE8VElA9eVqXDXge8qTxbOnyClnkvxJbgL5YVoITo 5g4Q== X-Gm-Message-State: AAQBX9faEehHfst9ZEU8+mswBUAh+KZGAC06mbW7OtvsFXF4M/7MQ2fn rs86orQXk5y4UYlRm18A385Xi4MG7NsmZwo8g4c= X-Received: by 2002:a7b:cb8d:0:b0:3f1:789d:ad32 with SMTP id m13-20020a7bcb8d000000b003f1789dad32mr1836342wmi.11.1682006248649; Thu, 20 Apr 2023 08:57:28 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id bi26-20020a05600c3d9a00b003eddc6aa5fasm2024962wmb.39.2023.04.20.08.57.25 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:26 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 52CA31FFC0; Thu, 20 Apr 2023 16:57:24 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour , Mark Cave-Ayland Subject: [PATCH 8/9] docs/devel: mention the spacing requirement for QOM Date: Thu, 20 Apr 2023 16:57:22 +0100 Message-Id: <20230420155723.1711048-9-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32f; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x32f.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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org We have a more complete document on QOM but we should at least mention the style requirements in the style guide. Signed-off-by: Alex Bennée Cc: Mark Cave-Ayland Reviewed-by: Juan Quintela --- docs/devel/qom.rst | 2 ++ docs/devel/style.rst | 29 +++++++++++++++++++++++++++++ 2 files changed, 31 insertions(+) diff --git a/docs/devel/qom.rst b/docs/devel/qom.rst index 3e34b07c98..c9237950d0 100644 --- a/docs/devel/qom.rst +++ b/docs/devel/qom.rst @@ -1,3 +1,5 @@ +.. _qom: + =========================== The QEMU Object Model (QOM) =========================== diff --git a/docs/devel/style.rst b/docs/devel/style.rst index 5bc6f2f095..0bd01f3fca 100644 --- a/docs/devel/style.rst +++ b/docs/devel/style.rst @@ -628,6 +628,35 @@ are still some caveats to beware of QEMU Specific Idioms ******************** +QEMU Object Model Declarations +============================== + +The QEMU Object Model (QOM) provides a framework for handling objects +in the base C language. The first declaration of a storage or class +structure should always be the parent and leave a visual space between +that declaration and the new code. + +.. code-block:: c + + typedef struct MyDeviceState { + DeviceState parent_obj; + + /* Properties */ + int prop_a; + char *prob_b; + /* Other stuff */ + int internal_state; + } MyDeviceState; + + typedef struct MyDeviceClass { + ObjectClass parent_class; + + void (*new_fn1)(void); + bool (*new_fn2)(CPUState *); + } MyDeviceClass; + +See :ref:`qom` for more details. + Error handling and reporting ============================ From patchwork Thu Apr 20 15:57:23 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?q?Alex_Benn=C3=A9e?= X-Patchwork-Id: 675641 Delivered-To: patch@linaro.org Received: by 2002:a5d:4a41:0:0:0:0:0 with SMTP id v1csp395069wrs; Thu, 20 Apr 2023 08:59:32 -0700 (PDT) X-Google-Smtp-Source: AKy350bBrxoLcenli+NJsqtGyGMLTjHyZC64XyqWTMsX9b+4/LGm7RNlLVaIrgRz7nbTzOK+akec X-Received: by 2002:ad4:5d49:0:b0:5e9:2d8c:99e0 with SMTP id jk9-20020ad45d49000000b005e92d8c99e0mr2635594qvb.22.1682006372111; Thu, 20 Apr 2023 08:59:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1682006372; cv=none; d=google.com; s=arc-20160816; b=jUWyeyWIM5Crtmh98WQhzTG8QwwOV1X+PSjsmLGN6AEzx32DzqeLH3DVHxOBj8ZA3Y bejq+PNjFaZHmlXbSa1iMzlHw+gbwEGQIo08SwXMJgupG0xDvxexBii6oaMwyeMoUjFI d/hKEeBM5PUYsHm9OI+Fh67yXiT84tfQf/LvAjv6kNsFT9B703Elh8Xo9Qy8bJ60WMVK 0ngiHiQZxkvIYOW58Z+LCicvIRpJtuBlf05EA/GmlN4/nZiwT+wWGyZadNWkGwDr3XTI BhUhkLSZlS5FKx1iQ0XzVpmaaKewz0+1V3z/puUHXHvOrUFPNGe0y0HQlXzz6IqOaUHr PHMQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:content-transfer-encoding :mime-version:references:in-reply-to:message-id:date:subject:cc:to :from:dkim-signature; bh=iXPQOZPEUZEREA0kEgOAFX8HZGCmldGugGG6ngHb1YM=; b=S4D09P0P1CsOjJNLqK130L8zcZopAAdo5KkuG4RoS5kfqlUiEukd8Av9UHG+F1LwKP BgAeZ4iLf7TfReT8dQQdAJFGBTqSm6MiBWpfliu25jmuOVV7Q0YdrYDS6/CGZQ6jpp6a orSc0WvNiodnTollRabQS1HFaeSPyHxFoPpwaKVUo4FdWOMJD9lfIzWhCate6NQ5FvJn bem0h9soYlWkePe4ksSyUlVZpfiZGFqHQ/i3sltVEdIKEaWbdSEjVBnFvHFxuTDWdQ6A ADVCwkORYS59SPmhQ+jKJp7xlOC2BGnszupYnCcZnYf0dBEY83isYqTV259ofyCukyml 0ggA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=H2Rmtedt; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id s9-20020a05622a178900b003ef30f52155si1599689qtk.312.2023.04.20.08.59.31 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Apr 2023 08:59:32 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=H2Rmtedt; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ppWfA-0000E5-BF; Thu, 20 Apr 2023 11:57:36 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ppWf6-0000Bw-Sq for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: from mail-wr1-x434.google.com ([2a00:1450:4864:20::434]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ppWf4-0007vG-Kg for qemu-devel@nongnu.org; Thu, 20 Apr 2023 11:57:32 -0400 Received: by mail-wr1-x434.google.com with SMTP id ffacd0b85a97d-3023a56048bso375204f8f.3 for ; Thu, 20 Apr 2023 08:57:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1682006249; x=1684598249; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=iXPQOZPEUZEREA0kEgOAFX8HZGCmldGugGG6ngHb1YM=; b=H2RmtedtHKryhRg+/vuUtN4soB/0wIE2YXEtxi24tXAJLBEScZikGhtSLQUFkwumEW svf3n1/uX7b9+Kh97ldiPoURwzWV6xMRW6JiqzEkGUTr0SokN9bbQN5r1rkwPhnUGyPY kwA8mqj5apCsmmoNOlZcNh7si62J4O+i2i7yNl5JM4/qJ3aMS9ToU2f1XvyLVhU1gtnF b2oGHoZDAWs9WsSypgcsUfnRzhgZk67t7RYViNTK+2CZ5Ruq1+PfYX7qA38Kda9j0lWl SUWY1LI9O3mPgt9MO4SB0vz+V/vVQCuGVmMaNQJiwfrX2EQScTTT7+UNGHe0Qj4K7rqE SrlQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1682006249; x=1684598249; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=iXPQOZPEUZEREA0kEgOAFX8HZGCmldGugGG6ngHb1YM=; b=dHyjLnRedM4SNfDQCApMkVjBA8gZPRsjj+BdaEodXg2qRzX7g1n2hgD43B8SIlpeIZ yv3YftrhVtJge4/p2SBThWBzCkdJ70u2lz9cOK76wxBv9zcrsloRNbYzZOvO+Yu/f03j vd1wW4Yv7vjtmx5W6dVp86tnIuXR4ZdBKLxRwx63w+o3qDqo0iWw+VkTyt2xATSZe4y0 QFDvvuVXdTATVL5RhtdQ4CnBjt3HAy1Mx1PtVLK7MeN4Vf5NGSePXqU0lDUIvTLvhQpb K999M2AICRZp/TKpNPsx7h9aTwu9uDu/GqecIPMHX4WdmNo7fvI8EZr323oHp6UzH6WR ROqQ== X-Gm-Message-State: AAQBX9d+AfBOg7KFvK5xakE5M0+06BdL78CCuXYgdoqIBAP1ztdmYjH/ UQHhc/5GwRoBJU6aiwZs2UYZDQ== X-Received: by 2002:a5d:5304:0:b0:2f8:67ee:5ca9 with SMTP id e4-20020a5d5304000000b002f867ee5ca9mr1770490wrv.65.1682006248873; Thu, 20 Apr 2023 08:57:28 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id m7-20020a5d4a07000000b002c55521903bsm2276042wrq.51.2023.04.20.08.57.26 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 20 Apr 2023 08:57:27 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 6D2E11FFC1; Thu, 20 Apr 2023 16:57:24 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Elena Ufimtseva , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Daniel_P?= =?utf-8?q?=2E_Berrang=C3=A9?= , peter.maydell@linaro.org, =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Paolo Bonzini , Thomas Huth , Markus Armbruster , Alexandre Iooss , John G Johnson , Jagannathan Raman , Juan Quintela , Eduardo Habkost , Richard Henderson , Mahmoud Mandour Subject: [PATCH 9/9] docs/style: call out the use of GUARD macros Date: Thu, 20 Apr 2023 16:57:23 +0100 Message-Id: <20230420155723.1711048-10-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230420155723.1711048-1-alex.bennee@linaro.org> References: <20230420155723.1711048-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::434; envelope-from=alex.bennee@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, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: qemu-devel-bounces+patch=linaro.org@nongnu.org There use makes our code safer so we should mention them. Signed-off-by: Alex Bennée Reviewed-by: Juan Quintela Reviewed-by: Philippe Mathieu-Daudé Reviewed-by: Vladimir Sementsov-Ogievskiy --- docs/devel/style.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/docs/devel/style.rst b/docs/devel/style.rst index 0bd01f3fca..b50a981a86 100644 --- a/docs/devel/style.rst +++ b/docs/devel/style.rst @@ -657,6 +657,42 @@ that declaration and the new code. See :ref:`qom` for more details. +QEMU GUARD macros +================= + +QEMU provides a number of ``_GUARD`` macros intended to make the +handling of multiple exit paths easier. For example using +``QEMU_LOCK_GUARD`` to take a lock will ensure the lock is released on +exit from the function. + +.. code-block:: c + + static int my_critical_function(SomeState *s, void *data) + { + QEMU_LOCK_GUARD(&s->lock); + do_thing1(data); + if (check_state2(data)) { + return -1; + } + do_thing3(data); + return 0; + } + +will ensure s->lock is released however the function is exited. There +are often ``WITH_`` forms of macros which more easily wrap around a +block inside a function. + +.. code-block:: c + + WITH_RCU_READ_LOCK_GUARD() { + QTAILQ_FOREACH_RCU(kid, &bus->children, sibling) { + err = do_the_thing(kid->child); + if (err < 0) { + return err; + } + } + } + Error handling and reporting ============================