From: Thomas Huth <thuth@redhat.com>
To: qemu-devel@nongnu.org,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Daniel P . Berrange" <berrange@redhat.com>
Cc: "Alex Bennée" <alex.bennee@linaro.org>,
"Ani Sinha" <anisinha@redhat.com>,
"Richard Henderson" <richard.henderson@linaro.org>,
"John Snow" <jsnow@redhat.com>, "Fabiano Rosas" <farosas@suse.de>
Subject: [PATCH v5 41/44] docs/devel: Split testing docs from the build docs and move to separate folder
Date: Fri, 30 Aug 2024 15:38:35 +0200 [thread overview]
Message-ID: <20240830133841.142644-42-thuth@redhat.com> (raw)
In-Reply-To: <20240830133841.142644-1-thuth@redhat.com>
Building and testing are two separate topics, so let's split the testing
into a separate category and move the related files into a separate folder.
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
docs/devel/index-build.rst | 14 ++++----------
docs/devel/index.rst | 1 +
docs/devel/{ => testing}/acpi-bits.rst | 0
docs/devel/{ => testing}/ci-definitions.rst.inc | 0
docs/devel/{ => testing}/ci-jobs.rst.inc | 0
docs/devel/{ => testing}/ci-runners.rst.inc | 0
docs/devel/{ => testing}/ci.rst | 0
docs/devel/{ => testing}/fuzzing.rst | 0
docs/devel/testing/index.rst | 14 ++++++++++++++
docs/devel/{testing.rst => testing/main.rst} | 0
docs/devel/{ => testing}/qgraph.rst | 0
docs/devel/{ => testing}/qtest.rst | 0
12 files changed, 19 insertions(+), 10 deletions(-)
rename docs/devel/{ => testing}/acpi-bits.rst (100%)
rename docs/devel/{ => testing}/ci-definitions.rst.inc (100%)
rename docs/devel/{ => testing}/ci-jobs.rst.inc (100%)
rename docs/devel/{ => testing}/ci-runners.rst.inc (100%)
rename docs/devel/{ => testing}/ci.rst (100%)
rename docs/devel/{ => testing}/fuzzing.rst (100%)
create mode 100644 docs/devel/testing/index.rst
rename docs/devel/{testing.rst => testing/main.rst} (100%)
rename docs/devel/{ => testing}/qgraph.rst (100%)
rename docs/devel/{ => testing}/qtest.rst (100%)
diff --git a/docs/devel/index-build.rst b/docs/devel/index-build.rst
index 90b406ca0e..0023953be3 100644
--- a/docs/devel/index-build.rst
+++ b/docs/devel/index-build.rst
@@ -1,9 +1,8 @@
-QEMU Build and Test System
---------------------------
+QEMU Build 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.
+Details about how QEMU's build system works. You will need to understand
+some of the basics if you are adding new files and targets to the build.
.. toctree::
:maxdepth: 3
@@ -11,10 +10,5 @@ the basics if you are adding new files and targets to the build.
build-system
kconfig
docs
- testing
- acpi-bits
- qtest
- ci
qapi-code-gen
- fuzzing
control-flow-integrity
diff --git a/docs/devel/index.rst b/docs/devel/index.rst
index abf60457c2..a53f1bfda5 100644
--- a/docs/devel/index.rst
+++ b/docs/devel/index.rst
@@ -31,6 +31,7 @@ the :ref:`tcg_internals`.
index-process
index-build
+ testing/index
index-api
index-internals
index-tcg
diff --git a/docs/devel/acpi-bits.rst b/docs/devel/testing/acpi-bits.rst
similarity index 100%
rename from docs/devel/acpi-bits.rst
rename to docs/devel/testing/acpi-bits.rst
diff --git a/docs/devel/ci-definitions.rst.inc b/docs/devel/testing/ci-definitions.rst.inc
similarity index 100%
rename from docs/devel/ci-definitions.rst.inc
rename to docs/devel/testing/ci-definitions.rst.inc
diff --git a/docs/devel/ci-jobs.rst.inc b/docs/devel/testing/ci-jobs.rst.inc
similarity index 100%
rename from docs/devel/ci-jobs.rst.inc
rename to docs/devel/testing/ci-jobs.rst.inc
diff --git a/docs/devel/ci-runners.rst.inc b/docs/devel/testing/ci-runners.rst.inc
similarity index 100%
rename from docs/devel/ci-runners.rst.inc
rename to docs/devel/testing/ci-runners.rst.inc
diff --git a/docs/devel/ci.rst b/docs/devel/testing/ci.rst
similarity index 100%
rename from docs/devel/ci.rst
rename to docs/devel/testing/ci.rst
diff --git a/docs/devel/fuzzing.rst b/docs/devel/testing/fuzzing.rst
similarity index 100%
rename from docs/devel/fuzzing.rst
rename to docs/devel/testing/fuzzing.rst
diff --git a/docs/devel/testing/index.rst b/docs/devel/testing/index.rst
new file mode 100644
index 0000000000..2711fd78b7
--- /dev/null
+++ b/docs/devel/testing/index.rst
@@ -0,0 +1,14 @@
+Testing QEMU
+------------
+
+Details about how to test QEMU and how it is integrated into our CI
+testing infrastructure.
+
+.. toctree::
+ :maxdepth: 3
+
+ main
+ qtest
+ acpi-bits
+ ci
+ fuzzing
diff --git a/docs/devel/testing.rst b/docs/devel/testing/main.rst
similarity index 100%
rename from docs/devel/testing.rst
rename to docs/devel/testing/main.rst
diff --git a/docs/devel/qgraph.rst b/docs/devel/testing/qgraph.rst
similarity index 100%
rename from docs/devel/qgraph.rst
rename to docs/devel/testing/qgraph.rst
diff --git a/docs/devel/qtest.rst b/docs/devel/testing/qtest.rst
similarity index 100%
rename from docs/devel/qtest.rst
rename to docs/devel/testing/qtest.rst
--
2.46.0
next prev parent reply other threads:[~2024-08-30 13:42 UTC|newest]
Thread overview: 54+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-08-30 13:37 [PATCH v5 00/44] Convert avocado tests to normal Python unittests Thomas Huth
2024-08-30 13:37 ` [PATCH v5 01/44] tests/avocado: machine aarch64: standardize location and RO access Thomas Huth
2024-08-30 13:37 ` [PATCH v5 02/44] tests/avocado/boot_xen.py: fetch kernel during test setUp() Thomas Huth
2024-08-30 13:37 ` [PATCH v5 03/44] tests/avocado/machine_aarch64_sbsaref.py: allow for rw usage of image Thomas Huth
2024-08-30 13:37 ` [PATCH v5 04/44] Bump avocado to 103.0 Thomas Huth
2024-08-30 13:37 ` [PATCH v5 05/44] tests/avocado/avocado_qemu: Fix the "from" statements in linuxtest.py Thomas Huth
2024-08-30 13:38 ` [PATCH v5 06/44] tests/avocado/boot_linux_console: Remove the s390x subtest Thomas Huth
2024-08-30 13:38 ` [PATCH v5 07/44] python: Install pycotap in our venv if necessary Thomas Huth
2024-08-30 13:38 ` [PATCH v5 08/44] tests/functional: Add base classes for the upcoming pytest-based tests Thomas Huth
2024-08-30 13:38 ` [PATCH v5 09/44] tests/functional: Set up logging Thomas Huth
2024-08-30 13:38 ` [PATCH v5 10/44] tests/Makefile.include: Increase the level of indentation in the help text Thomas Huth
2024-08-30 13:38 ` [PATCH v5 11/44] tests/functional: Prepare the meson build system for the functional tests Thomas Huth
2024-08-30 13:38 ` [PATCH v5 12/44] tests/functional: Convert simple avocado tests into standalone python tests Thomas Huth
2024-08-30 13:38 ` [PATCH v5 13/44] tests/functional: Convert avocado tests that just need a small adjustment Thomas Huth
2024-08-30 13:38 ` [PATCH v5 14/44] tests/functional: add a module for handling asset download & caching Thomas Huth
2024-09-02 8:42 ` Philippe Mathieu-Daudé
2024-08-30 13:38 ` [PATCH v5 15/44] tests/functional: enable pre-emptive caching of assets Thomas Huth
2024-08-30 13:38 ` [PATCH v5 16/44] tests/functional: Allow asset downloading with concurrent threads Thomas Huth
2024-08-30 13:38 ` [PATCH v5 17/44] tests/functional: Convert some tests that download files via fetch_asset() Thomas Huth
2024-09-04 9:08 ` Thomas Huth
2024-08-30 13:38 ` [PATCH v5 18/44] tests/functional: Add a function for extracting files from an archive Thomas Huth
2024-08-30 13:38 ` [PATCH v5 19/44] tests/functional: Convert some avocado tests that needed avocado.utils.archive Thomas Huth
2024-08-30 13:38 ` [PATCH v5 20/44] tests/functional: Convert the s390x avocado tests into standalone tests Thomas Huth
2024-08-30 13:38 ` [PATCH v5 21/44] tests/functional: Convert the x86_cpu_model_versions test Thomas Huth
2024-08-30 13:38 ` [PATCH v5 22/44] tests/functional: Convert the microblaze avocado tests into standalone tests Thomas Huth
2024-08-30 13:38 ` [PATCH v5 23/44] tests/functional: Convert the riscv_opensbi avocado test into a standalone test Thomas Huth
2024-09-02 8:45 ` Philippe Mathieu-Daudé
2024-08-30 13:38 ` [PATCH v5 24/44] tests/functional: Convert the virtio_gpu " Thomas Huth
2024-08-30 13:38 ` [PATCH v5 25/44] tests/functional: Convert most ppc avocado tests into standalone tests Thomas Huth
2024-09-02 9:33 ` Philippe Mathieu-Daudé
2024-08-30 13:38 ` [PATCH v5 26/44] tests/functional: Convert the ppc_amiga avocado test into a standalone test Thomas Huth
2024-08-30 13:38 ` [PATCH v5 27/44] tests/functional: Convert the ppc_hv " Thomas Huth
2024-08-30 13:38 ` [PATCH v5 28/44] tests/functional: Convert the m68k nextcube test with tesseract Thomas Huth
2024-08-30 13:38 ` [PATCH v5 29/44] tests/functional: Convert the acpi-bits test into a standalone test Thomas Huth
2024-08-30 13:38 ` [PATCH v5 30/44] tests/functional: Convert the rx_gdbsim avocado " Thomas Huth
2024-08-30 13:38 ` [PATCH v5 31/44] tests/functional: Convert the linux_initrd " Thomas Huth
2024-08-30 13:38 ` [PATCH v5 32/44] tests/functional: Convert the vnc test Thomas Huth
2024-09-02 9:48 ` Philippe Mathieu-Daudé
2024-09-02 10:23 ` Thomas Huth
2024-09-03 13:45 ` Philippe Mathieu-Daudé
2024-09-03 14:14 ` Philippe Mathieu-Daudé
2024-08-30 13:38 ` [PATCH v5 33/44] tests/functional: Convert ARM Integrator/CP avocado tests Thomas Huth
2024-08-30 13:38 ` [PATCH v5 34/44] tests/functional: Convert Aarch64 SBSA-Ref " Thomas Huth
2024-09-03 13:51 ` Philippe Mathieu-Daudé
2024-08-30 13:38 ` [PATCH v5 35/44] tests/functional: Convert Aarch64 Virt machine " Thomas Huth
2024-08-30 13:38 ` [PATCH v5 36/44] tests/functional: Convert mips64el Fuloong2e avocado test (1/2) Thomas Huth
2024-08-30 13:38 ` [PATCH v5 37/44] tests/functional: Add QemuUserTest class Thomas Huth
2024-08-30 13:38 ` [PATCH v5 38/44] tests/functional: Convert ARM bFLT linux-user avocado test Thomas Huth
2024-08-30 13:38 ` [PATCH v5 39/44] tests/avocado: Remove unused QemuUserTest class Thomas Huth
2024-08-30 13:38 ` [PATCH v5 40/44] gitlab-ci: Add "check-functional" to the build tests Thomas Huth
2024-08-30 13:38 ` Thomas Huth [this message]
2024-08-30 13:38 ` [PATCH v5 42/44] docs/devel/testing: Split the Avocado documentation into a separate file Thomas Huth
2024-08-30 13:38 ` [PATCH v5 43/44] docs/devel/testing: Rename avocado_qemu.Test class Thomas Huth
2024-08-30 13:38 ` [PATCH v5 44/44] docs/devel/testing: Add documentation for functional tests Thomas Huth
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240830133841.142644-42-thuth@redhat.com \
--to=thuth@redhat.com \
--cc=alex.bennee@linaro.org \
--cc=anisinha@redhat.com \
--cc=berrange@redhat.com \
--cc=farosas@suse.de \
--cc=jsnow@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=richard.henderson@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).