Commit 42e2f214 authored by Shaopeng Tan's avatar Shaopeng Tan Committed by Shuah Khan

selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests

resctrl_tests can be built or run using kselftests framework.
Add description on how to do so in README.
Reviewed-by: default avatarReinette Chatre <reinette.chatre@intel.com>
Reviewed-by: default avatarFenghua Yu <fenghua.yu@intel.com>
Signed-off-by: default avatarShaopeng Tan <tan.shaopeng@jp.fujitsu.com>
Signed-off-by: default avatarShuah Khan <skhan@linuxfoundation.org>
parent b733143c
......@@ -12,24 +12,49 @@ Allocation test on Intel RDT hardware. More tests will be added in the future.
And the test suit can be extended to cover AMD QoS and ARM MPAM hardware
as well.
resctrl_tests can be run with or without kselftest framework.
WITH KSELFTEST FRAMEWORK
=======================
BUILD
-----
Run "make" to build executable file "resctrl_tests".
Build executable file "resctrl_tests" from top level directory of the kernel source:
$ make -C tools/testing/selftests TARGETS=resctrl
RUN
---
To use resctrl_tests, root or sudoer privileges are required. This is because
the test needs to mount resctrl file system and change contents in the file
system.
Run resctrl_tests as sudo or root since the test needs to mount resctrl file
system and change contents in the file system.
Using kselftest framework will run all supported tests within resctrl_tests:
$ sudo make -C tools/testing/selftests TARGETS=resctrl run_tests
More details about kselftest framework can be found in
Documentation/dev-tools/kselftest.rst.
WITHOUT KSELFTEST FRAMEWORK
===========================
BUILD
-----
Build executable file "resctrl_tests" from this directory(tools/testing/selftests/resctrl/):
$ make
RUN
---
Run resctrl_tests as sudo or root since the test needs to mount resctrl file
system and change contents in the file system.
Executing the test without any parameter will run all supported tests:
sudo ./resctrl_tests
$ sudo ./resctrl_tests
OVERVIEW OF EXECUTION
---------------------
=====================
A test case has four stages:
......@@ -41,7 +66,7 @@ A test case has four stages:
- teardown: umount resctrl and clear temporary files.
ARGUMENTS
---------
=========
Parameter '-h' shows usage information.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment