Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
IronPort-SDR: 4JRLpRH0MTmQaM76LzZ93iR5poDRcfLHQbVY8aFCw6bEhjDY2G5A6dcTHW5UutfqH90PftWJQv
 pd3wZrvouXQLBK8nGp0UuHf8OqjeCqhHUnk3ywdZAWSSRI95p9KGP3CLf04WqK+ddP2pOOW2bO
 c3EXm6P+2X2y3HI7zuSWwFVIyRjIedHsHWmUyahF2RqvcoARUhWEU+5eauKBm+yoAyCFxv435k
 GdYbpdSbbLzQZQCq11Bz4DQLNmNjh+Ac95p4gQHt11vmhE+HCeYztLv5xeLbEIgW6d2LdwFCCC
 g9Xn+FnX1NykpL0JQtOTAYRg
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 v4 5/6] selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests
Date:   Fri,  4 Mar 2022 19:38:33 +0900
Message-Id: <20220304103834.486892-6-tan.shaopeng@jp.fujitsu.com>
In-Reply-To: <20220304103834.486892-1-tan.shaopeng@jp.fujitsu.com>
References: <20220304103834.486892-1-tan.shaopeng@jp.fujitsu.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

In this patch series, I make restrl_tests build/run using kselftest
framework, but some users do not known how to build/run resctrl_tests
using kseltest framework.

Add manual of how to make resctrl_tests build/run
using kselftest framework into README.

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

diff --git a/tools/testing/selftests/resctrl/README b/tools/testing/selftests/resctrl/README
index 3d2bbd4fa3aa..268cf3f95bd5 100644
--- a/tools/testing/selftests/resctrl/README
+++ b/tools/testing/selftests/resctrl/README
@@ -12,9 +12,37 @@ 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.
+
+USE KSELFTEST FRAMEWORK
+-----------------------
+
+BUILD
+-----
+
+Execute the following command in top level directory of the kernel source.
+
+Build resctrl:
+ $ make -C tools/testing/selftests TARGETS=resctrl
+
+RUN
+---
+
+Run resctrl:
+ $ make -C tools/testing/selftests TARGETS=resctrl run_tests
+
+Using kselftest framework, the ./resctrl_tests will be run without any parameters.
+
+More details about kselftest framework as follow.
+Documentation/dev-tools/kselftest.rst
+
+NOT USE KSELFTEST FRAMEWORK
+---------------------------
+
 BUILD
 -----
 
+Execute the following command in this directory(tools/testing/selftests/resctrl/).
 Run "make" to build executable file "resctrl_tests".
 
 RUN
@@ -24,7 +52,8 @@ 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.
 
-Executing the test without any parameter will run all supported tests:
+Executing the test without any parameter will run all supported tests.
+It takes about 68 seconds on a Intel(R) Xeon(R) Gold 6254 CPU @ 3.10GHz.
 
 	sudo ./resctrl_tests
 
-- 
2.27.0