[PATCH 2/3] rt-tests: Add SPDX identifiers and fix documentation issues
John Kacur <[email protected]> Wed, 17 Jun 2026 16:20:55 -0400
| Newsgroups | org.kernel.vger.linux-rt-users |
|---|---|
| Message-ID | <[email protected]> |
Add SPDX-License-Identifier: GPL-2.0-or-later to the following files that were missing license identifiers: - get_pylib.py - Dockerfile - MAINTAINERS - README-Dockerfile - src/pi_tests/README - src/queuelat/README - src/queuelat/targeted-ipi/README Additionally, fix documentation issues: In README-Dockerfile: - Fix spelling: "imbiguous" → "unambiguous" - Correct project references: "rteval" → "rt-tests" in directory name, container image name, and section heading to accurately reflect that this is rt-tests documentation In src/pi_tests/README: - Fix spelling: "inheritence" → "inheritance" - Fix typo: "one one processor" → "on one processor" - Fix spacing: "fetchthe" → "fetch the" - Fix option: "--duraton" → "--duration" Assisted-by: Claude Sonnet 4.5 <[email protected]> Signed-off-by: John Kacur <[email protected]> --- Dockerfile | 1 + MAINTAINERS | 2 ++ README-Dockerfile | 11 ++++++----- get_pylib.py | 1 + src/pi_tests/README | 10 ++++++---- src/queuelat/README | 3 ++- src/queuelat/targeted-ipi/README | 1 + 7 files changed, 19 insertions(+), 10 deletions(-) diff --git a/Dockerfile b/Dockerfile index 92f680e708d6..b66875277304 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,3 +1,4 @@ +# SPDX-License-Identifier: GPL-2.0-or-later # Use CentOS Stream 9 as base image FROM centos:stream9 diff --git a/MAINTAINERS b/MAINTAINERS index da5ad3a80768..fc69a0f2c4a2 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1,3 +1,5 @@ +SPDX-License-Identifier: GPL-2.0-or-later + Please send your patches to Clark Williams <[email protected]> diff --git a/README-Dockerfile b/README-Dockerfile index fc6ec85feac7..bff3b7dcd958 100644 --- a/README-Dockerfile +++ b/README-Dockerfile @@ -1,8 +1,9 @@ -1 +SPDX-License-Identifier: GPL-2.0-or-later + # README-Dockerfile-rt-tests ## Introduction -This README provides detailed instructions for setting up an rt-tests container using Docker or Podman. This Dockerfile will pull a current copy of your code (plus all of your changes) and compile it into a container image for you to test with. This will give you an imbiguous way to test your changes, assuming you are running on a semi-modern host OS. The rt-tests container can be used to test any of the subpackages found under the rt-tests project, but is mainly intended for hwlatdetect and cyclictest. +This README provides detailed instructions for setting up an rt-tests container using Docker or Podman. This Dockerfile will pull a current copy of your code (plus all of your changes) and compile it into a container image for you to test with. This will give you an unambiguous way to test your changes, assuming you are running on a semi-modern host OS. The rt-tests container can be used to test any of the subpackages found under the rt-tests project, but is mainly intended for hwlatdetect and cyclictest. ## Prerequisites - Docker or Podman installed on your system. @@ -16,8 +17,8 @@ This README provides detailed instructions for setting up an rt-tests container - Alternatively, install Podman: `sudo apt-get update && sudo apt-get install podman -y` ### Build the Container -- Navigate to the root directory of the 'rteval' -- Build the container image named 'rteval-upstream': +- Navigate to the root directory of 'rt-tests' +- Build the container image named 'rt-tests-upstream': - For Podman: `sudo podman build -t rt-tests-upstream .` - For Docker: `sudo docker build -t rt-tests-upstream .` @@ -40,7 +41,7 @@ This README provides detailed instructions for setting up an rt-tests container - For Podman: `sudo podman run -it --rm --privileged rt-tests-upstream` - For Docker: `sudo docker run -it --rm --privileged rt-tests-upstream` -### Test rteval Build +### Test rt-tests Build - Inside the container, test one of the rt-tests packages you just built: - Command: `cyclictest -D 1s` - Command: `hwlatdetect --duration 1` diff --git a/get_pylib.py b/get_pylib.py index 56253d589fe4..5ecf6e23475b 100755 --- a/get_pylib.py +++ b/get_pylib.py @@ -1,4 +1,5 @@ #!/usr/bin/python3 +# SPDX-License-Identifier: GPL-2.0-or-later # This file is used during the make process diff --git a/src/pi_tests/README b/src/pi_tests/README index 6b2850d6b970..3313355f06f9 100644 --- a/src/pi_tests/README +++ b/src/pi_tests/README @@ -1,3 +1,5 @@ +SPDX-License-Identifier: GPL-2.0-or-later + DESCRIPTION The pi_stress program is a stress test that is intended to exercise @@ -22,20 +24,20 @@ The threads run through a state machine designed to guarantee that a low-priority thread holds a mutex while a medium priority thread runs (keeping the low-priority thread from releasing the mutex). The high-priority thread attempts to acquire the mutex and is blocked -because of the low-priority thread holding it. If priority inheritence +because of the low-priority thread holding it. If priority inheritance is working, the low-priority thread will receive a priority boost (will inherit the high-priority thread's priority) and will then run and release the mutex, averting a deadlock. On a multi-processor system, the admin and reporter threads are run -one one processor while the inversion groups are run on another +on one processor while the inversion groups are run on another processor. STEPS TO RUN Install the pi_tests rpm. If you are running Fedora Core, the simplest -way do to that is to fetchthe rt-userspace.repo file from: +way do to that is to fetch the rt-userspace.repo file from: http://people.redhat.com/~williams/rt-userspace.repo @@ -74,7 +76,7 @@ that have been performed. To stop the test, press any key and a summary will be printed to show how many inversions were performed and how long the test ran. -To run the test for a specifed time, use the --duraton=<seconds> +To run the test for a specifed time, use the --duration=<seconds> option. diff --git a/src/queuelat/README b/src/queuelat/README index 4ffdb3753bbd..10c7fbb9eea9 100644 --- a/src/queuelat/README +++ b/src/queuelat/README @@ -1,5 +1,6 @@ +SPDX-License-Identifier: GPL-2.0-or-later -cyclictest does not catch all cases where packet forwarding +cyclictest does not catch all cases where packet forwarding latency can exceed a given threshold. Example: diff --git a/src/queuelat/targeted-ipi/README b/src/queuelat/targeted-ipi/README index f36711c239b4..15dc2acb8418 100644 --- a/src/queuelat/targeted-ipi/README +++ b/src/queuelat/targeted-ipi/README @@ -1,3 +1,4 @@ +SPDX-License-Identifier: GPL-2.0-or-later To build: -- 2.54.0