2
0
mirror of https://github.com/edk2-porting/linux-next.git synced 2024-12-22 20:23:57 +08:00
linux-next/Documentation/block
Stephen Kitt 9243c6f3e0 block: Document genhd capability flags
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.

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.

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. Since the values
are shown to users in hexadecimal, the documentation lists them in
hexadecimal, and the constant declarations are adjusted to match.

Reviewed-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Signed-off-by: Stephen Kitt <steve@sk2.org>
Signed-off-by: Jens Axboe <axboe@kernel.dk>
2020-03-12 07:47:22 -06:00
..
bfq-iosched.rst docs: cgroup-v1: add it to the admin-guide book 2019-07-15 11:03:02 -03:00
biodoc.rst docs conversion for v5.3-rc1 2019-07-16 12:21:41 -07:00
biovecs.rst docs: block/biovecs: update the location of bio.c 2020-01-10 10:23:15 -07:00
capability.rst block: Document genhd capability flags 2020-03-12 07:47:22 -06:00
cmdline-partition.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
data-integrity.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
deadline-iosched.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
index.rst docs: add some documentation dirs to the driver-api book 2019-07-15 11:03:02 -03:00
ioprio.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
kyber-iosched.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
null_blk.rst docs: block: null_blk: enhance document style 2019-09-11 16:04:22 -06:00
pr.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
queue-sysfs.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
request.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00
stat.rst block: add iostat counters for flush requests 2019-11-21 09:06:47 -07:00
switching-sched.rst Documenation: switching-sched: Remove notes about elevator argument 2019-09-03 08:04:02 -06:00
writeback_cache_control.rst docs: block: convert to ReST 2019-07-15 09:20:27 -03:00