linux-toradex.git/Documentation/block/index.rst, branch v6.7-rc8

Documentation/block: drop the request.rst file

2023-05-12T17:04:58+00:00

Documentation/block/request.rst is outdated and should be removed.
Also delete its entry in the block/index.rst file.

Signed-off-by: Randy Dunlap 
Cc: Jens Axboe 
Cc: linux-block@vger.kernel.org
Cc: Jonathan Corbet 
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/r/20230507182606.12647-1-rdunlap@infradead.org
Signed-off-by: Jens Axboe

block: stub out and deprecated the capability attribute on the gendisk

2023-02-06T15:44:55+00:00

The capability attribute was added in 2017 to expose the kernel internal
GENHD_FL_MEDIA_CHANGE_NOTIFY to userspace without ever adding a value to
an UAPI header, and without ever setting it in any driver until it was
finally removed in Linux 5.7.

Deprecate the file and always return 0 instead of exposing the other
internal and frequently renumbered other gendisk flags.

Signed-off-by: Christoph Hellwig 
Reviewed-by: Chaitanya Kulkarni 
Reviewed-by: Bart Van Assche 
Link: https://lore.kernel.org/r/20230203150209.3199115-1-hch@lst.de
Signed-off-by: Jens Axboe

Documentation: document ublk

2022-09-02T15:31:15+00:00

Add documentation for ublk subsystem. It was supposed to be documented when
merging the driver, but missing at that time.

Cc: Bagas Sanjaya 
Cc: Jonathan Corbet 
Cc: Richard W.M. Jones 
Cc: Xiaoguang Wang 
Reviewed-by: Stefan Hajnoczi 
Reviewed-by: ZiyangZhang 
Signed-off-by: Ming Lei 
[axboe: correct MAINTAINERS addition]
Signed-off-by: Jens Axboe

block: remove biodoc.rst

2022-02-15T14:47:52+00:00

This document is completely out of date and extremely misleading. In
general the existing kerneldoc comment serve as a much better
documentation of the still existing functionality, while the history
blurbs are pretty much irrelevant today.

Signed-off-by: Christoph Hellwig 
Reviewed-by: Johannes Thumshirn 
Link: https://lore.kernel.org/r/20220215081047.3693582-1-hch@lst.de
Signed-off-by: Jens Axboe

docs: block: remove queue-sysfs.rst

2022-01-10T01:59:10+00:00

This has been replaced by Documentation/ABI/stable/sysfs-block, which is
the correct place for sysfs documentation.

Reviewed-by: Greg Kroah-Hartman 
Reviewed-by: Hannes Reinecke 
Reviewed-by: Martin K. Petersen 
Reviewed-by: Bart Van Assche 
Signed-off-by: Eric Biggers 
Link: https://lore.kernel.org/r/20211209003833.6396-8-ebiggers@kernel.org
Signed-off-by: Jens Axboe

docs: block: Create blk-mq documentation

2020-06-22T13:03:33+00:00

Create a documentation providing a background and explanation around the
operation of the Multi-Queue Block IO Queueing Mechanism (blk-mq).

The reference for writing this documentation was the source code and
"Linux Block IO: Introducing Multi-queue SSD Access on Multi-core
Systems", by Axboe et al.

Signed-off-by: André Almeida 
Reviewed-by: Jens Axboe 
Acked-by: Randy Dunlap 
Link: https://lore.kernel.org/r/20200620002036.113000-1-andrealmeid@collabora.com
Signed-off-by: Jonathan Corbet

Documentation: Document the blk-crypto framework

2020-05-14T15:46:54+00:00

The blk-crypto framework adds support for inline encryption. There are
numerous changes throughout the storage stack. This patch documents the
main design choices in the block layer, the API presented to users of
the block layer (like fscrypt or layered devices) and the API presented
to drivers for adding support for inline encryption.

Signed-off-by: Satya Tangirala 
Reviewed-by: Eric Biggers 
Signed-off-by: Jens Axboe

docs: add some documentation dirs to the driver-api book

2019-07-15T14:03:02+00:00

Those are subsystem docs, with a mix of kABI and user-faced
docs. While they're not split, keep the dirs where they are,
adding just a pointer to the main index.

Signed-off-by: Mauro Carvalho Chehab

docs: block: convert to ReST

2019-07-15T12:20:27+00:00

Rename the block documentation files to ReST, add an
index for them and adjust in order to produce a nice html
output via the Sphinx build system.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab