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;
Date:   Fri, 4 Mar 2022 12:37:09 -0800
From:   Fenghua Yu <fenghua.yu@intel.com>
To:     Shaopeng Tan <tan.shaopeng@jp.fujitsu.com>
Cc:     Reinette Chatre <reinette.chatre@intel.com>,
        Shuah Khan <shuah@kernel.org>, linux-kernel@vger.kernel.org,
        linux-kselftest@vger.kernel.org
Subject: Re: [PATCH v4 5/6] selftests/resctrl: Update README about using
 kselftest framework to build/run resctrl_tests
Message-ID: <YiJ4YM49fFANO9C2@otcwcpicx3.sc.intel.com>
References: <20220304103834.486892-1-tan.shaopeng@jp.fujitsu.com>
 <20220304103834.486892-6-tan.shaopeng@jp.fujitsu.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <20220304103834.486892-6-tan.shaopeng@jp.fujitsu.com>
Precedence: bulk

On Fri, Mar 04, 2022 at 07:38:33PM +0900, Shaopeng Tan wrote:
> 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.

Please don't use "I" or "we" in commit messages. Also the grammar seems
not right here.

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

Maybe change the commit message to this:

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 | 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
> +-----

The "---" under titles are all same. This cannot tell readers clearly
topic hierarchies.

How about this?
+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
> +---

How about this?
+* RUN
+
> +
> +Run resctrl:
> + $ make -C tools/testing/selftests TARGETS=resctrl run_tests

Run this as sudo or root.
+ $ sudo 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.

resctrl will add more tests in the future. Running time may be longer in
the future. I would suggest to remove the "It takes about 68 seconds..." line.

>  
>  	sudo ./resctrl_tests
>  
> -- 
> 2.27.0
> 

Thanks.

-Fenghua