From patchwork Mon Jun 26 21:59: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: 696512 Delivered-To: patch@linaro.org Received: by 2002:adf:e885:0:0:0:0:0 with SMTP id d5csp3450102wrm; Mon, 26 Jun 2023 15:08:37 -0700 (PDT) X-Google-Smtp-Source: ACHHUZ7+AuhzNASdDHkCBxbSyRccPriW7vBDFDpmM/a8mm/BC6x1ALSqKnAKSRBBq0inBxEu5qKW X-Received: by 2002:a37:f702:0:b0:765:5a1f:89 with SMTP id q2-20020a37f702000000b007655a1f0089mr6713883qkj.13.1687817317391; Mon, 26 Jun 2023 15:08:37 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1687817317; cv=none; d=google.com; s=arc-20160816; b=ybWb3+9uP6+fnnPagHTIkHbtvjuRt9T6+ddoqQAGlwCOllauZf/qyh/8Z0F6jDFus/ KMpEPF93YeRF6mLug3RrBUvRoLGlGeYyF2AiujMulQjSsTMkaWg5x4BVeOEJkR9nuIbR A4N3Ys6ycp6h/L6d9RqqSs1hU5YLiYZuH2sP2GjUagpAEB3IfnD0Chcd18xMZW46jK6h +zc15mm0BohscncvXvrWdvPM0dedgL5QV4EfwxjbjFmtgZQq0YLQ5gxDupPuW8NYJ6VK T1PZSO2mgJ0hPqzBp4vik7jL1OfKhPRM5RPBRUWWs1E8zzisKvcOeV4U9v4e+MqG+LqD J7iA== 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=; fh=sQEya64SXtq2IEsk3H77u01QQAMvGjGQGvqUW/mcVd0=; b=hL9S579kymizEnV6ORhq27d5r2fKe7ek7WBRiemRLq/E869dd4Qak7DCrUEc/6CKjC OPtzqWXXfrs6URqpfl6nL3EGrHQzV7TzgOWV1E08IXRiwSasqvhJsRoWevRE4PsIBBCW 2MF1y8mHEy6sbQH7W/RZCdM/KM2mtJLAMRM6ma9M/k1YO5GKeJjaYMu+Lpa81llsfx4+ OYFvMN77CvEhaNWojJ32CgjUjKOta/Xq0UtPA11sHufgGrTLILPyRzXcUigNTS4GbnTe dJMZ6pMOSRebDS9VnhKDH/j7bafbPFZda0MIDfpy7UQtZ73/OsK2oxDET2fNwr0O2zgL 4QCg== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@linaro.org header.s=google header.b=CpkZZ0CK; 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 tq15-20020a05620a3d0f00b007624a2935bdsi771598qkn.270.2023.06.26.15.08.37 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Mon, 26 Jun 2023 15:08:37 -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=CpkZZ0CK; 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 1qDuLi-0003WB-1z; Mon, 26 Jun 2023 18:06:25 -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 1qDuLL-0003B3-VR for qemu-devel@nongnu.org; Mon, 26 Jun 2023 18:06:02 -0400 Received: from mail-wm1-x32d.google.com ([2a00:1450:4864:20::32d]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qDuLH-000711-As for qemu-devel@nongnu.org; Mon, 26 Jun 2023 18:05:55 -0400 Received: by mail-wm1-x32d.google.com with SMTP id 5b1f17b1804b1-3f9bece8e19so59491445e9.1 for ; Mon, 26 Jun 2023 15:05:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; t=1687817149; x=1690409149; 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=CpkZZ0CKU8Y+Kgdy29V40D9fpialqs9DGS75Oea7uipjHWC0mEMCs0yUl4OJl6iGl8 17ktNqlW44ICSP9a6csLe/GyZ3VMPk0Troi0LStvCxUOuGTS73RwJ2RVVtmIB4xLSq0N sbbR1+3MolhJunBP1YiVWGFYEhIGCeOsqRNOLL00vrIS9UiWui111IMpITWm4AdylRa5 O0YBrHTRVbCCbL8+W+TWGhrtbPmS70vO2b9LxOoSTC9tnhWMZLFqw02d0HFLFOJPyGbb kAl/4l7q7tHYztH/sG6QFYB9v2KAL4B0fxW9FvSJx75+e4/c9Y17O3xWAZ1HOOMpe2KW lFuA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1687817149; x=1690409149; 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=Xe7yfxO8JunsDrgGT4oxSZWIW/9UFvxLtHfyV4vkDVI7bfWLA1OspwwMX00hx/8vnf avT27Amv1nlQqiO8eBAIt77iszOslQXPyi1JjxiEgk/7I7RcV916hpzZ232on3dgfkTa CUfVVRH5fJffxNBB9/xLGnf5naVxGasEBK5K2/ajN/qWYMUYLiDEQ4FO4x0VCOttGzHS QBrByIEwSmtyq/c2WlrmLZ5PdC4xoWvrv6JUa+fIjQqZoDLAwRldrm3nOdypIyUVGxFd DGSS7O+N2e35XEn2zKKbjNs4aHq4Jjg0LvDEPRhEbgFzejxAf3M+uwDNn9aPL+Ywi1bP pkyg== X-Gm-Message-State: AC+VfDzs6UDw7rPZvTOru8K/D4ZghNhjfBbkWvWBJ3hKULd8UNbXe72q VMCMOQgmVV86Nu6GPyipGguaUA== X-Received: by 2002:adf:db47:0:b0:313:f084:2ecb with SMTP id f7-20020adfdb47000000b00313f0842ecbmr5038461wrj.52.1687817149131; Mon, 26 Jun 2023 15:05:49 -0700 (PDT) Received: from zen.linaroharston ([85.9.250.243]) by smtp.gmail.com with ESMTPSA id b3-20020a056000054300b002c70ce264bfsm8543321wrf.76.2023.06.26.15.05.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 26 Jun 2023 15:05:48 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id 5A95B1FFCB; Mon, 26 Jun 2023 22:59:29 +0100 (BST) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: qemu-devel@nongnu.org Cc: Alexander Bulekov , =?utf-8?q?Daniel_P=2E_Berrang=C3=A9?= , Juan Quintela , Alexandre Iooss , Thomas Huth , Marcel Apfelbaum , Leif Lindholm , Riku Voipio , Peter Maydell , Paolo Bonzini , Bandan Das , Leonardo Bras , Cleber Rosa , Richard Henderson , Beraldo Leal , =?utf-8?q?Alex_Benn=C3=A9e?= , Peter Xu , =?utf-8?q?Philippe_Mathieu-Daud=C3=A9?= , Mahmoud Mandour , Stefan Hajnoczi , Yanan Wang , Eduardo Habkost , Bin Meng , qemu-arm@nongnu.org, Wainer dos Santos Moschetta , Darren Kenny , Radoslaw Biernacki , Marcin Juszkiewicz , Qiuhao Li , Laurent Vivier Subject: [PATCH v2 20/26] docs/devel: add some front matter to the devel index Date: Mon, 26 Jun 2023 22:59:20 +0100 Message-Id: <20230626215926.2522656-21-alex.bennee@linaro.org> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230626215926.2522656-1-alex.bennee@linaro.org> References: <20230626215926.2522656-1-alex.bennee@linaro.org> MIME-Version: 1.0 Received-SPF: pass client-ip=2a00:1450:4864:20::32d; envelope-from=alex.bennee@linaro.org; helo=mail-wm1-x32d.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 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 ====================