]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
NFSD: Docs: clean up pnfs server timeout docs
authorRandy Dunlap <rdunlap@infradead.org>
Wed, 18 Mar 2026 22:21:05 +0000 (15:21 -0700)
committerChuck Lever <chuck.lever@oracle.com>
Fri, 3 Apr 2026 13:29:32 +0000 (09:29 -0400)
Make various changes to the documentation formatting to avoid docs
build errors and otherwise improve the produced output format:

- use bullets for lists
- don't use a '.' at the end of echo commands
- fix indentation

Documentation/admin-guide/nfs/pnfs-block-server.rst:55: ERROR: Unexpected indentation. [docutils]
Documentation/admin-guide/nfs/pnfs-scsi-server.rst:37: ERROR: Unexpected indentation. [docutils]

Fixes: 6a97f70b45e7 ("NFSD: Enforce timeout on layout recall and integrate lease manager fencing")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
Documentation/admin-guide/nfs/pnfs-block-server.rst
Documentation/admin-guide/nfs/pnfs-scsi-server.rst

index b4f5997009af7122a2275e7e3fbc7a6e02ab0f5c..7667dd2e17f1a0f2b1035840859ae075662b66a0 100644 (file)
@@ -47,12 +47,12 @@ system log with the following format:
 
     FENCE failed client[IP_address] clid[#n] device[dev_name]
 
-    Where:
+    where:
 
-    IP_address: refers to the IP address of the affected client.
-    #n: indicates the unique client identifier.
-    dev_name: specifies the name of the block device related
-              to the fencing attempt.
+    IP_address: refers to the IP address of the affected client.
+    #n: indicates the unique client identifier.
+    dev_name: specifies the name of the block device related
+      to the fencing attempt.
 
 The server will repeatedly retry the operation indefinitely. During
 this time, access to the affected file is restricted for all other
@@ -62,11 +62,11 @@ clients access the same file simultaneously.
 To restore access to the affected file for other clients, the admin
 needs to take the following actions:
 
-    . shutdown or power off the client being fenced.
-    . manually expire the client to release all its state on the server:
+    - shutdown or power off the client being fenced.
+    - manually expire the client to release all its state on the server::
 
-      echo 'expire' > /proc/fs/nfsd/clients/clid/ctl'.
+        echo 'expire' > /proc/fs/nfsd/clients/clid/ctl
 
-      Where:
+    where:
 
-      clid: is the unique client identifier displayed in the system log.
+      clid: is the unique client identifier displayed in the system log.
index db34afbf67a9626ed346b7c12b065faf4b961236..b202508d281d54d7d08388ddf1458c80797e0501 100644 (file)
@@ -29,12 +29,12 @@ system log with the following format:
 
     FENCE failed client[IP_address] clid[#n] device[dev_name]
 
-    Where:
+    where:
 
-    IP_address: refers to the IP address of the affected client.
-    #n: indicates the unique client identifier.
-    dev_name: specifies the name of the block device related
-              to the fencing attempt.
+    IP_address: refers to the IP address of the affected client.
+    #n: indicates the unique client identifier.
+    dev_name: specifies the name of the block device related
+      to the fencing attempt.
 
 The server will repeatedly retry the operation indefinitely. During
 this time, access to the affected file is restricted for all other
@@ -44,12 +44,12 @@ clients access the same file simultaneously.
 To restore access to the affected file for other clients, the admin
 needs to take the following actions:
 
-    . shutdown or power off the client being fenced.
-    . manually expire the client to release all its state on the server:
+    - shutdown or power off the client being fenced.
+    - manually expire the client to release all its state on the server::
 
-      echo 'expire' > /proc/fs/nfsd/clients/clid/ctl'.
+        echo 'expire' > /proc/fs/nfsd/clients/clid/ctl
 
-      Where:
+    where:
 
-      clid: is the unique client identifier displayed in the system log.
+      clid: is the unique client identifier displayed in the system log.