Skip to content

Commit 4fcf995

Browse files
bagasmechucklever
authored andcommitted
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: fa8d4e6 ("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>
1 parent 21478b6 commit 4fcf995

1 file changed

Lines changed: 16 additions & 12 deletions

File tree

Documentation/filesystems/nfs/nfsd-io-modes.rst

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,14 @@ Based on the configured settings, NFSD's IO will either be:
2525
- not cached stable_how=NFS_UNSTABLE (NFSD_IO_DIRECT=2)
2626

2727
To set an NFSD IO mode, write a supported value (0 - 2) to the
28-
corresponding IO operation's debugfs interface, e.g.:
28+
corresponding IO operation's debugfs interface, e.g.::
29+
2930
echo 2 > /sys/kernel/debug/nfsd/io_cache_read
3031
echo 2 > /sys/kernel/debug/nfsd/io_cache_write
3132

3233
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+
corresponding IO operation's debugfs interface, e.g.::
35+
3436
cat /sys/kernel/debug/nfsd/io_cache_read
3537
cat /sys/kernel/debug/nfsd/io_cache_write
3638

@@ -128,17 +130,19 @@ Tracing:
128130
misaligned READ to the next DIO-aligned block (on either end of the
129131
original READ, as needed).
130132

131-
This combination of trace events is useful for READs:
132-
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_vector/enable
133-
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_direct/enable
134-
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_io_done/enable
135-
echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_read/enable
133+
This combination of trace events is useful for READs::
134+
135+
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_vector/enable
136+
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_direct/enable
137+
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_read_io_done/enable
138+
echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_read/enable
136139

137140
The nfsd_write_direct trace event shows how NFSD splits a given
138141
misaligned WRITE into a DIO-aligned middle segment.
139142

140-
This combination of trace events is useful for WRITEs:
141-
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_opened/enable
142-
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_direct/enable
143-
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_io_done/enable
144-
echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_write/enable
143+
This combination of trace events is useful for WRITEs::
144+
145+
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_opened/enable
146+
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_direct/enable
147+
echo 1 > /sys/kernel/tracing/events/nfsd/nfsd_write_io_done/enable
148+
echo 1 > /sys/kernel/tracing/events/xfs/xfs_file_direct_write/enable

0 commit comments

Comments
 (0)