linux-kernel - Re: [PATCH -next 2/3] powerpc: Fix kernel-doc comments in fsl

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] [thread-next>] [day] [month] [year] [list]

Message-ID: <adbb10d5-fa43-4d58-9395-0c574e3c3d7e@infradead.org>
Date: Sun, 7 Apr 2024 10:09:03 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Yang Li <yang.lee@...ux.alibaba.com>, arnd@...db.de, mpe@...erman.id.au,
 npiggin@...il.com, christophe.leroy@...roup.eu, aneesh.kumar@...nel.org,
 naveen.n.rao@...ux.ibm.com
Cc: linuxppc-dev@...ts.ozlabs.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH -next 2/3] powerpc: Fix kernel-doc comments in fsl_gtm.c



On 4/6/24 11:39 PM, Yang Li wrote:
> Fix some function names in kernel-doc comments.
> 
> Signed-off-by: Yang Li <yang.lee@...ux.alibaba.com>
> ---
>  arch/powerpc/sysdev/fsl_gtm.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/arch/powerpc/sysdev/fsl_gtm.c b/arch/powerpc/sysdev/fsl_gtm.c
> index 39186ad6b3c3..71e07883eb48 100644
> --- a/arch/powerpc/sysdev/fsl_gtm.c
> +++ b/arch/powerpc/sysdev/fsl_gtm.c
> @@ -77,7 +77,7 @@ struct gtm {
>  static LIST_HEAD(gtms);
>  
>  /**
> - * gtm_get_timer - request GTM timer to use it with the rest of GTM API
> + * gtm_get_timer16 - request GTM timer to use it with the rest of GTM API

ack

>   * Context:	non-IRQ
>   *
>   * This function reserves GTM timer for later use. It returns gtm_timer
> @@ -110,7 +110,7 @@ struct gtm_timer *gtm_get_timer16(void)
>  EXPORT_SYMBOL(gtm_get_timer16);
>  
>  /**
> - * gtm_get_specific_timer - request specific GTM timer
> + * gtm_get_specific_timer16 - request specific GTM timer

ack

>   * @gtm:	specific GTM, pass here GTM's device_node->data
>   * @timer:	specific timer number, Timer1 is 0.
>   * Context:	non-IRQ
> @@ -276,7 +276,7 @@ EXPORT_SYMBOL(gtm_set_timer16);
>   * crop precision of the "usec" argument, thus usec is limited to 16 bits
>   * (single timer width).
>   */
> -int gtm_set_exact_timer16(struct gtm_timer *tmr, u16 usec, bool reload)
> +int gtm_set_exact_utimer16(struct gtm_timer *tmr, u16 usec, bool reload)

No, change the kernel-doc comment instead. Otherwise the caller will fail to link.

>  {
>  	/* quite obvious, frequency which is enough for µSec precision */
>  	const int freq = 1000000;

thanks.
-- 
#Randy