linux-kernel - [PATCH 0/3] ttp_port: Clean up kernel-docs

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: <20180912075044.8695-1-me@tobin.cc>
Date:   Wed, 12 Sep 2018 17:50:41 +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 0/3] ttp_port: Clean up kernel-docs

Hi,

This set is just putting a toe in the water to see if kernel-docs
cleanup is wanted in drivers/tty/

While chasing syzkaller bugs I opened up drivers/tty/tty_port.c and
noticed that a bunch of the kernel-docs function comments were
incorrectly styled.  This is the case for more files under drivers/tty/,
if fixing this is deemed worthwhile I can add it to my list of jobs to
do when my brain is too fried to do anything else.

Changes comments that look like this:

/**
 *	ptmx_open		-	open a unix 98 pty master
 *	@inode: inode of device file
 *	@filp: file pointer to tty
 *
 *	Allocate a unix98 pty master device from the ptmx driver.
 *
 *	Locking: tty_mutex protects the init_dev work. tty->count should
 *		protect the rest.
 *		allocated_ptys_lock handles the list of free pty numbers
 */

static int ptmx_open(struct inode *inode, struct file *filp)

To look like this:

/**
 * ptmx_open() - Open a unix 98 pty master.
 * @inode: inode of device file
 * @filp: file pointer to tty
 *
 * Allocate a unix98 pty master device from the ptmx driver.
 *
 * Locking: tty_mutex protects the init_dev work. tty->count should
 * 	protect the rest.
 * 	allocated_ptys_lock handles the list of free pty numbers
 */
static int ptmx_open(struct inode *inode, struct file *filp)

This is super trivial clean up - I will not be offended if this is
deemed code churn.

thanks,
Tobin.

Tobin C. Harding (3):
  tty_port: Remove incorrect whitespace after comments
  tty_port: Fix function name and brief desc
  tty_port: Fix kernel-docs warnings

 drivers/tty/tty_port.c | 133 ++++++++++++++++++++---------------------
 1 file changed, 65 insertions(+), 68 deletions(-)

-- 
2.17.1