linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] Documentation: ublk: Separate UBLK_F_AUTO_BUF_REG fallback behavior sublists
@ 2025-06-13  2:38 Bagas Sanjaya
  2025-06-13 15:26 ` Jens Axboe
  0 siblings, 1 reply; 2+ messages in thread
From: Bagas Sanjaya @ 2025-06-13  2:38 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation,
	Linux Block Devices
  Cc: Caleb Sander Mateos, Ming Lei, Jens Axboe, Jonathan Corbet,
	Bagas Sanjaya, Stephen Rothwell

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>
---
 Documentation/block/ublk.rst | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/block/ublk.rst b/Documentation/block/ublk.rst
index abec524a04edfd..8c4030bcabb634 100644
--- a/Documentation/block/ublk.rst
+++ b/Documentation/block/ublk.rst
@@ -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
 

base-commit: c73e4b8bde5f2defecef6a3df792971f83841bd8
-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] Documentation: ublk: Separate UBLK_F_AUTO_BUF_REG fallback behavior sublists
  2025-06-13  2:38 [PATCH] Documentation: ublk: Separate UBLK_F_AUTO_BUF_REG fallback behavior sublists Bagas Sanjaya
@ 2025-06-13 15:26 ` Jens Axboe
  0 siblings, 0 replies; 2+ messages in thread
From: Jens Axboe @ 2025-06-13 15:26 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation,
	Linux Block Devices, Bagas Sanjaya
  Cc: Caleb Sander Mateos, Ming Lei, Jonathan Corbet, Stephen Rothwell


On Fri, 13 Jun 2025 09:38:57 +0700, Bagas Sanjaya wrote:
> 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.
> 
> [...]

Applied, thanks!

[1/1] Documentation: ublk: Separate UBLK_F_AUTO_BUF_REG fallback behavior sublists
      commit: db3dfae1a2f662e69d535827703bcdbb04b8d72b

Best regards,
-- 
Jens Axboe




^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-06-13 15:26 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-06-13  2:38 [PATCH] Documentation: ublk: Separate UBLK_F_AUTO_BUF_REG fallback behavior sublists Bagas Sanjaya
2025-06-13 15:26 ` Jens Axboe

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).