mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style
@ 2023-11-06 15:24 Sean Anderson
  2023-11-06 20:45 ` Randy Dunlap
  2023-11-21  4:45 ` Shubhrajyoti Datta
  0 siblings, 2 replies; 3+ messages in thread
From: Sean Anderson @ 2023-11-06 15:24 UTC (permalink / raw)
  To: Greg Kroah-Hartman, Jiri Slaby, linux-serial
  Cc: linux-kernel, Peter Korsgaard, Sean Anderson, kernel test robot

Use @ and - to conform with kernel-doc style.

Reported-by: kernel test robot <yujie.liu@intel.com>
Signed-off-by: Sean Anderson <sean.anderson@seco.com>
---
I have no idea what phase of release the kernel is in. If it is too
late/early in the cycle, please just review this at the appropriate
time. This patch is unlikely to need rebasing, and I am unlikely to
remember to send it later.

 drivers/tty/serial/uartlite.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/tty/serial/uartlite.c b/drivers/tty/serial/uartlite.c
index 404c14acafa5..e586d7aeac98 100644
--- a/drivers/tty/serial/uartlite.c
+++ b/drivers/tty/serial/uartlite.c
@@ -62,11 +62,11 @@ static struct uart_port *console_port;
 #endif
 
 /**
- * struct uartlite_data: Driver private data
- * reg_ops: Functions to read/write registers
- * clk: Our parent clock, if present
- * baud: The baud rate configured when this device was synthesized
- * cflags: The cflags for parity and data bits
+ * struct uartlite_data - Driver private data
+ * @reg_ops: Functions to read/write registers
+ * @clk: Our parent clock, if present
+ * @baud: The baud rate configured when this device was synthesized
+ * @cflags: The cflags for parity and data bits
  */
 struct uartlite_data {
 	const struct uartlite_reg_ops *reg_ops;
-- 
2.35.1.1320.gc452695387.dirty


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

* Re: [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style
  2023-11-06 15:24 [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style Sean Anderson
@ 2023-11-06 20:45 ` Randy Dunlap
  2023-11-21  4:45 ` Shubhrajyoti Datta
  1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2023-11-06 20:45 UTC (permalink / raw)
  To: Sean Anderson, Greg Kroah-Hartman, Jiri Slaby, linux-serial
  Cc: linux-kernel, Peter Korsgaard, kernel test robot



On 11/6/23 07:24, Sean Anderson wrote:
> Use @ and - to conform with kernel-doc style.
> 
> Reported-by: kernel test robot <yujie.liu@intel.com>
> Signed-off-by: Sean Anderson <sean.anderson@seco.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

Greg will probably just wait to apply it sometime after the current
merge window closes. At least that's been my experience.

> ---
> I have no idea what phase of release the kernel is in. If it is too
> late/early in the cycle, please just review this at the appropriate
> time. This patch is unlikely to need rebasing, and I am unlikely to
> remember to send it later.
> 
>  drivers/tty/serial/uartlite.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/drivers/tty/serial/uartlite.c b/drivers/tty/serial/uartlite.c
> index 404c14acafa5..e586d7aeac98 100644
> --- a/drivers/tty/serial/uartlite.c
> +++ b/drivers/tty/serial/uartlite.c
> @@ -62,11 +62,11 @@ static struct uart_port *console_port;
>  #endif
>  
>  /**
> - * struct uartlite_data: Driver private data
> - * reg_ops: Functions to read/write registers
> - * clk: Our parent clock, if present
> - * baud: The baud rate configured when this device was synthesized
> - * cflags: The cflags for parity and data bits
> + * struct uartlite_data - Driver private data
> + * @reg_ops: Functions to read/write registers
> + * @clk: Our parent clock, if present
> + * @baud: The baud rate configured when this device was synthesized
> + * @cflags: The cflags for parity and data bits
>   */
>  struct uartlite_data {
>  	const struct uartlite_reg_ops *reg_ops;

-- 
~Randy

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

* Re: [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style
  2023-11-06 15:24 [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style Sean Anderson
  2023-11-06 20:45 ` Randy Dunlap
@ 2023-11-21  4:45 ` Shubhrajyoti Datta
  1 sibling, 0 replies; 3+ messages in thread
From: Shubhrajyoti Datta @ 2023-11-21  4:45 UTC (permalink / raw)
  To: Sean Anderson
  Cc: Greg Kroah-Hartman, Jiri Slaby, linux-serial, linux-kernel,
	Peter Korsgaard, kernel test robot

On Mon, Nov 6, 2023 at 8:55 PM Sean Anderson <sean.anderson@seco.com> wrote:
>
> Use @ and - to conform with kernel-doc style.
>
> Reported-by: kernel test robot <yujie.liu@intel.com>
> Signed-off-by: Sean Anderson <sean.anderson@seco.com>

Reviewed-by: Shubhrajyoti Datta <shubhrajyoti.datta@amd.com>

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

end of thread, other threads:[~2023-11-21  4:46 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-11-06 15:24 [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style Sean Anderson
2023-11-06 20:45 ` Randy Dunlap
2023-11-21  4:45 ` Shubhrajyoti Datta

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

all inboxes | Powered by JetHome®