tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

NFSD: nfsd-io-modes: Wrap shell snippets in literal code blocks

Sphinx reports htmldocs indentation warnings:

Documentation/filesystems/nfs/nfsd-io-modes.rst:29: ERROR: Unexpected indentation. [docutils]
Documentation/filesystems/nfs/nfsd-io-modes.rst:34: ERROR: Unexpected indentation. [docutils]

Fix these by wrapping shell snippets in literal code blocks.

Fixes: fa8d4e6784d1b6 ("NFSD: add Documentation/filesystems/nfs/nfsd-io-modes.rst")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251202152506.7a2d2d41@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Jeff Layton <jlayton@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>

authored by Bagas Sanjaya and committed by Chuck Lever 4fcf9952 21478b6e

+16 -12
unified split
+16 -12
Documentation/filesystems/nfs/nfsd-io-modes.rst
··· 25 - not cached stable_how=NFS_UNSTABLE (NFSD_IO_DIRECT=2) 26 27 To set an NFSD IO mode, write a supported value (0 - 2) to the 28 - corresponding IO operation's debugfs interface, e.g.: 29 echo 2 > /sys/kernel/debug/nfsd/io_cache_read 30 echo 2 > /sys/kernel/debug/nfsd/io_cache_write 31 32 To check which IO mode NFSD is using for READ or WRITE, simply read the 33 - corresponding IO operation's debugfs interface, e.g.: 34 cat /sys/kernel/debug/nfsd/io_cache_read 35 cat /sys/kernel/debug/nfsd/io_cache_write 36 ··· 130 misaligned READ to the next DIO-aligned block (on either end of the 131 original READ, as needed). 132 133 - This combination of trace events is useful for READs: 134 - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_vector/enable 135 - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_direct/enable 136 - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_io_done/enable 137 - echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_read/enable 138 139 The nfsd_write_direct trace event shows how NFSD splits a given 140 misaligned WRITE into a DIO-aligned middle segment. 141 142 - This combination of trace events is useful for WRITEs: 143 - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_opened/enable 144 - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_direct/enable 145 - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_io_done/enable 146 - echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_write/enable
··· 25 - not cached stable_how=NFS_UNSTABLE (NFSD_IO_DIRECT=2) 26 27 To set an NFSD IO mode, write a supported value (0 - 2) to the 28 + corresponding IO operation's debugfs interface, e.g.:: 29 + 30 echo 2 > /sys/kernel/debug/nfsd/io_cache_read 31 echo 2 > /sys/kernel/debug/nfsd/io_cache_write 32 33 To check which IO mode NFSD is using for READ or WRITE, simply read the 34 + corresponding IO operation's debugfs interface, e.g.:: 35 + 36 cat /sys/kernel/debug/nfsd/io_cache_read 37 cat /sys/kernel/debug/nfsd/io_cache_write 38 ··· 128 misaligned READ to the next DIO-aligned block (on either end of the 129 original READ, as needed). 130 131 + This combination of trace events is useful for READs:: 132 + 133 + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_vector/enable 134 + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_direct/enable 135 + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_io_done/enable 136 + echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_read/enable 137 138 The nfsd_write_direct trace event shows how NFSD splits a given 139 misaligned WRITE into a DIO-aligned middle segment. 140 141 + This combination of trace events is useful for WRITEs:: 142 + 143 + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_opened/enable 144 + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_direct/enable 145 + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_io_done/enable 146 + echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_write/enable