From patchwork Wed Mar 23 11:27:07 2022 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: 553744 Delivered-To: patch@linaro.org Received: by 2002:a05:7000:1248:0:0:0:0 with SMTP id z8csp3316733mag; Wed, 23 Mar 2022 04:50:46 -0700 (PDT) X-Google-Smtp-Source: ABdhPJxDeBRo2jKfHkAhYdt8IqE/nTqzTJj52P968O5OcIOEQchNIFz1g+siAojQPoy5L3LSFd4D X-Received: by 2002:a05:6214:500c:b0:435:6b7d:5bc3 with SMTP id jo12-20020a056214500c00b004356b7d5bc3mr23017033qvb.92.1648036246407; Wed, 23 Mar 2022 04:50:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1648036246; cv=none; d=google.com; s=arc-20160816; b=wQO0+bn8Vpn4+RXiFk4lWTZLsLxZ+GJ+D1WoW0IGdYCIJIgAzFgDVLtgElKzAx68eV XXklciG50NbXy+9TTE+RwdSRnNrX/zeFSucY1aXt8iEr2EE3zlvFQmizivZg9EQ1XF1R PR0ZC7iKloXmwHWqoI36Gzzp7iyEhcn6e//nSZIP8GGc/iS6lygjjsl5usuMlrHGehJt o1Oa891T14Trc6ry4CIZNZJSmdaxcNq6cRz4+qk/zizMdcxAt8A2Lu6m54hWwsU9fLkA eFTWI3H9nBNcoub7eqqYIqf3I/MyHWPNYW+JbtfVVg2XGVGrpm/leiHQyHXWJPgUNRQo BLtw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc: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:to:from :dkim-signature; bh=Zp2Sjdd9zoSrgaf/w0vqz4NfuF1qKahAjTWAzq9LOCs=; b=jDiUKXLoA8hw0vgSKVcnJ5H4h1kruZxAnzQ5qdsOksuNDiTygVPpGH8CU1obZZ98rl s8X7OX2/uO5ixVV62dORR19maQpVimLoSGyDOFX3+lcBX35UqCNbtxKNh3B2f+hert0i LtS56A42ci2jzBXsJmBurr7UWyspeopuMSbRpzyJKuWdoTa0gJCfgkoxThdG5HLwQCF6 yVjjyYY4zMRn6/LiiaLKLLiLQTrvGGVFDtqH95Wj5ddfU91YX8fZMK/t/QkAAryN2i/R lyVMlT2kkxlObfeHQa9IntbgGOkX05bjGqYt6VYMfQJUferRHJ2rSKUP+Gr7nUJXlaJ+ rH2Q== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=so94ONMG; 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=fail (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 t22-20020a05622a01d600b002e1fbf3bfb5si4598575qtw.422.2022.03.23.04.50.46 for (version=TLS1_2 cipher=ECDHE-ECDSA-CHACHA20-POLY1305 bits=256/256); Wed, 23 Mar 2022 04:50:46 -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=fail header.i=@linaro.org header.s=google header.b=so94ONMG; 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=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([::1]:48546 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nWzVl-0000zh-RB for patch@linaro.org; Wed, 23 Mar 2022 07:50:45 -0400 Received: from eggs.gnu.org ([209.51.188.92]:39084) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nWz98-0001w3-Se for qemu-devel@nongnu.org; Wed, 23 Mar 2022 07:27:22 -0400 Received: from [2a00:1450:4864:20::42d] (port=37754 helo=mail-wr1-x42d.google.com) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nWz97-00064l-9p for qemu-devel@nongnu.org; Wed, 23 Mar 2022 07:27:22 -0400 Received: by mail-wr1-x42d.google.com with SMTP id u16so1663176wru.4 for ; Wed, 23 Mar 2022 04:27:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=Zp2Sjdd9zoSrgaf/w0vqz4NfuF1qKahAjTWAzq9LOCs=; b=so94ONMG/oSKh3pTnH66AJGpuPa+MBGVs117WP9X+wQ9q57xLYXih1EdrNL+KSS4zU eQJ6C9AIYrXfB0QYN1rw2RMemU3vvIPFyybTWbnjC4Jakx/stzDeLF8D2elKnVtVgIh9 PEZG9C4xDtQLvmw/ONgJCEKUJI4zfYF6tba5YU9y+szPO4bZjiFGXHLVXJ+F/3nzqmnN 0+YiZi/soBX99eqyRdGSlfcwCh88GROTz8Aea2gLuQPAwyQr7VFwTAV1mpIpRBse5wwW q5P32EvjuDrJMjO0TDXeQQ9aCGMmCnfC9wH0Znsp/kSNxMrZazf378wrMH63bWS8m8dj QbwA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Zp2Sjdd9zoSrgaf/w0vqz4NfuF1qKahAjTWAzq9LOCs=; b=d7Z9GKF2YKkoO190p45U9hR6j6eJJQ5HKLkeQrrghMN4vH6yiV6qMMkSPZuicxtw3Y kuciiN5SY6QoWUXo4f2YJdhgRnytzn6YQ55KG04vOoAr9hDT1bgqOZrr11Z4renp3Rlo Vz4dvJoGkwH7wDUOMxIH0HbVKnWW7N2WgIQ7hTAs3xw3i/A1O7KANuSnvjXQ5DVJADyy dctclGg6KtfNxFuN9Nn7i7M8S3HBfeUX4bhm2E0GqV8DdjVSuVKAxTPkw+PCk5MIaN/x M2ohsgX4UDhjjkm2WQszbWjrunfOEolX+N0VDK0258hHipkgvBR7RlN65ygHwv33aW+j ZRqg== X-Gm-Message-State: AOAM530KIE9ONj2lpfzeZYaBuZrFWcFcvxi6pKJUjC2NFI3cEbB2St3U gyZmYanWvA4TB+d1cZ4lRajpQ6UXWqG3Ag== X-Received: by 2002:adf:e4c2:0:b0:204:6d8:ce9a with SMTP id v2-20020adfe4c2000000b0020406d8ce9amr15455284wrm.189.1648034840010; Wed, 23 Mar 2022 04:27:20 -0700 (PDT) Received: from zen.linaroharston ([51.148.130.216]) by smtp.gmail.com with ESMTPSA id c124-20020a1c3582000000b00384d42a9638sm3751808wma.2.2022.03.23.04.27.12 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Wed, 23 Mar 2022 04:27:17 -0700 (PDT) Received: from zen.lan (localhost [127.0.0.1]) by zen.linaroharston (Postfix) with ESMTP id D1BBD1FFBC; Wed, 23 Mar 2022 11:27:11 +0000 (GMT) From: =?utf-8?q?Alex_Benn=C3=A9e?= To: peter.maydell@linaro.org Subject: [PULL 4/8] docs/devel: try and impose some organisation Date: Wed, 23 Mar 2022 11:27:07 +0000 Message-Id: <20220323112711.440376-5-alex.bennee@linaro.org> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220323112711.440376-1-alex.bennee@linaro.org> References: <20220323112711.440376-1-alex.bennee@linaro.org> MIME-Version: 1.0 X-Host-Lookup-Failed: Reverse DNS lookup failed for 2a00:1450:4864:20::42d (failed) Received-SPF: pass client-ip=2a00:1450:4864:20::42d; envelope-from=alex.bennee@linaro.org; helo=mail-wr1-x42d.google.com X-Spam_score_int: -6 X-Spam_score: -0.7 X-Spam_bar: / X-Spam_report: (-0.7 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, PDS_HP_HELO_NORDNS=0.659, RCVD_IN_DNSWL_NONE=-0.0001, RDNS_NONE=0.793, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no 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: , Cc: =?utf-8?q?Alex_Benn=C3=A9e?= , qemu-devel@nongnu.org, Kashyap Chamarthy Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" We have a growing set of developer docs but the index is currently in order of when stuff was added. Try and make things a bit easier to find my adding sub indexes and organising into themes. Signed-off-by: Alex Bennée Reviewed-by: Kashyap Chamarthy Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org> diff --git a/docs/devel/index-api.rst b/docs/devel/index-api.rst new file mode 100644 index 0000000000..b749240272 --- /dev/null +++ b/docs/devel/index-api.rst @@ -0,0 +1,15 @@ +Internal QEMU APIs +------------------ + +Details about how QEMU's various internal APIs. Most of these are +generated from in-code annotations to function prototypes. + +.. toctree:: + :maxdepth: 2 + :includehidden: + + bitops + loads-stores + memory + modules + ui diff --git a/docs/devel/index-build.rst b/docs/devel/index-build.rst new file mode 100644 index 0000000000..d96894f07c --- /dev/null +++ b/docs/devel/index-build.rst @@ -0,0 +1,19 @@ +QEMU Build and Test System +-------------------------- + +Details about how QEMU's build system works and how it is integrated +into our testing infrastructure. You will need to understand some of +the basics if you are adding new files and targets to the build. + +.. toctree:: + :maxdepth: 2 + :includehidden: + + build-system + kconfig + testing + qtest + ci + qapi-code-gen + fuzzing + control-flow-integrity diff --git a/docs/devel/index-internals.rst b/docs/devel/index-internals.rst new file mode 100644 index 0000000000..bb118b8eaf --- /dev/null +++ b/docs/devel/index-internals.rst @@ -0,0 +1,21 @@ +Internal Subsystem Information +------------------------------ + +Details about QEMU's various subsystems including how to add features to them. + +.. toctree:: + :maxdepth: 2 + :includehidden: + + qom + atomics + block-coroutine-wrapper + clocks + ebpf_rss + migration + multi-process + reset + s390-dasd-ipl + tracing + vfio-migration + writing-monitor-commands diff --git a/docs/devel/index-process.rst b/docs/devel/index-process.rst new file mode 100644 index 0000000000..314e9e94cc --- /dev/null +++ b/docs/devel/index-process.rst @@ -0,0 +1,17 @@ +QEMU Community Processes +------------------------ + +Notes about how to interact with the community and how and where to submit patches. + +.. toctree:: + :maxdepth: 2 + :includehidden: + + code-of-conduct + conflict-resolution + style + submitting-a-patch + trivial-patches + stable-process + submitting-a-pull-request + secure-coding-practices diff --git a/docs/devel/index-tcg.rst b/docs/devel/index-tcg.rst new file mode 100644 index 0000000000..3acbd95d36 --- /dev/null +++ b/docs/devel/index-tcg.rst @@ -0,0 +1,16 @@ +TCG Emulation +------------- + +Details about QEMU's Tiny Code Generator and the infrastructure +associated with emulation. You do not need to worry about this if you +are only implementing things for HW accelerated hypervisors. + +.. toctree:: + :maxdepth: 2 + :includehidden: + + tcg + decodetree + multi-thread-tcg + tcg-icount + tcg-plugins diff --git a/docs/devel/index.rst b/docs/devel/index.rst index afd937535e..a68207052d 100644 --- a/docs/devel/index.rst +++ b/docs/devel/index.rst @@ -7,44 +7,12 @@ You only need to read it if you are interested in reading or modifying QEMU's source code. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :includehidden: - code-of-conduct - conflict-resolution - build-system - style - kconfig - testing - fuzzing - control-flow-integrity - loads-stores - memory - migration - atomics - stable-process - ci - qtest - decodetree - secure-coding-practices - tcg - tcg-icount - tracing - multi-thread-tcg - tcg-plugins - bitops - ui - reset - s390-dasd-ipl - clocks - qom - modules - block-coroutine-wrapper - multi-process - ebpf_rss - vfio-migration - qapi-code-gen - writing-monitor-commands - trivial-patches - submitting-a-patch - submitting-a-pull-request + + index-process + index-build + index-api + index-internals + index-tcg