linux/Documentation/block/index.rst

.. SPDX-License-Identifier: GPL-2.0

=====
Block
=====

.. toctree::
   :maxdepth: 1

   bfq-iosched
   biovecs
   blk-mq
   cmdline-partition
   data-integrity
   deadline-iosched
   inline-encryption
   ioprio
   kyber-iosched
   null_blk
   pr
   request
   stat
   switching-sched
   writeback_cache_control
   ublk
docs: add some documentation dirs to the driver-api book 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 <mchehab+samsung@kernel.org> 2019-06-18 20:16:23 +00:00			`.. SPDX-License-Identifier: GPL-2.0`
docs: block: convert to ReST 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 <mchehab+samsung@kernel.org> 2019-04-18 22:45:00 +00:00
			`=====`
			`Block`
			`=====`

			`.. toctree::`
			`:maxdepth: 1`

			`bfq-iosched`
			`biovecs`
docs: block: Create blk-mq documentation 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 <andrealmeid@collabora.com> Reviewed-by: Jens Axboe <axboe@kernel.dk> Acked-by: Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20200620002036.113000-1-andrealmeid@collabora.com Signed-off-by: Jonathan Corbet <corbet@lwn.net> 2020-06-20 00:20:36 +00:00			`blk-mq`
docs: block: convert to ReST 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 <mchehab+samsung@kernel.org> 2019-04-18 22:45:00 +00:00			`cmdline-partition`
			`data-integrity`
			`deadline-iosched`
Documentation: Document the blk-crypto framework 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 <satyat@google.com> Reviewed-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Jens Axboe <axboe@kernel.dk> 2020-05-14 00:37:16 +00:00			`inline-encryption`
docs: block: convert to ReST 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 <mchehab+samsung@kernel.org> 2019-04-18 22:45:00 +00:00			`ioprio`
			`kyber-iosched`
			`null_blk`
			`pr`
			`request`
			`stat`
			`switching-sched`
			`writeback_cache_control`
Documentation: document ublk Add documentation for ublk subsystem. It was supposed to be documented when merging the driver, but missing at that time. Cc: Bagas Sanjaya <bagasdotme@gmail.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Richard W.M. Jones <rjones@redhat.com> Cc: Xiaoguang Wang <xiaoguang.wang@linux.alibaba.com> Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: ZiyangZhang <ZiyangZhang@linux.alibaba.com> Signed-off-by: Ming Lei <ming.lei@redhat.com> [axboe: correct MAINTAINERS addition] Signed-off-by: Jens Axboe <axboe@kernel.dk> 2022-09-02 15:23:02 +00:00			`ublk`