Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Date:   Sun, 8 Mar 2020 22:58:12 +0100
From:   Stephen Kitt <steve@sk2.org>
To:     Matthew Wilcox <willy@infradead.org>
Cc:     Jens Axboe <axboe@kernel.dk>, Jan Kara <jack@suse.cz>,
        linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Document genhd capability flags
Message-ID: <20200308225812.3a24dd7a@heffalump.sk2.org>
In-Reply-To: <20200306172309.GD25710@bombadil.infradead.org>
References: <20200306171621.24134-1-steve@sk2.org>
        <20200306172309.GD25710@bombadil.infradead.org>
MIME-Version: 1.0
Content-Type: multipart/signed; micalg=pgp-sha512;
 boundary="Sig_/cy/n56Tsfr/.sxOIxO6BLlO"; protocol="application/pgp-signature"
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

--Sig_/cy/n56Tsfr/.sxOIxO6BLlO
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

[Re-send, apparently this didn=E2=80=99t make it out of my computer.]

On Fri, 6 Mar 2020 09:23:09 -0800, Matthew Wilcox <willy@infradead.org> wro=
te:
> On Fri, Mar 06, 2020 at 06:16:21PM +0100, Stephen Kitt wrote:
> > The kernel documentation includes a brief section about genhd
> > capabilities, but it turns out that the only documented
> > capability (GENHD_FL_MEDIA_CHANGE_NOTIFY) isn't used any more.
> >=20
> > This patch removes that flag, and documents the rest, based on my
> > understanding of the current uses of these flags in the kernel. The
> > documentation is kept in the header file, alongside the declarations,
> > in the hope that it will be kept up-to-date in future; the kernel
> > documentation is changed to include the documentation generated from
> > the header file.
> >=20
> > Because the ultimate goal is to provide some end-user
> > documentation (or end-administrator documentation), the comments are
> > perhaps more user-oriented than might be expected. =20
>=20
> Thank you!  I have some suggestions for further improvement ...

Thanks for the quick review and the suggestions!

> > -capability is a hex word indicating which capabilities a specific disk
> > -supports.  For more information on bits not listed here, see
> > -include/linux/genhd.h
> > +``capability`` is a hex word indicating which capabilities a specific
> > +disk supports: =20
>=20
> ``capability`` is a bitfield, printed in hexadecimal, indicating ...
>=20
> > + * ``GENHD_FL_UP`` (16): indicates that the block device is "up", with
> > + * a similar meaning to network interfaces. =20
>=20
> Since we're printing it in hex, the value here should be displayed in hex
> to help the end-user.  So ``GENHD_FL_UP`` (0x10), etc.
>=20
> >  #define GENHD_FL_REMOVABLE			1
> > -/* 2 is unused */
> > -#define GENHD_FL_MEDIA_CHANGE_NOTIFY		4
> > +/* 2 is unused (used to be GENHD_FL_DRIVERFS) */
> > +/* 4 is unused (used to be GENHD_FL_MEDIA_CHANGE_NOTIFY) */
> >  #define GENHD_FL_CD				8
> >  #define GENHD_FL_UP				16
> >  #define GENHD_FL_SUPPRESS_PARTITION_INFO	32
> > -#define GENHD_FL_EXT_DEVT			64 /* allow extended
> > devt */ +#define GENHD_FL_EXT_DEVT			64
> >  #define GENHD_FL_NATIVE_CAPACITY		128
> >  #define GENHD_FL_BLOCK_EVENTS_ON_EXCL_WRITE	256
> >  #define GENHD_FL_NO_PART_SCAN			512 =20
>=20
> Maybe these should also be converted to hex to match?

Yes, these are all excellent ideas, I=E2=80=99ll follow up with a v2 (also =
updating
the terminology in capability.rst since this is about block devices, not on=
ly
disks).

Regards,

Stephen

--Sig_/cy/n56Tsfr/.sxOIxO6BLlO
Content-Type: application/pgp-signature
Content-Description: OpenPGP digital signature

-----BEGIN PGP SIGNATURE-----

iQIzBAEBCgAdFiEEnPVX/hPLkMoq7x0ggNMC9Yhtg5wFAl5lanQACgkQgNMC9Yht
g5xuaw/+M+raHBIWe0XUoHlQ35Q3ziAPsnUOP1Vho01HKhV2gpUgwiNObMyx5kcg
VibJ5OODzM80qkkG6ts59xJYhYhu/6CzNGdT3bRi8kR7BypoW5X4HBuAmumTw9r4
go0DOYWwqdDyDqWQE0WrZPIjfTk/R665Q7Opudo/ZymIVgaNj/ksNwX5owoL5HQf
ufiJk52C82wuTJDxPC9UMHAIDXloX27GBvgReWgkRtt7EJ6K/KXxKfOtHy585eJ7
KTr2D0XehuPiGjt1Ad5X4kSlb0k1Llb1+u91MEwcFR6l0G+LvnSfmmD3ImNobGZk
zUv51JZZi2UntjuPMO5s7un1bfSBMlIkCLQTixaSx1kyG2pgYYbkETiCpKTNFkOi
kqG7/7GT7a4qin2y52PxjJRNungbB9ylICZ7Ekm6WfSGmWB5NJQ5g7oAYwMhjgri
8ttPq5NOtqGjOVsSnoBmbPTgTMGR9tQLU3pQC++yZWpMpOqSsn6RTfWtS8UhvAtL
9jNqy3cVqCE6EsYoGCPUGCtENy5YLQC58G7//U++w0CpCaT2mjlhJi/Azq5iDvyt
W3c6IrqGdJ1jz7pwj/g7QqYh6zq8e5iin9ViIUBJM9l2TLGbZ5CW7CnbL+ftt/QK
v0GpWxhAa0qwBFABvO+rNJplGdhEOFxEiXiF3s2gtCDsVuPZv7E=
=Lr7a
-----END PGP SIGNATURE-----

--Sig_/cy/n56Tsfr/.sxOIxO6BLlO--