mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Shaopeng Tan <tan.shaopeng@jp.fujitsu.com>
To: Fenghua Yu <fenghua.yu@intel.com>,
	Reinette Chatre <reinette.chatre@intel.com>,
	Shuah Khan <shuah@kernel.org>
Cc: linux-kernel@vger.kernel.org, linux-kselftest@vger.kernel.org,
	tan.shaopeng@jp.fujitsu.com
Subject: [PATCH v6 5/6] selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests
Date: Fri, 18 Mar 2022 16:58:06 +0900	[thread overview]
Message-ID: <20220318075807.2921063-6-tan.shaopeng@jp.fujitsu.com> (raw)
In-Reply-To: <20220318075807.2921063-1-tan.shaopeng@jp.fujitsu.com>

resctrl_tests can be built or run using kselftests framework.
Add description on how to do so in README.

Signed-off-by: Shaopeng Tan <tan.shaopeng@jp.fujitsu.com>
---
 tools/testing/selftests/resctrl/README | 39 +++++++++++++++++++++-----
 1 file changed, 32 insertions(+), 7 deletions(-)

diff --git a/tools/testing/selftests/resctrl/README b/tools/testing/selftests/resctrl/README
index 3d2bbd4fa3aa..58d0cb4e6a16 100644
--- a/tools/testing/selftests/resctrl/README
+++ b/tools/testing/selftests/resctrl/README
@@ -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.
 
-- 
2.27.0


  parent reply	other threads:[~2022-03-18  7:59 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-03-18  7:58 [PATCH v6 0/6] selftests/resctrl: Add resctrl_tests into kselftest set Shaopeng Tan
2022-03-18  7:58 ` [PATCH v6 1/6] selftests/resctrl: Kill child process before parent process terminates if SIGTERM is received Shaopeng Tan
2022-03-18 22:47   ` Fenghua Yu
2022-03-18  7:58 ` [PATCH v6 2/6] selftests/resctrl: Change the default limited time to 120 seconds Shaopeng Tan
2022-03-18 22:48   ` Fenghua Yu
2022-03-18  7:58 ` [PATCH v6 3/6] selftests/resctrl: Fix resctrl_tests' return code to work with selftest framework Shaopeng Tan
2022-03-18 20:58   ` Reinette Chatre
2022-03-18 22:51   ` Fenghua Yu
2022-03-18  7:58 ` [PATCH v6 4/6] selftests/resctrl: Make resctrl_tests run using kselftest framework Shaopeng Tan
2022-03-18 20:59   ` Reinette Chatre
2022-03-18 22:55   ` Fenghua Yu
2022-03-18  7:58 ` Shaopeng Tan [this message]
2022-03-18 20:59   ` [PATCH v6 5/6] selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests Reinette Chatre
2022-03-18 22:57   ` Fenghua Yu
2022-03-18  7:58 ` [PATCH v6 6/6] selftests/resctrl: Add missing SPDX license to Makefile Shaopeng Tan
2022-03-18 21:00   ` Reinette Chatre
2022-03-18 22:58   ` Fenghua Yu
2022-03-18 21:00 ` [PATCH v6 0/6] selftests/resctrl: Add resctrl_tests into kselftest set Reinette Chatre

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=20220318075807.2921063-6-tan.shaopeng@jp.fujitsu.com \
    --to=tan.shaopeng@jp.fujitsu.com \
    --cc=fenghua.yu@intel.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=reinette.chatre@intel.com \
    --cc=shuah@kernel.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

all inboxes | Powered by JetHome®