linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Fabio Fantoni <fantonifabio@tiscali.it>
To: Sergei Shtepa <sergei.shtepa@veeam.com>,
	axboe@kernel.dk, corbet@lwn.net, hch@lst.de
Cc: linux-block@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 03/21] documentation, capability: fix Generic Block Device Capability
Date: Fri, 30 Dec 2022 16:35:49 +0100	[thread overview]
Message-ID: <19375d92-e9a0-ae11-4e3c-f24f032922b4@tiscali.it> (raw)
In-Reply-To: <e42dd6c7-6365-75be-0fcd-3329b8f8ba35@tiscali.it>

Il 13/12/2022 13:13, Fabio Fantoni ha scritto:
> 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@veeam.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

Hi, after a fast look to the git history the "genhd capability flags" 
DOC was changed in commit 430cc5d3ab4d0ba0bd011cfbb0035e46ba92920c 
(block: cleanup the GENHD_FL_* definitions) as part of 
https://lore.kernel.org/all/20211122130625.1136848-1-hch@lst.de/ and 
after that in Documentation/block/capability.rst is not possible 
"decode" /sys/block/<disk>/capability reading it 
(https://www.kernel.org/doc/html/v6.1/block/capability.html) without 
having to read also include/linux/blkdev.h code, or I'm wrong?

is correct readd the hexadecimal value from bitfield?

GENHD_FL_REMOVABLE (0x01): ...

GENHD_FL_HIDDEN (0x02): ...

GENHD_FL_NO_PART (0x04): ...

Thanks for any reply and sorry for my bad english


  reply	other threads:[~2022-12-30 15:36 UTC|newest]

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-09 14:23 [PATCH v2 00/21] blksnap - block devices snapshots module Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 01/21] documentation, blkfilter: Block Device Filtering Mechanism Sergei Shtepa
2022-12-10  4:15   ` Bagas Sanjaya
2022-12-09 14:23 ` [PATCH v2 02/21] block, " Sergei Shtepa
2022-12-15  9:26   ` Christoph Hellwig
2022-12-15 10:46     ` Sergei Shtepa
2022-12-16  7:04       ` Christoph Hellwig
2023-01-31 23:58   ` Mike Snitzer
2023-02-01 11:09     ` Fabio Fantoni
2023-02-01 13:16     ` Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 03/21] documentation, capability: fix Generic Block Device Capability Sergei Shtepa
2022-12-13 12:13   ` Fabio Fantoni
2022-12-30 15:35     ` Fabio Fantoni [this message]
2022-12-09 14:23 ` [PATCH v2 04/21] documentation, blksnap: Block Devices Snapshots Module Sergei Shtepa
2022-12-10  3:50   ` Bagas Sanjaya
2022-12-09 14:23 ` [PATCH v2 05/21] block, blksnap: header file of the module interface Sergei Shtepa
2022-12-09 22:13   ` kernel test robot
2022-12-09 23:14   ` kernel test robot
2022-12-09 14:23 ` [PATCH v2 06/21] block, blksnap: module management interface functions Sergei Shtepa
2022-12-15  9:28   ` Christoph Hellwig
     [not found]   ` <CGME20230103153406eucas1p205c48bd767e6a86f6f1121db7eb5fc19@eucas1p2.samsung.com>
2023-01-03 15:26     ` Pankaj Raghav
2022-12-09 14:23 ` [PATCH v2 07/21] block, blksnap: init() and exit() functions Sergei Shtepa
2022-12-15  9:30   ` Christoph Hellwig
2022-12-09 14:23 ` [PATCH v2 08/21] block, blksnap: interaction with sysfs Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 09/21] block, blksnap: attaching and detaching the filter and handling I/O units Sergei Shtepa
2022-12-15 10:01   ` Christoph Hellwig
2022-12-09 14:23 ` [PATCH v2 10/21] block, blksnap: map of change block tracking Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 11/21] block, blksnap: minimum data storage unit of the original block device Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 12/21] block, blksnap: buffer in memory for the minimum data storage unit Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 13/21] block, blksnap: functions and structures for performing block I/O operations Sergei Shtepa
2022-12-15 10:06   ` Christoph Hellwig
2022-12-09 14:23 ` [PATCH v2 14/21] block, blksnap: storage for storing difference blocks Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 15/21] block, blksnap: event queue from the difference storage Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 16/21] block, blksnap: owner of information about overwritten blocks of the original block device Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 17/21] block, blksnap: snapshot image " Sergei Shtepa
2022-12-15  9:45   ` Christoph Hellwig
2022-12-09 14:23 ` [PATCH v2 18/21] block, blksnap: snapshot Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 19/21] block, blksnap: Kconfig and Makefile Sergei Shtepa
2022-12-09 14:23 ` [PATCH v2 20/21] block, blksnap: adds a blksnap to the kernel tree Sergei Shtepa
2022-12-09 21:53   ` kernel test robot
2022-12-09 14:23 ` [PATCH v2 21/21] block, blksnap: adds a maintainer for new files Sergei Shtepa
2022-12-10  3:23 ` [PATCH v2 00/21] blksnap - block devices snapshots module Bagas Sanjaya
2022-12-10 22:57   ` Sergei Shtepa
     [not found] ` <20230101071813.3329-1-hdanton@sina.com>
2023-01-02  9:44   ` [PATCH v2 17/21] block, blksnap: snapshot image block device Sergei Shtepa
     [not found] ` <20230101110542.3395-1-hdanton@sina.com>
2023-01-02  9:58   ` [PATCH v2 18/21] block, blksnap: snapshot Sergei Shtepa
2023-01-17 21:04 ` [PATCH v2 00/21] blksnap - block devices snapshots module Mike Snitzer
2023-01-18 10:51   ` Hannes Reinecke
2023-01-24 11:34   ` Sergei Shtepa
2023-01-31 20:47     ` Mike Snitzer
2023-02-01  2:32       ` Mason Giles

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=19375d92-e9a0-ae11-4e3c-f24f032922b4@tiscali.it \
    --to=fantonifabio@tiscali.it \
    --cc=axboe@kernel.dk \
    --cc=corbet@lwn.net \
    --cc=hch@lst.de \
    --cc=linux-block@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=sergei.shtepa@veeam.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).