Commit 4fcf9952 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Chuck Lever
Browse files

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: fa8d4e67 ("NFSD: add Documentation/filesystems/nfs/nfsd-io-modes.rst")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251202152506.7a2d2d41@canb.auug.org.au/


Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: default avatarJeff Layton <jlayton@kernel.org>
Reviewed-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Tested-by: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarChuck Lever <chuck.lever@oracle.com>
parent 21478b6e

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

+16 −12
Original line number Diff line number Diff line
@@ -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,7 +130,8 @@ 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:

    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
@@ -137,7 +140,8 @@ Tracing: 
    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:

    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