From patchwork Fri Jun 30 18:04:07 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: 697989 Delivered-To: patch@linaro.org Received: by 2002:adf:fcc5:0:0:0:0:0 with SMTP id f5csp601099wrs; Fri, 30 Jun 2023 11:24:13 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ7Tuyg7cXaGWQukdN4unka/YMpc/NHacAj2e9iszmuERCnkqeuL0YrS+0mzXhDhz02hF/dB X-Received: by 2002:a05:620a:1929:b0:767:100e:4cbd with SMTP id bj41-20020a05620a192900b00767100e4cbdmr3575881qkb.0.1688149453525; Fri, 30 Jun 2023 11:24:13 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1688149453; cv=none; d=google.com; s=arc-20160816; b=wwJGStgN3+IBgVejIV1sNMw87jWHNfL1fVta4fq/JSTAi7/dZG7mKnnaAN3Ao0wOcV N+FUUXOcfEiB2TrUoCr7hpr6xrcaXqr/2iDY0HbMgKDGjlfXXi3DVDKWx4Snl0qSyZSW hUyPsliVxWpOtadKf3lUXVOjYh35ViwibuCMUxXv2HEkqzc1bAHEzSQSo/GVK+LVnPMr jyTKLen0CFyJdAwYd0S9UyqwH2ZV+GPTlSApA4fl6K1+zhPQpF0hSvE4cw+fULXL41ah YWIzErkdW7PoCDprimrPBoWmrnbs1ZRIzOL/74nWdbNDF9xGbTBNQLOgY8CUZIEsS4u1 ZsNQ== 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=c3k4gxlWKUhqIL3YZ385nyvBDR7JSxVw9q07tm06Blc=; fh=OltHerz+Vf7zZkebZbScoRT4WgVwJDskRS7DoEjx2Hw=; b=h1ApxilZrpy6hsYkXIwLedoM7NNUBe1k/CQVIk4dYXURNsPNFAC2xa2UmNMI3ZzNmh nPsZUrQ2YY8atsMt9U+hAKTwPRKA0vPicJvCWt/URzTVWoIxRhcRG8zAjkeXKOdhAeoK zxmvT87BX2Se2KO2it8clp3cmxGwYSd5sxjO1em+414oy8vIJyoZKwUYOp/VknamvIuI 9NAn2Pms83YpSoazuv1tCrZ3ttzQ47km+OtEI7aCrMIMvPsrIqJfXDhZBptE/UC+VlZY bDhE0Ds6dnk6tuDT2qvtbH3Kur4ULjqfdcADK0p3u+bdw3gPIM+NAscycQs3eeFOWxfH oC6g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=PaRW8AyW; 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 sk1-20020a05620a3a4100b00763a23c1f2esi3005901qkn.186.2023.06.30.11.24.13 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Fri, 30 Jun 2023 11:24:13 -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=PaRW8AyW; 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 1qFImT-0004h4-P4; Fri, 30 Jun 2023 14:23:45 -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 1qFImR-0004eq-QS for qemu-devel@nongnu.org; Fri, 30 Jun 2023 14:23:39 -0400 Received: from mail-wm1-x32c.google.com ([2a00:1450:4864:20::32c]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qFImN-0001gC-Ds for qemu-devel@nongnu.org; Fri, 30 Jun 2023 14:23:39 -0400 Received: by mail-wm1-x32c.google.com with SMTP id 5b1f17b1804b1-3fbc244d307so17328195e9.1 for ; Fri, 30 Jun 2023 11:23:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1688149409; x=1690741409; 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=c3k4gxlWKUhqIL3YZ385nyvBDR7JSxVw9q07tm06Blc=; b=PaRW8AyWR4FDOzV1Pxtl17VBw0FaKrG/s1g6whWr0m+GD7rYUEFrO7Yt/ZIJmTkvca 4PRwwZCODPaz5LLVye2iBtM0G4fc5NBfmMH2kCgEaY3xxKF4KH1AawZluXMIfSKNcNsY ZyV2JYyaa8SJ/V07WnbKQ4tG0Jdkr0T3md+btxN2Ol8oo+PmdKsqbJ4202X4wv1JBk7u XOAPvQI4mrfZqbXAs9NJLIhYJ8uTpEzrUx5G0IVkux/DKUMza11m1G895wTdvfiXmkBa zmOdL6oiO4/S6C7Tr2Y/uffLE3m8j09vLroM6UOOX0ZTsqUbH8JOn3efIwYGevh4e7m2 ScLA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1688149409; x=1690741409; 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=c3k4gxlWKUhqIL3YZ385nyvBDR7JSxVw9q07tm06Blc=; b=TXmAVADcFEyBUjiLqEH2aHQXw3GKvXUxwGw+w4CoRjzAH3WI1XTGWJTegdOhvFj0fk mngvqA0owo0H8jub7RUsmvSmmWppctXfrKcG/MVdhzrWJizamSJKJyC1nPmheNiLiN8F 0XLaucwFqJ/zXCrr7UA624szJtEUi6o5S6Gk7RUiO10A+PpS2Ng0SKdHcWazUy+oQDzS phTVsQ8LJi9Q1ZveGcoGbMl0sA5RKZJ9yvfQsuBvCRU7yDHeaVgoGNl8KqzqRtCMS5Rm NhPKUu1WmObFg8DDTbGGwlXnVoDHi79bR+tUxnv5DN+fn+gqbFh2RzTP0XI58+WM/5ga S3uA== X-Gm-Message-State: AC+VfDzkpOyfy4IKEXW4ayoZrCqZ1AdsAFPHpZ/97rhKTLhWX9nQioc5 uvHaNRzl1LKwxh9Hfw6PUbySjg== X-Received: by 2002:a7b:cd9a:0:b0:3fa:8d25:fde3 with SMTP id y26-20020a7bcd9a000000b003fa8d25fde3mr2770062wmj.11.1688149409349; Fri, 30 Jun 2023 11:23:29 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id h2-20020a1ccc02000000b003fa74bff02asm19469314wmb.26.2023.06.30.11.23.27 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 30 Jun 2023 11:23:28 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 8B0AF1FFBF; Fri, 30 Jun 2023 19:04:26 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Paolo Bonzini , Stefan Hajnoczi , Leonardo Bras , Laurent Vivier , Peter Xu , Juan Quintela , Beraldo Leal , Radoslaw Biernacki , Qiuhao Li , Peter Maydell , Yanan Wang , Riku Voipio , Wainer dos Santos Moschetta , Mahmoud Mandour , Alexandre Iooss , =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Philippe_M?= =?utf-8?q?athieu-Daud=C3=A9?= , Eduardo Habkost , Thomas Huth , Laurent Vivier , Bin Meng , Marcel Apfelbaum , Bandan Das , Cleber Rosa , Richard Henderson , Leif Lindholm , Marcin Juszkiewicz , qemu-arm@nongnu.org, Darren Kenny , Alexander Bulekov Subject: [PATCH v4 22/38] docs/devel: add some front matter to the devel index Date: Fri, 30 Jun 2023 19:04:07 +0100 Message-Id: <20230630180423.558337-23-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230630180423.558337-1-alex.bennee@linaro.org> References: <20230630180423.558337-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32c; envelope-from=alex.bennee@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, 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 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 Reviewed-by: Philippe Mathieu-Daudé Message-Id: <20230623122100.1640995-22-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 ====================