Skip to content

Commit d644a69

Browse files
rddunlapchucklever
authored andcommitted
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 <[email protected]> Signed-off-by: Chuck Lever <[email protected]>
1 parent 124f9af commit d644a69

2 files changed

Lines changed: 20 additions & 20 deletions

File tree

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ system log with the following format:
4747

4848
FENCE failed client[IP_address] clid[#n] device[dev_name]
4949

50-
Where:
50+
where:
5151

52-
IP_address: refers to the IP address of the affected client.
53-
#n: indicates the unique client identifier.
54-
dev_name: specifies the name of the block device related
55-
to the fencing attempt.
52+
- IP_address: refers to the IP address of the affected client.
53+
- #n: indicates the unique client identifier.
54+
- dev_name: specifies the name of the block device related
55+
to the fencing attempt.
5656

5757
The server will repeatedly retry the operation indefinitely. During
5858
this time, access to the affected file is restricted for all other
@@ -62,11 +62,11 @@ clients access the same file simultaneously.
6262
To restore access to the affected file for other clients, the admin
6363
needs to take the following actions:
6464

65-
. shutdown or power off the client being fenced.
66-
. manually expire the client to release all its state on the server:
65+
- shutdown or power off the client being fenced.
66+
- manually expire the client to release all its state on the server::
6767

68-
echo 'expire' > /proc/fs/nfsd/clients/clid/ctl'.
68+
echo 'expire' > /proc/fs/nfsd/clients/clid/ctl
6969

70-
Where:
70+
where:
7171

72-
clid: is the unique client identifier displayed in the system log.
72+
- clid: is the unique client identifier displayed in the system log.

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ system log with the following format:
2929

3030
FENCE failed client[IP_address] clid[#n] device[dev_name]
3131

32-
Where:
32+
where:
3333

34-
IP_address: refers to the IP address of the affected client.
35-
#n: indicates the unique client identifier.
36-
dev_name: specifies the name of the block device related
37-
to the fencing attempt.
34+
- IP_address: refers to the IP address of the affected client.
35+
- #n: indicates the unique client identifier.
36+
- dev_name: specifies the name of the block device related
37+
to the fencing attempt.
3838

3939
The server will repeatedly retry the operation indefinitely. During
4040
this time, access to the affected file is restricted for all other
@@ -44,12 +44,12 @@ clients access the same file simultaneously.
4444
To restore access to the affected file for other clients, the admin
4545
needs to take the following actions:
4646

47-
. shutdown or power off the client being fenced.
48-
. manually expire the client to release all its state on the server:
47+
- shutdown or power off the client being fenced.
48+
- manually expire the client to release all its state on the server::
4949

50-
echo 'expire' > /proc/fs/nfsd/clients/clid/ctl'.
50+
echo 'expire' > /proc/fs/nfsd/clients/clid/ctl
5151

52-
Where:
52+
where:
5353

54-
clid: is the unique client identifier displayed in the system log.
54+
- clid: is the unique client identifier displayed in the system log.
5555

0 commit comments

Comments
 (0)