linux-kernel - [PATCH] tty: serial: uartlite: Document uartlite

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

Message-Id: <20231106152428.3641883-1-sean.anderson@seco.com>
Date:   Mon,  6 Nov 2023 10:24:28 -0500
From:   Sean Anderson <sean.anderson@...o.com>
To:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jiri Slaby <jirislaby@...nel.org>, linux-serial@...r.kernel.org
Cc:     linux-kernel@...r.kernel.org, Peter Korsgaard <jacmet@...site.dk>,
        Sean Anderson <sean.anderson@...o.com>,
        kernel test robot <yujie.liu@...el.com>
Subject: [PATCH] tty: serial: uartlite: Document uartlite_data in kernel-doc style

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

Reported-by: kernel test robot <yujie.liu@...el.com>
Signed-off-by: Sean Anderson <sean.anderson@...o.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