[v2,9/9] selftests/resctrl: Correct get_llc_perf() param in function comment

Message ID 20230215130605.31583-10-ilpo.jarvinen@linux.intel.com
State New
Headers
Series selftests/resctrl: Fixes to error handling logic and cleanups |

Commit Message

Ilpo Järvinen Feb. 15, 2023, 1:06 p.m. UTC
  get_llc_perf() function comment refers to cpu_no parameter that does
not exist.

Correct get_llc_perf() the comment to document llc_perf_miss instead.

Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
---
 tools/testing/selftests/resctrl/cache.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Reinette Chatre March 16, 2023, 12:04 a.m. UTC | #1
Hi Ilpo,

On 2/15/2023 5:06 AM, Ilpo Järvinen wrote:
> get_llc_perf() function comment refers to cpu_no parameter that does
> not exist.
> 
> Correct get_llc_perf() the comment to document llc_perf_miss instead.

"Correct the get_llc_perf() comment"? This is so minor and I do not think
a reason to resubmit whole series.

> 
> Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
> ---

Thank you

Reviewed-by: Reinette Chatre <reinette.chatre@intel.com>

Reinette
  
Ilpo Järvinen March 16, 2023, 10:21 a.m. UTC | #2
On Wed, 15 Mar 2023, Reinette Chatre wrote:

> Hi Ilpo,
> 
> On 2/15/2023 5:06 AM, Ilpo Järvinen wrote:
> > get_llc_perf() function comment refers to cpu_no parameter that does
> > not exist.
> > 
> > Correct get_llc_perf() the comment to document llc_perf_miss instead.
> 
> "Correct the get_llc_perf() comment"?

Yes. No matter how many times I read my own changelogs through, my mind 
goes to auto-correction mode and I often fail to spot obvious errors such 
as this.

Thanks for reviewing.
  

Patch

diff --git a/tools/testing/selftests/resctrl/cache.c b/tools/testing/selftests/resctrl/cache.c
index 585186c874dc..8a4fe8693be6 100644
--- a/tools/testing/selftests/resctrl/cache.c
+++ b/tools/testing/selftests/resctrl/cache.c
@@ -77,7 +77,7 @@  static int reset_enable_llc_perf(pid_t pid, int cpu_no)
 
 /*
  * get_llc_perf:	llc cache miss through perf events
- * @cpu_no:		CPU number that the benchmark PID is binded to
+ * @llc_perf_miss:	LLC miss counter that is filled on success
  *
  * Perf events like HW_CACHE_MISSES could be used to validate number of
  * cache lines allocated.