| Message ID | 20221209142331.26395-4-sergei.shtepa@veeam.com |
|---|---|
| State | New |
| Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org>
Delivered-To: ouuuleilei@gmail.com
Received: by 2002:adf:f944:0:0:0:0:0 with SMTP id q4csp827588wrr;
Fri, 9 Dec 2022 07:05:19 -0800 (PST)
X-Google-Smtp-Source:
AA0mqf672uzneXiMcDeeFH1NP9UO6PKeLzWV9btGvhMYrE/32e0bINv5CjPgAJlID4Bb0Vr2pZRC
X-Received: by 2002:a05:6a20:b91c:b0:aa:2852:abea with SMTP id
fe28-20020a056a20b91c00b000aa2852abeamr7404181pzb.37.1670598318994;
Fri, 09 Dec 2022 07:05:18 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1670598318; cv=none;
d=google.com; s=arc-20160816;
b=XwHdoiDqXjiF1xpY7QCKJ/GOAutMDyKYc4zmzKbqkEs/ryR3dYI71autdYIlpou/WD
TEDV9tg1cM6qsWqj3gl0PzymqYqkJDG2bdrZO4j3EY6merjxkHzvUodi9wIp2o/JdDkA
1KVZcdf92l44zcEa9LkFSPM0csVNFS8HHUH8Jpdb2mHbTW9BiELN7mbQmfTwfQVYVYrT
V2eQvhKBredeW8PBVSkXWIWGBsA7k4w3fr5zjcl0usomLlZ+oh5fwyg260OJC9XADNBT
LrFJDCTHFz9Ok4kA/RAjomUkYf3W5cC5QpMHuT018Yuw+1Qiow7MVeXyGhq7/dzoxUe4
wRvQ==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
s=arc-20160816;
h=list-id:precedence:content-transfer-encoding:mime-version
:references:in-reply-to:message-id:date:subject:cc:to:from
:dkim-signature;
bh=ru7ZhzL3gCpkBa2tYBC7LlIYfyyUWNzdAZhrSEsjuA4=;
b=SPSk7kLikG/btoxJ5haPMGY/luMPBOif5XRmEHVlRG6Di1KCMR4P07U103Lw1NPtJZ
L/redbyZvTqYxHZEHEhJ8jLNmGHjMMsni2pFMKHhxqcSPMGBldKPAkdjbk00v/P4dV+o
do1zZuWYbQmh8w05ZxcFMmZz9IuwbSHbseuliLpZxSM7pZruMPrCNHtp69aAlZLHxjPt
JDLI64fV5gFLB9ov6x//7hrx0evwaHj540iLK3+1KjEiA7dSONGYsFZffn8+Ic5JmNxF
dlvgpz0qm89igPQmmLn/x7IH2q4OyHdRsS/yUGy6vt/4gqXipwU63Bm5AVaF/SrE/i3Y
64nA==
ARC-Authentication-Results: i=1; mx.google.com;
dkim=pass header.i=@veeam.com header.s=mx4-2022 header.b=m58LS9zT;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=veeam.com
Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20])
by mx.google.com with ESMTP id
cw15-20020a056a00450f00b00563ab8e5e83si1809556pfb.370.2022.12.09.07.05.03;
Fri, 09 Dec 2022 07:05:18 -0800 (PST)
Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
client-ip=2620:137:e000::1:20;
Authentication-Results: mx.google.com;
dkim=pass header.i=@veeam.com header.s=mx4-2022 header.b=m58LS9zT;
spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org
designates 2620:137:e000::1:20 as permitted sender)
smtp.mailfrom=linux-kernel-owner@vger.kernel.org;
dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=veeam.com
Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand
id S229728AbiLIO7L (ORCPT <rfc822;sophiezhao968@gmail.com>
+ 99 others); Fri, 9 Dec 2022 09:59:11 -0500
Received: from lindbergh.monkeyblade.net ([23.128.96.19]:48814 "EHLO
lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org
with ESMTP id S229488AbiLIO7K (ORCPT
<rfc822;linux-kernel@vger.kernel.org>);
Fri, 9 Dec 2022 09:59:10 -0500
Received: from mx4.veeam.com (mx4.veeam.com [104.41.138.86])
by lindbergh.monkeyblade.net (Postfix) with ESMTPS id CE655302;
Fri, 9 Dec 2022 06:59:08 -0800 (PST)
Received: from mail.veeam.com (prgmbx01.amust.local [172.24.128.102])
(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
(No client certificate requested)
by mx4.veeam.com (Postfix) with ESMTPS id 711E57D47B;
Fri, 9 Dec 2022 17:23:59 +0300 (MSK)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=veeam.com;
s=mx4-2022; t=1670595839;
bh=ru7ZhzL3gCpkBa2tYBC7LlIYfyyUWNzdAZhrSEsjuA4=;
h=From:To:CC:Subject:Date:In-Reply-To:References:From;
b=m58LS9zTxGauhaa8NL92tCBxhjMpRP4/qCHxefFPr3Usv1n8Kw26spAk9Dt+z5k0/
xV7Gjt3r53EQcv3t+hAqzt8wjRWOkb0G1E3oumqA2hsGmTQshdTOleo2pt4ohSW3fe
P50xz33AxSFx0/0xLd4goAO8ywGfTdoJFGB/ZuvuSVKYJnHmtpaMdiQyGOnx/MycQF
xWNMHUmcv8A/O3Iv/HMHZjN/wMqkPOVOwooJW6eN1IuHt2jHKDutm97YYbmJoz5Y/G
PUn4eXsTPzOatGJmpvvmcjrAS/Zp+Eoh3LA6G1YXyGw3R0olD1NxxKBaobq8E6eDIQ
uBKlVZfY/Odpw==
Received: from ssh-deb10-ssd-vb.amust.local (172.24.10.107) by
prgmbx01.amust.local (172.24.128.102) with Microsoft SMTP Server
(version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
15.2.1118.20; Fri, 9 Dec 2022 15:23:56 +0100
From: Sergei Shtepa <sergei.shtepa@veeam.com>
To: <axboe@kernel.dk>, <corbet@lwn.net>
CC: <linux-block@vger.kernel.org>, <linux-doc@vger.kernel.org>,
<linux-kernel@vger.kernel.org>,
Sergei Shtepa <sergei.shtepa@veeam.com>
Subject: [PATCH v2 03/21] documentation,
capability: fix Generic Block Device Capability
Date: Fri, 9 Dec 2022 15:23:13 +0100
Message-ID: <20221209142331.26395-4-sergei.shtepa@veeam.com>
X-Mailer: git-send-email 2.20.1
In-Reply-To: <20221209142331.26395-1-sergei.shtepa@veeam.com>
References: <20221209142331.26395-1-sergei.shtepa@veeam.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Content-Type: text/plain
X-Originating-IP: [172.24.10.107]
X-ClientProxiedBy: prgmbx02.amust.local (172.24.128.103) To
prgmbx01.amust.local (172.24.128.102)
X-EsetResult: clean, is OK
X-EsetId: 37303A2924031556627C62
X-Veeam-MMEX: True
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH,
DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_NONE,
SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6
X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on
lindbergh.monkeyblade.net
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org
X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?=
X-GMAIL-THRID: =?utf-8?q?1751749302816887482?=
X-GMAIL-MSGID: =?utf-8?q?1751749302816887482?=
|
| Series |
blksnap - block devices snapshots module
|
|
Commit Message
Sergei Shtepa
Dec. 9, 2022, 2:23 p.m. UTC
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(+)
Comments
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