linux-ext4 - Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter descriptions

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

Message-ID: <20170717091233.GA18199@quack2.suse.cz>
Date:   Mon, 17 Jul 2017 11:12:33 +0200
From:   Jan Kara <jack@...e.cz>
To:     sayli karnik <karniksayli1995@...il.com>
Cc:     linux-ext4@...r.kernel.org, Theodore Ts'o <tytso@....edu>,
        Jan Kara <jack@...e.com>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] fs: jbd2: transaction: Add kernel-doc parameter
 descriptions

On Mon 26-06-17 10:20:22, sayli karnik wrote:
> Add function parameters in kernel-doc comments to fix warnings in the
> Sphinx build:
> transaction.c:511: warning: No description found for parameter 'type'
> transaction.c:511: warning: No description found for parameter 'line_no'
> 
> Signed-off-by: sayli karnik <karniksayli1995@...il.com>

I'd suggest to have more useful description like below:

> + * @type: type of handle

the reason why transaction handle was started - one of EXT4_TH_ defines

> + * @line_no: line number of handle

the line from which the function was called (used for debug output)

									Honza
-- 
Jan Kara <jack@...e.com>
SUSE Labs, CR