From patchwork Fri Jun 23 12:20:55 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: 695263 Delivered-To: patch@linaro.org Received: by 2002:adf:e885:0:0:0:0:0 with SMTP id d5csp1925620wrm; Fri, 23 Jun 2023 05:35:17 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ4Drybjcqz/EqTAza/OF4vXcnhXLXOPfcbKQGglcqgxZ/ogXaU6sTxfKQuO4Y9aH6EX0814 X-Received: by 2002:a05:622a:215:b0:3f6:910a:aace with SMTP id b21-20020a05622a021500b003f6910aaacemr29972399qtx.23.1687523717416; Fri, 23 Jun 2023 05:35:17 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687523717; cv=none; d=google.com; s=arc-20160816; b=pjofKMyrkYaRQT0l4fqGDvpzZZDG4WvFY1kQWBCRwVnzqRZcaT2l530YMceLylFdDo JI2Yv11evoAwCi2X+A37YGwu1RlOzRHsRKUuZ/OlOTZ8yQerX2jY1WACa16kMOPSjPFp 8Hg5z1ZeRoGKn1NFiG0tATpJSgDRGbZ6BpAIW2bYEsWlGSS+ZqpfpkgYsinPZMmDXxeS 8Ogh40hsQJZQL9zcVcxt5mIL30opTWx2JRZDWkjGEAgkDfvbMgZJ6eJrJPfX++WDbuTn kr7nIUHFJIP7kbeF9SEiZAL9ZGELJvQXvmdFiN22z3UBt1GQVubG9qG5hE9lPUExoxGh gv8A== 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=zOww9rbYnTUV82Nt8luSAT3uGVvZz6IBM9I4dizL0VQ=; b=W86kmqGBUXtlec/5qrMmxwxsffOmsDpGmy3js4UA5DinFL7iTfOTN3Ji6LkWIDB2Cz ibr1MsgszLNxP5cKDdD6CTuLmyJn9ZopGlgmBGOAIRmky/9Uut8bx/BZTuOxdWReV+HM dRuftcIOzH6kHyRbpy6Ntg348GdpJaui2wu4oS7+F+skYa4M3zx4FLc2ei/iySLxR13a GpmDf8BcIkqHTbAbHtScNqPzWJvuWuENb5jBa0iOcAxAhtuTTglK1bAFLXreRUnNOSNR SGXRnXd2siiTy1VSr1McrvEEU7ziS/UgD7TktGwPhzw5UDaQvCkM4gpmwNTsdbNlb+W1 XHBA== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=iXB8XtNZ; 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 y1-20020a05622a004100b003f3940c6a77si3518244qtw.10.2023.06.23.05.35.17 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 23 Jun 2023 05:35:17 -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=iXB8XtNZ; 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 1qCfwZ-0001Ej-05; Fri, 23 Jun 2023 08:31:15 -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 1qCfwG-00019a-9X for qemu-devel@nongnu.org; Fri, 23 Jun 2023 08:30:57 -0400 Received: from mail-wr1-x42f.google.com ([2a00:1450:4864:20::42f]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qCfwB-0000T5-6A for qemu-devel@nongnu.org; Fri, 23 Jun 2023 08:30:55 -0400 Received: by mail-wr1-x42f.google.com with SMTP id ffacd0b85a97d-3129c55e1d1so675832f8f.0 for ; Fri, 23 Jun 2023 05:30:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1687523449; x=1690115449; 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=zOww9rbYnTUV82Nt8luSAT3uGVvZz6IBM9I4dizL0VQ=; b=iXB8XtNZCXPeU1aBUK6ybgZYU9vS5QZRQc+LRLIPKqJvJaUs4T2sztPICo2jIDbsf2 +BmtzItp31WLuamO1qlA5RPlp4yYhXC155vDdm4INsMJaAI6wRXmYdgbcYtKMaQidxum YH+ECyyrGF/U23u711tC9pg8jkHqw41aNpOCobYx7Acpq1Bv4nm6F55392Y5TEkEPX45 ZN0XnrHkkRI7QQd+E4AOoduyQpJg/63AuIpVoaufNzXhUTBxx4pd4K1NOfRfIrcmYF2w cg1hZFqcdh5EC8tp2vGlI9WFj1gbUMZbqSFEa18OWSkOKlOgDpb1X8FMXazJ10+lzXBy WYeQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687523449; x=1690115449; 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=zOww9rbYnTUV82Nt8luSAT3uGVvZz6IBM9I4dizL0VQ=; b=cWf3GkW5ljfxonVk1OLO0pB2C+hZhRLundBn1ioRIz/WJKxvA5l8tZiNbcKrc5jQer 46QrtzZgln2eAKWpR3ENiw+9Fwpl2As/DGuU1ue7KZqGsy/QRbCN5T3VGmR6yBZl6tIG /gNIl8Iigf3Pa8mJx5b6QgvZ9gnsqtv5GIPXgabfsGJ0uu1wOvlqptghoBgcOGTKifjC cdWJXIrgXcT/jRf/TKEzmwsJCIO9dru8oZVoleAJw1+2QU6EdycLD64K/76HNe6yrd5/ BgxOQGdHKLdPna6l67vpncT39OCzHQZ6gdVcnWhQkpX9QrLEEO7slo859q7w2LLG2MH4 ofiA== X-Gm-Message-State: AC+VfDyhhxxSkosRQeTmfSq6gVHYyPqIazry5fWkdoZu4hN/1hk8+Osg 5tZHBNOlzDDUy+sgSrwa3rmHtg== X-Received: by 2002:a05:6000:1191:b0:30a:b147:69db with SMTP id g17-20020a056000119100b0030ab14769dbmr19275521wrx.24.1687523449514; Fri, 23 Jun 2023 05:30:49 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id a16-20020adfe5d0000000b0030e5a63e2dbsm9481515wrn.80.2023.06.23.05.30.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 23 Jun 2023 05:30:49 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 1C6901FFBF; Fri, 23 Jun 2023 13:21:03 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Richard Henderson , Juan Quintela , Peter Maydell , Cleber Rosa , Darren Kenny , Alexandre Iooss , Peter Xu , qemu-arm@nongnu.org, Eduardo Habkost , Riku Voipio , Mahmoud Mandour , =?utf-8?q?Daniel_P=2E_Berrang?= =?utf-8?q?=C3=A9?= , Paolo Bonzini , Bandan Das , Marcin Juszkiewicz , Radoslaw Biernacki , Alexander Bulekov , Leif Lindholm , Qiuhao Li , Wainer dos Santos Moschetta , Marcel Apfelbaum , Leonardo Bras , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Stefan Hajnoczi , Bin Meng , Thomas Huth , Beraldo Leal , Laurent Vivier , Yanan Wang , =?utf-8?q?Alex_Benn=C3=A9e?= Subject: [PATCH 21/26] docs/devel: add some front matter to the devel index Date: Fri, 23 Jun 2023 13:20:55 +0100 Message-Id: <20230623122100.1640995-22-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230623122100.1640995-1-alex.bennee@linaro.org> References: <20230623122100.1640995-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::42f; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42f.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=unavailable 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 Give an overview of the most useful bits of the devel documentation to read depending on what the developer wants to do. Reviewed-by: Peter Maydell Reviewed-by: Richard Henderson Signed-off-by: Alex Bennée Message-Id: <20230619171437.357374-2-alex.bennee@linaro.org> --- v2 - removed excessive start --- docs/devel/index-process.rst | 2 ++ docs/devel/index-tcg.rst | 2 ++ docs/devel/index.rst | 24 ++++++++++++++++++++++-- docs/devel/tcg.rst | 2 ++ 4 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/devel/index-process.rst b/docs/devel/index-process.rst index d50dd74c3e..362f97ee30 100644 --- a/docs/devel/index-process.rst +++ b/docs/devel/index-process.rst @@ -1,3 +1,5 @@ +.. _development_process: + QEMU Community Processes ------------------------ diff --git a/docs/devel/index-tcg.rst b/docs/devel/index-tcg.rst index b44ff8b5a4..a992844e5c 100644 --- a/docs/devel/index-tcg.rst +++ b/docs/devel/index-tcg.rst @@ -1,3 +1,5 @@ +.. _tcg: + TCG Emulation ------------- diff --git a/docs/devel/index.rst b/docs/devel/index.rst index 09cfb322be..abf60457c2 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -2,10 +2,30 @@ Developer Information --------------------- -This section of the manual documents various parts of the internals of QEMU. -You only need to read it if you are interested in reading or +This section of the manual documents various parts of the internals of +QEMU. You only need to read it if you are interested in reading or modifying QEMU's source code. +QEMU is a large and mature project with a number of complex subsystems +that can be overwhelming to understand. The development documentation +is not comprehensive but hopefully presents enough to get you started. +If there are areas that are unclear please reach out either via the +IRC channel or mailing list and hopefully we can improve the +documentation for future developers. + +All developers will want to familiarise themselves with +:ref:`development_process` and how the community interacts. Please pay +particular attention to the :ref:`coding-style` and +:ref:`submitting-a-patch` sections to avoid common pitfalls. + +If you wish to implement a new hardware model you will want to read +through the :ref:`qom` documentation to understand how QEMU's object +model works. + +Those wishing to enhance or add new CPU emulation capabilities will +want to read our :ref:`tcg` documentation, especially the overview of +the :ref:`tcg_internals`. + .. toctree:: :maxdepth: 1 diff --git a/docs/devel/tcg.rst b/docs/devel/tcg.rst index b4096a17df..2786f2f679 100644 --- a/docs/devel/tcg.rst +++ b/docs/devel/tcg.rst @@ -1,3 +1,5 @@ +.. _tcg_internals: + ==================== Translator Internals ====================