[PATCH] NFSD: Docs: clean up pnfs server timeout docs

Randy Dunlap posted 1 patch 2 weeks, 4 days ago
Documentation/admin-guide/nfs/pnfs-block-server.rst |   20 +++++-----
Documentation/admin-guide/nfs/pnfs-scsi-server.rst  |   20 +++++-----
2 files changed, 20 insertions(+), 20 deletions(-)
[PATCH] NFSD: Docs: clean up pnfs server timeout docs
Posted by Randy Dunlap 2 weeks, 4 days ago
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>
---
# for Chuck's tree
Cc: Dai Ngo <dai.ngo@oracle.com>
Cc: Chuck Lever <chuck.lever@oracle.com>
Cc: linux-nfs@vger.kernel.org
Cc: linux-doc@vger.kernel.org

 Documentation/admin-guide/nfs/pnfs-block-server.rst |   20 +++++-----
 Documentation/admin-guide/nfs/pnfs-scsi-server.rst  |   20 +++++-----
 2 files changed, 20 insertions(+), 20 deletions(-)

--- linux-next-20260316.orig/Documentation/admin-guide/nfs/pnfs-block-server.rst
+++ linux-next-20260316/Documentation/admin-guide/nfs/pnfs-block-server.rst
@@ -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 simultaneou
 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.
--- linux-next-20260316.orig/Documentation/admin-guide/nfs/pnfs-scsi-server.rst
+++ linux-next-20260316/Documentation/admin-guide/nfs/pnfs-scsi-server.rst
@@ -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 simultaneou
 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.
Re: [PATCH] NFSD: Docs: clean up pnfs server timeout docs
Posted by Chuck Lever 2 weeks, 4 days ago
From: Chuck Lever <chuck.lever@oracle.com>

On Wed, 18 Mar 2026 15:21:05 -0700, Randy Dunlap wrote:
> 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
> 
> [...]

Applied to nfsd-testing, thanks!

[1/1] NFSD: Docs: clean up pnfs server timeout docs
      commit: 4961fdf3193741f9b8004ba61238a99cdf396286

--
Chuck Lever