From: Bagas Sanjaya Date: Wed, 3 Dec 2025 01:09:10 +0000 (+0700) Subject: NFSD: nfsd-io-modes: Wrap shell snippets in literal code blocks X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4fcf9952fb3137c64e32edb5fcd03da6febe4724;p=thirdparty%2Fkernel%2Flinux.git 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 Closes: https://lore.kernel.org/linux-next/20251202152506.7a2d2d41@canb.auug.org.au/ Signed-off-by: Bagas Sanjaya Reviewed-by: Jeff Layton Reviewed-by: Randy Dunlap Tested-by: Randy Dunlap Signed-off-by: Chuck Lever --- diff --git a/Documentation/filesystems/nfs/nfsd-io-modes.rst b/Documentation/filesystems/nfs/nfsd-io-modes.rst index e3a522d097666..fa47c4d3dfb95 100644 --- a/Documentation/filesystems/nfs/nfsd-io-modes.rst +++ b/Documentation/filesystems/nfs/nfsd-io-modes.rst @@ -25,12 +25,14 @@ Based on the configured settings, NFSD's IO will either be: - not cached stable_how=NFS_UNSTABLE (NFSD_IO_DIRECT=2) To set an NFSD IO mode, write a supported value (0 - 2) to the -corresponding IO operation's debugfs interface, e.g.: +corresponding IO operation's debugfs interface, e.g.:: + echo 2 > /sys/kernel/debug/nfsd/io_cache_read echo 2 > /sys/kernel/debug/nfsd/io_cache_write To check which IO mode NFSD is using for READ or WRITE, simply read the -corresponding IO operation's debugfs interface, e.g.: +corresponding IO operation's debugfs interface, e.g.:: + cat /sys/kernel/debug/nfsd/io_cache_read cat /sys/kernel/debug/nfsd/io_cache_write @@ -128,17 +130,19 @@ Tracing: misaligned READ to the next DIO-aligned block (on either end of the original READ, as needed). - This combination of trace events is useful for READs: - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_vector/enable - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_direct/enable - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_io_done/enable - echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_read/enable + This combination of trace events is useful for READs:: + + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_vector/enable + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_direct/enable + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_io_done/enable + echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_read/enable The nfsd_write_direct trace event shows how NFSD splits a given misaligned WRITE into a DIO-aligned middle segment. - This combination of trace events is useful for WRITEs: - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_opened/enable - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_direct/enable - echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_io_done/enable - echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_write/enable + This combination of trace events is useful for WRITEs:: + + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_opened/enable + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_direct/enable + echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_io_done/enable + echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_write/enable