From: Randy Dunlap Date: Wed, 18 Mar 2026 22:21:05 +0000 (-0700) Subject: NFSD: Docs: clean up pnfs server timeout docs X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=d644a698de12e996778657f65a4608299368e138;p=thirdparty%2Flinux.git NFSD: Docs: clean up pnfs server timeout docs 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 Signed-off-by: Chuck Lever --- diff --git a/Documentation/admin-guide/nfs/pnfs-block-server.rst b/Documentation/admin-guide/nfs/pnfs-block-server.rst index b4f5997009af..7667dd2e17f1 100644 --- a/Documentation/admin-guide/nfs/pnfs-block-server.rst +++ b/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 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. diff --git a/Documentation/admin-guide/nfs/pnfs-scsi-server.rst b/Documentation/admin-guide/nfs/pnfs-scsi-server.rst index db34afbf67a9..b202508d281d 100644 --- a/Documentation/admin-guide/nfs/pnfs-scsi-server.rst +++ b/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 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.