Skip to content

Commit 6aa3d8a

Browse files
nfrapradopatersonc
authored andcommitted
docs: Add page for device tests
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 <[email protected]>
1 parent fa99c16 commit 6aa3d8a

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

kernelci.org/content/en/kernel-community/_index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,6 @@ This section of the documentation shares instructions to:
1414
* [enable specific tests](../maestro/pipeline/developer-documentation/#enabling-a-new-test)
1515
* [visualize the results](view-results)
1616

17+
For suggestions of device tests, see [device kselftests](device-tests).
18+
1719
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 [[email protected]](mailto:[email protected]) with questions and feedback. We are eager to hear from you!
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Device kselftests"
3+
date: 2024-10-01
4+
description: Overview of the process of enabling device kselftests on new platforms
5+
---
6+
7+
Device kselftests provide a good starting point to validate basic kernel
8+
functionality. There are a few of them upstream, with varying coverage and
9+
requirements. See this documentation page for more information:
10+
https://lore.kernel.org/all/[email protected]
11+
12+
After deciding which test to run and satisfying its requirement (if any),
13+
enabling the test on a new platform in KernelCI is a matter of adding the
14+
platform to the test's scheduler entry. For example, for the DT kselftest on
15+
ARM64, that would be adding the platform here:
16+
17+
https://github.com/kernelci/kernelci-pipeline/blob/08e7bce8044d04faa79028273384d9c30a1f5d9e/config/pipeline.yaml#L2495
18+
19+
For the other tests, just look for the entry in the ``scheduler`` that has
20+
``collections`` set to the kselftest path as per the upstream documentation (for
21+
example, for the error logs test, look for ``collections: devices/error_logs``).
22+
To enable the test on a different architecture, look for the entry that has the
23+
build corresponding to that architecture, or create it if there's none. See
24+
https://docs.kernelci.org/maestro/pipeline/developer-documentation/#an-example-of-enabling-a-new-job
25+
for more details on enabling tests in KernelCI.
26+
27+
Note: In addition to the tests described in the upstream documentation, there is
28+
also an alternative to the DT kselftest for ACPI platforms: the ``acpi``
29+
kselftest. It is not described there as it hasn't been merged upstream, but it
30+
is already being run in KernelCI.

0 commit comments

Comments
 (0)