Commit d644a698 authored by Randy Dunlap's avatar Randy Dunlap Committed by Chuck Lever
Browse files

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: default avatarRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: default avatarChuck Lever <chuck.lever@oracle.com>
parent 124f9af2

Documentation/admin-guide/nfs/pnfs-block-server.rst

+10 −10
Original line number Diff line number Diff line
@@ -47,11 +47,11 @@ 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

    - 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
@@ -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.

Documentation/admin-guide/nfs/pnfs-scsi-server.rst

+10 −10
Original line number Diff line number Diff line
@@ -29,11 +29,11 @@ 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

    - 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
@@ -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.