cpu/SMT: Fix cpu_smt_possible() comment

Message ID 20230710032121.8341-1-rui.zhang@intel.com
State New
Headers
Series cpu/SMT: Fix cpu_smt_possible() comment |

Commit Message

Zhang, Rui July 10, 2023, 3:21 a.m. UTC
  The comment of cpu_smt_possible() is not aligned with the changelog of
commit e1572f1d08be ("cpu/SMT: create and export cpu_smt_possible()"),
and it is wrong.

Fix cpu_smt_possible() comment.

Signed-off-by: Zhang Rui <rui.zhang@intel.com>
---
 kernel/cpu.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Vitaly Kuznetsov July 10, 2023, 7:36 a.m. UTC | #1
Zhang Rui <rui.zhang@intel.com> writes:

> The comment of cpu_smt_possible() is not aligned with the changelog of
> commit e1572f1d08be ("cpu/SMT: create and export cpu_smt_possible()"),
> and it is wrong.
>
> Fix cpu_smt_possible() comment.
>
> Signed-off-by: Zhang Rui <rui.zhang@intel.com>
> ---
>  kernel/cpu.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/kernel/cpu.c b/kernel/cpu.c
> index 7e8f1b044772..f6811c857102 100644
> --- a/kernel/cpu.c
> +++ b/kernel/cpu.c
> @@ -676,7 +676,7 @@ static inline bool cpu_smt_allowed(unsigned int cpu)
>  	return !cpumask_test_cpu(cpu, &cpus_booted_once_mask);
>  }
>  
> -/* Returns true if SMT is not supported of forcefully (irreversibly) disabled */
> +/* Returns true if SMT is supported and not forcefully (irreversibly) disabled */
>  bool cpu_smt_possible(void)
>  {
>  	return cpu_smt_control != CPU_SMT_FORCE_DISABLED &&

The function must've had a different name in an earlier version of the
patch...

Thanks for catching this!

Reviewed-by: Vitaly Kuznetsov <vkuznets@redhat.com>
  
Thomas Gleixner July 28, 2023, 7:34 a.m. UTC | #2
On Mon, Jul 10 2023 at 11:21, Zhang Rui wrote:
> The comment of cpu_smt_possible() is not aligned with the changelog of
> commit e1572f1d08be ("cpu/SMT: create and export cpu_smt_possible()"),
> and it is wrong.

Why? Do I need to go and read that commit log and figure out what's wrong?

> Fix cpu_smt_possible() comment.

Zero information.
  
Zhang, Rui July 28, 2023, 3:57 p.m. UTC | #3
Hi, Thomas,

On Fri, 2023-07-28 at 09:34 +0200, Thomas Gleixner wrote:
> On Mon, Jul 10 2023 at 11:21, Zhang Rui wrote:
> > The comment of cpu_smt_possible() is not aligned with the changelog
> > of
> > commit e1572f1d08be ("cpu/SMT: create and export
> > cpu_smt_possible()"),
> > and it is wrong.
> 
> Why? Do I need to go and read that commit log and figure out what's
> wrong?
> 
> > Fix cpu_smt_possible() comment.
> 
> Zero information.
> 
Thanks for reviewing. Sent patch V2 with changelog rephrased.

thanks,
rui
  

Patch

diff --git a/kernel/cpu.c b/kernel/cpu.c
index 7e8f1b044772..f6811c857102 100644
--- a/kernel/cpu.c
+++ b/kernel/cpu.c
@@ -676,7 +676,7 @@  static inline bool cpu_smt_allowed(unsigned int cpu)
 	return !cpumask_test_cpu(cpu, &cpus_booted_once_mask);
 }
 
-/* Returns true if SMT is not supported of forcefully (irreversibly) disabled */
+/* Returns true if SMT is supported and not forcefully (irreversibly) disabled */
 bool cpu_smt_possible(void)
 {
 	return cpu_smt_control != CPU_SMT_FORCE_DISABLED &&