public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
* [PATCH v2] mfd: idt8a340_reg: Start comments with '/*'
@ 2024-05-07 16:53 Simon Horman
  2024-05-31 10:47 ` (subset) " Lee Jones
  0 siblings, 1 reply; 2+ messages in thread
From: Simon Horman @ 2024-05-07 16:53 UTC (permalink / raw)
  To: Lee Jones; +Cc: linux-kernel

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

Resolve this conflict by starting these comments with '/*' instead.

Flagged by ./scripts/kernel-doc -none

Signed-off-by: Simon Horman <horms@kernel.org>
---
Changes in v2:
- As suggested by Lee Jones
  + Update patch prefix to "mfd: idt8a340_reg:"
  + Update line-wrapping in patch description
- Link to v1: https://lore.kernel.org/r/20240504-clockmatrix-kernel-doc-v1-1-acb07a33bb17@kernel.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.
  *


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: (subset) [PATCH v2] mfd: idt8a340_reg: Start comments with '/*'
  2024-05-07 16:53 [PATCH v2] mfd: idt8a340_reg: Start comments with '/*' Simon Horman
@ 2024-05-31 10:47 ` Lee Jones
  0 siblings, 0 replies; 2+ messages in thread
From: Lee Jones @ 2024-05-31 10:47 UTC (permalink / raw)
  To: Lee Jones, Simon Horman; +Cc: linux-kernel

On Tue, 07 May 2024 17:53:56 +0100, 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.
> 
> Resolve this conflict by starting these comments with '/*' instead.
> 
> Flagged by ./scripts/kernel-doc -none
> 
> [...]

Applied, thanks!

[1/1] mfd: idt8a340_reg: Start comments with '/*'
      commit: 1b9e05aaeeef7021b14a332c7132094a73180c34

--
Lee Jones [李琼斯]


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2024-05-31 10:47 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-05-07 16:53 [PATCH v2] mfd: idt8a340_reg: Start comments with '/*' Simon Horman
2024-05-31 10:47 ` (subset) " Lee Jones

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox