docs: block: blk-mq.rst: correct places -> place

Corrected a typo in the blk-mq.rst documentation where 'places' was
incorrectly used instead of 'place'.

Signed-off-by: Kuan-Wei Chiu <visitorckw@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20230902164121.2653109-1-visitorckw@gmail.com>

Documentation: block: blk-mq: Fix small typo in multi-queue docs

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>

docs: block: blk-mq.rst: correct drive -> driver

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>

docs: block: blk-mq.rst: get rid of :c:type

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>

docs: get rid of :c:type explicit declarations for structs

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>

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>