summaryrefslogtreecommitdiff
path: root/Documentation/block/blk-mq.rst
AgeCommit message (Collapse)Author
2021-08-24Documentation: block: blk-mq: Fix small typo in multi-queue docsJinay Jain
Fixed a small typo in the documentation for multi-queue block IO. Signed-off-by: Jinay Jain <jinaybjain@gmail.com> Link: https://lore.kernel.org/r/20210812152528.300668-1-jinaybjain@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2021-05-20docs: block: blk-mq.rst: correct drive -> driverYue Hu
It is 'driver' to complete the request. Also remove a redundant space. Signed-off-by: Yue Hu <huyue2@yulong.com> Link: https://lore.kernel.org/r/20210520074225.1989-1-zbestahu@gmail.com Signed-off-by: Jonathan Corbet <corbet@lwn.net>
2020-10-15docs: block: blk-mq.rst: get rid of :c:typeMauro Carvalho Chehab
The :c:type macros are not used properly there, as reported by Sphinx 3: ./Documentation/block/blk-mq.rst:112: WARNING: Unparseable C cross-reference: 'hctx->dispatch' Invalid C declaration: Expected end of definition. [error at 4] hctx->dispatch ----^ Also, they won't be generating any cross references. So, replace them by a literal markup. Reviewed-by: André Almeida <andrealmeid@collabora.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-10-15docs: get rid of :c:type explicit declarations for structsMauro Carvalho Chehab
The :c:type:`foo` only works properly with structs before Sphinx 3.x. On Sphinx 3.x, structs should now be declared using the .. c:struct, and referenced via :c:struct tag. As we now have the automarkup.py macro, that automatically convert: struct foo into cross-references, let's get rid of that, solving several warnings when building docs with Sphinx 3.x. Reviewed-by: André Almeida <andrealmeid@collabora.com> # blk-mq.rst Reviewed-by: Takashi Iwai <tiwai@suse.de> # sound Reviewed-by: Mike Rapoport <rppt@linux.ibm.com> Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
2020-06-22docs: block: Create blk-mq documentationAndré Almeida
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>