| Message ID | 20221209142331.26395-4-sergei.shtepa@veeam.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | blksnap - block devices snapshots module | expand |
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
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
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
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(+)