linux-kernel - Re: [PATCH] ptp: clockmatrix: Start comments with '/*'

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: <20240507084336.GX1227636@google.com>
Date: Tue, 7 May 2024 09:43:36 +0100
From: Lee Jones <lee@...nel.org>
To: Simon Horman <horms@...nel.org>
Cc: Richard Cochran <richardcochran@...il.com>,
	linux-kernel@...r.kernel.org, netdev@...r.kernel.org
Subject: Re: [PATCH] ptp: clockmatrix: Start comments with '/*'

Subject line should start with:

  "mfd: idt8a340_reg: "

On Sat, 04 May 2024, Simon Horman wrote:

> Several comments in idt8a340_reg.h start with '/**',
> which denotes the start of a Kernel doc,
> but are otherwise not Kernel docs.

Some very odd line breaking here.

> Resolve this conflict by starting these comments with '/*' instead.
> 
> Flagged by ./scripts/kernel-doc -none
> 
> Signed-off-by: Simon Horman <horms@...nel.org>
> ---
>  include/linux/mfd/idt8a340_reg.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/include/linux/mfd/idt8a340_reg.h b/include/linux/mfd/idt8a340_reg.h
> index 0c706085c205..53a222605526 100644
> --- a/include/linux/mfd/idt8a340_reg.h
> +++ b/include/linux/mfd/idt8a340_reg.h
> @@ -61,7 +61,7 @@
>  #define HW_Q8_CTRL_SPARE  (0xa7d4)
>  #define HW_Q11_CTRL_SPARE (0xa7ec)
>  
> -/**
> +/*
>   * Select FOD5 as sync_trigger for Q8 divider.
>   * Transition from logic zero to one
>   * sets trigger to sync Q8 divider.
> @@ -70,7 +70,7 @@
>   */
>  #define Q9_TO_Q8_SYNC_TRIG  BIT(1)
>  
> -/**
> +/*
>   * Enable FOD5 as driver for clock and sync for Q8 divider.
>   * Enable fanout buffer for FOD5.
>   *
> @@ -78,7 +78,7 @@
>   */
>  #define Q9_TO_Q8_FANOUT_AND_CLOCK_SYNC_ENABLE_MASK  (BIT(0) | BIT(2))
>  
> -/**
> +/*
>   * Select FOD6 as sync_trigger for Q11 divider.
>   * Transition from logic zero to one
>   * sets trigger to sync Q11 divider.
> @@ -87,7 +87,7 @@
>   */
>  #define Q10_TO_Q11_SYNC_TRIG  BIT(1)
>  
> -/**
> +/*
>   * Enable FOD6 as driver for clock and sync for Q11 divider.
>   * Enable fanout buffer for FOD6.
>   *
> 

-- 
Lee Jones [李琼斯]