]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
Documentation: ublk: Separate UBLK_F_AUTO_BUF_REG fallback behavior sublists
authorBagas Sanjaya <bagasdotme@gmail.com>
Fri, 13 Jun 2025 02:38:57 +0000 (09:38 +0700)
committerJens Axboe <axboe@kernel.dk>
Fri, 13 Jun 2025 15:25:42 +0000 (09:25 -0600)
Stephen Rothwell reports htmldocs warning on ublk docs:

Documentation/block/ublk.rst:414: ERROR: Unexpected indentation. [docutils]

Fix the warning by separating sublists of auto buffer registration
fallback behavior from their appropriate parent list item.

Fixes: ff20c516485e ("ublk: document auto buffer registration(UBLK_F_AUTO_BUF_REG)")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20250612132638.193de386@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Link: https://lore.kernel.org/r/20250613023857.15971-1-bagasdotme@gmail.com
Signed-off-by: Jens Axboe <axboe@kernel.dk>
Documentation/block/ublk.rst

index abec524a04edfda1ccc28974b452d0137b6a2313..8c4030bcabb6347a0012c66b019f065c7db61fc6 100644 (file)
@@ -408,6 +408,7 @@ Fallback Behavior
 If auto buffer registration fails:
 
 1. When ``UBLK_AUTO_BUF_REG_FALLBACK`` is enabled:
+
    - The uring_cmd is completed
    - ``UBLK_IO_F_NEED_REG_BUF`` is set in ``ublksrv_io_desc.op_flags``
    - The ublk server must manually deal with the failure, such as, register
@@ -415,6 +416,7 @@ If auto buffer registration fails:
      for handling ublk IO
 
 2. If fallback is not enabled:
+
    - The ublk I/O request fails silently
    - The uring_cmd won't be completed