linux-kernel - Re: [PATCH v2 03/21] documentation, capability: fix Generic Block Device Capability

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: <e42dd6c7-6365-75be-0fcd-3329b8f8ba35@tiscali.it>
Date:   Tue, 13 Dec 2022 13:13:45 +0100
From:   Fabio Fantoni <fantonifabio@...cali.it>
To:     Sergei Shtepa <sergei.shtepa@...am.com>, axboe@...nel.dk,
        corbet@....net
Cc:     linux-block@...r.kernel.org, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 03/21] documentation, capability: fix Generic Block
 Device Capability

Il 09/12/2022 15:23, Sergei Shtepa ha scritto:
> When adding documentation for blkfilter, new lines of documentation
> appeared in the file include/linux/blkdev.h. To preserve the appearance
> of this document, the required sections and function descriptions were
> explicitly specified.
>
> Signed-off-by: Sergei Shtepa <sergei.shtepa@...am.com>
> ---
>   Documentation/block/capability.rst | 3 +++
>   1 file changed, 3 insertions(+)
>
> diff --git a/Documentation/block/capability.rst b/Documentation/block/capability.rst
> index 2ae7f064736a..8fad791980bb 100644
> --- a/Documentation/block/capability.rst
> +++ b/Documentation/block/capability.rst
> @@ -8,3 +8,6 @@ This file documents the sysfs file ``block/<disk>/capability``.
>   capabilities a specific block device supports:
>   
>   .. kernel-doc:: include/linux/blkdev.h
> +	:DOC: genhd capability flags
> +.. kernel-doc:: include/linux/blkdev.h
> +	:functions: disk_openers blk_alloc_disk bio_end_io_acct
Thanks for spotting this, I think this is not related to blkfilter patch 
but was already wrong/broken before and should be posted in a single 
patch out of the blksnap serie (also fixing title, as reported by Bagas 
Sanjaya, like "documentation: fix Generic Block Device Capability")

from a fast look seems to me should have only:

+    :DOC: genhd capability flags

and out of that looking older version of doc 
(https://www.kernel.org/doc/html/v5.10/block/capability.html) seems to 
me that this DOC in blkdev.h need improvement as it seems to me it was 
better in the past, for example also reporting the corresponding 
hexadecimal value in parentheses