linux-kernel - [PATCH] Documentation: fixes a documentation warning in serial

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

Message-Id: <20220828062917.182879-1-wdnuka@gmail.com>
Date:   Sun, 28 Aug 2022 11:59:17 +0530
From:   Dhanuka Warusadura <wdnuka@...il.com>
To:     gregkh@...uxfoundation.org, jirislaby@...nel.org, shuah@...nel.org,
        linux-kernel@...r.kernel.org
Cc:     Dhanuka Warusadura <wdnuka@...il.com>
Subject: [PATCH] Documentation: fixes a documentation warning in serial_core.h

These changes fix the documentation warning: Function parameter
or member 'start_rx' not described in 'uart_ops'

Signed-off-by: Dhanuka Warusadura <wdnuka@...il.com>
---
 include/linux/serial_core.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/include/linux/serial_core.h b/include/linux/serial_core.h
index aef3145f2032..44a7b4746f36 100644
--- a/include/linux/serial_core.h
+++ b/include/linux/serial_core.h
@@ -149,6 +149,14 @@ struct gpio_desc;
  *	Interrupts: locally disabled.
  *	This call must not sleep
  *
+ * @start_rx: ``void () (struct uart_port *)``
+ *
+ * Start receiving characters; the @port is in the process of being opened.
+ *
+ * Locking: @port->lock taken.
+ * Interrupts: locally disabled.
+ * This call must not sleep
+ *
  * @enable_ms: ``void ()(struct uart_port *port)``
  *
  *	Enable the modem status interrupts.
-- 
2.37.2