linux-kernel - [PATCH 3/3] tty_port: Fix kernel-docs warnings

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: <20180912075044.8695-4-me@tobin.cc>
Date:   Wed, 12 Sep 2018 17:50:44 +1000
From:   "Tobin C. Harding" <me@...in.cc>
To:     Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jiri Slaby <jslaby@...e.com>
Cc:     "Tobin C. Harding" <me@...in.cc>, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org
Subject: [PATCH 3/3] tty_port: Fix kernel-docs warnings

Currently extracting the kernel-docs causes a six warnings of type

  warning: Function parameter or member 'foo' not described in 'bar'

Add function parameter descriptions to the function kernel-docs.

Signed-off-by: Tobin C. Harding <me@...in.cc>
---
 drivers/tty/tty_port.c | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/drivers/tty/tty_port.c b/drivers/tty/tty_port.c
index 382282013c9d..2444ed90b93d 100644
--- a/drivers/tty/tty_port.c
+++ b/drivers/tty/tty_port.c
@@ -622,6 +622,9 @@ EXPORT_SYMBOL(tty_port_close_end);
 
 /**
  * tty_port_close()
+ * @port: tty port
+ * @tty: the tty
+ * @filp: the file pointer
  *
  * Caller holds tty lock
  */
@@ -657,6 +660,9 @@ EXPORT_SYMBOL_GPL(tty_port_install);
 
 /**
  * tty_port_open()
+ * @port: tty port
+ * @tty: the tty
+ * @filp: the file pointer
  *
  * Caller holds tty lock.
  *
-- 
2.17.1