linux-kernel - Re: [PATCH v4 2/2] smp: Fix kernel-doc related mistakes

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <2bd4c519-1f96-583b-0b05-4091a171db4a@infradead.org>
Date:   Fri, 17 Dec 2021 21:52:25 -0800
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Zhen Lei <thunder.leizhen@...wei.com>,
        Ingo Molnar <mingo@...nel.org>,
        Peter Zijlstra <peterz@...radead.org>,
        linux-kernel@...r.kernel.org
Cc:     Nadav Amit <namit@...are.com>,
        Dave Hansen <dave.hansen@...ux.intel.com>
Subject: Re: [PATCH v4 2/2] smp: Fix kernel-doc related mistakes



On 12/16/21 06:40, Zhen Lei wrote:
> 1. Change "function-name:" to "function-name -".
> 2. The kernel-doc comments should start with "/**".
> 3. Add descriptions for the missing parameters.
> 4. Fix a mismatched function name in the comment.
> 
> Signed-off-by: Zhen Lei <thunder.leizhen@...wei.com>

Acked-by: Randy Dunlap <rdunlap@...radead.org>

thanks.


> ---
>  kernel/smp.c | 12 +++++++-----
>  1 file changed, 7 insertions(+), 5 deletions(-)
> 
> diff --git a/kernel/smp.c b/kernel/smp.c
> index 1e5221fe200296a..d00cc8e0e5d8b16 100644
> --- a/kernel/smp.c
> +++ b/kernel/smp.c
> @@ -698,8 +698,9 @@ void flush_smp_call_function_from_idle(void)
>  	local_irq_restore(flags);
>  }
>  
> -/*
> +/**
>   * smp_call_function_single - Run a function on a specific CPU
> + * @cpu:  The CPU to run on.
>   * @func: The function to run. This must be fast and non-blocking.
>   * @info: An arbitrary pointer to pass to the function.
>   * @wait: If true, wait until function has completed on other CPUs.
> @@ -809,7 +810,7 @@ int smp_call_function_single_async(int cpu, struct __call_single_data *csd)
>  }
>  EXPORT_SYMBOL_GPL(smp_call_function_single_async);
>  
> -/*
> +/**
>   * smp_call_function_any - Run a function on any of the given cpus
>   * @mask: The mask of cpus it can run on.
>   * @func: The function to run. This must be fast and non-blocking.
> @@ -1005,7 +1006,7 @@ void smp_call_function_many(const struct cpumask *mask,
>  EXPORT_SYMBOL(smp_call_function_many);
>  
>  /**
> - * smp_call_function(): Run a function on all other CPUs.
> + * smp_call_function() - Run a function on all other CPUs.
>   * @func: The function to run. This must be fast and non-blocking.
>   * @info: An arbitrary pointer to pass to the function.
>   * @wait: If true, wait (atomically) until function has completed
> @@ -1111,8 +1112,8 @@ void __init smp_init(void)
>  	smp_cpus_done(setup_max_cpus);
>  }
>  
> -/*
> - * on_each_cpu_cond(): Call a function on each processor for which
> +/**
> + * on_each_cpu_cond_mask() - Call a function on each processor for which
>   * the supplied function cond_func returns true, optionally waiting
>   * for all the required CPUs to finish. This may include the local
>   * processor.
> @@ -1126,6 +1127,7 @@ void __init smp_init(void)
>   * @info:	An arbitrary pointer to pass to both functions.
>   * @wait:	If true, wait (atomically) until function has
>   *		completed on other CPUs.
> + * @mask:	The set of cpus to run on (only runs on online subset).
>   *
>   * Preemption is disabled to protect against CPUs going offline but not online.
>   * CPUs going online during the call will not be seen or sent an IPI.

-- 
~Randy