From 6aa3d8abce62d94b0fa947b3aaa848bea6b7279b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?N=C3=ADcolas=20F=2E=20R=2E=20A=2E=20Prado?= Date: Tue, 1 Oct 2024 14:33:58 -0400 Subject: [PATCH] docs: Add page for device tests MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Add a page with a brief overview of device tests and how to enable them with pointers to the relevant documentation. Signed-off-by: Nícolas F. R. A. Prado --- .../content/en/kernel-community/_index.md | 2 ++ .../en/kernel-community/device-tests.md | 30 +++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 kernelci.org/content/en/kernel-community/device-tests.md diff --git a/kernelci.org/content/en/kernel-community/_index.md b/kernelci.org/content/en/kernel-community/_index.md index d60aecc3..5a241016 100644 --- a/kernelci.org/content/en/kernel-community/_index.md +++ b/kernelci.org/content/en/kernel-community/_index.md @@ -14,4 +14,6 @@ This section of the documentation shares instructions to: * [enable specific tests](../maestro/pipeline/developer-documentation/#enabling-a-new-test) * [visualize the results](view-results) +For suggestions of device tests, see [device kselftests](device-tests). + We know that the documentation above may not answer all your questions. We are working to improve it. We ask you to reach out to our mailing list at [kernelci@lists.linux.dev](mailto:kernelci@lists.linux.dev) with questions and feedback. We are eager to hear from you! diff --git a/kernelci.org/content/en/kernel-community/device-tests.md b/kernelci.org/content/en/kernel-community/device-tests.md new file mode 100644 index 00000000..c56d3a3a --- /dev/null +++ b/kernelci.org/content/en/kernel-community/device-tests.md @@ -0,0 +1,30 @@ +--- +title: "Device kselftests" +date: 2024-10-01 +description: Overview of the process of enabling device kselftests on new platforms +--- + +Device kselftests provide a good starting point to validate basic kernel +functionality. There are a few of them upstream, with varying coverage and +requirements. See this documentation page for more information: +https://lore.kernel.org/all/20241001-kselftest-device-docs-v1-1-be28b70dd855@collabora.com + +After deciding which test to run and satisfying its requirement (if any), +enabling the test on a new platform in KernelCI is a matter of adding the +platform to the test's scheduler entry. For example, for the DT kselftest on +ARM64, that would be adding the platform here: + +https://github.com/kernelci/kernelci-pipeline/blob/08e7bce8044d04faa79028273384d9c30a1f5d9e/config/pipeline.yaml#L2495 + +For the other tests, just look for the entry in the ``scheduler`` that has +``collections`` set to the kselftest path as per the upstream documentation (for +example, for the error logs test, look for ``collections: devices/error_logs``). +To enable the test on a different architecture, look for the entry that has the +build corresponding to that architecture, or create it if there's none. See +https://docs.kernelci.org/maestro/pipeline/developer-documentation/#an-example-of-enabling-a-new-job +for more details on enabling tests in KernelCI. + +Note: In addition to the tests described in the upstream documentation, there is +also an alternative to the DT kselftest for ACPI platforms: the ``acpi`` +kselftest. It is not described there as it hasn't been merged upstream, but it +is already being run in KernelCI.