Re: [PATCH v5 5/6] selftests/resctrl: Update README about using kselftest framework to build/run resctrl_tests

[Reinette Chatre <reinette.chatre@intel.com>]

Hi Shaopeng Tan,

On 3/10/2022 11:21 PM, Shaopeng Tan wrote:
> 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 | 43 ++++++++++++++++++++------
>  1 file changed, 34 insertions(+), 9 deletions(-)
> 
> diff --git a/tools/testing/selftests/resctrl/README b/tools/testing/selftests/resctrl/README
> index 3d2bbd4fa3aa..c74b8246e6c9 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.

Saying "with or without kselftest framework" sounds good. Could you please
keep using that instead of the "use" and "not use" in the new headers?

> +
> +USE KSELFTEST FRAMEWORK
> +=======================

So, here it can be "WITH KSELFTEST FRAMEWORK"

> +
> +* BUILD
> +-------

Please remove the "*" to make it consistent with the "BUILD" later in the file.

> +
> +Build executable file "resctrl_tests" at top level directory of the kernel source.
> + $ make -C tools/testing/selftests TARGETS=resctrl

Please use ":" after the sentence that describes a command that follows. For
example, above would read:

Build executable file "resctrl_tests" from top level directory of the kernel source:
 $ make -C tools/testing/selftests TARGETS=resctrl

(also note me changing "at" to "from")

> +
> +* RUN

Please remove the "*" to make it consistent with the "RUN" later in the file.

> +-----
> +
> +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 of resctrl_tests.

"tests of resctrl_tests." -> "tests within resctrl_tests:"?

> +
> + $ sudo make -C tools/testing/selftests TARGETS=resctrl run_tests
> +
> +More details about kselftest framework as follow.
> +Documentation/dev-tools/kselftest.rst

"More details about kselftest framework can be found in Documentation/dev-tools/kselftest.rst."

> +
> +NOT USE KSELFTEST FRAMEWORK
> +===========================

("WITHOUT KSELFTEST FRAMEWORK")

> +
>  BUILD
>  -----
>  
> -Run "make" to build executable file "resctrl_tests".
> +Build executable file "resctrl_tests" at this directory(tools/testing/selftests/resctrl/).

"at this directory" -> "from this directory"

"." -> ":"

> +  $ make
>  
>  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.
> -
> -Executing the test without any parameter will run all supported tests:
> +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.
>  

Reinette