Patchwork [1/7] man: Fix example in fedfs-create-junction(8)

login
register
mail settings
Submitter Chuck Lever
Date Nov. 3, 2011, 3:28 p.m.
Message ID <20111103152813.2445.72019.stgit@degas.1015granger.net>
Download mbox | patch
Permalink /patch/123455/
State Accepted
Headers show

Comments

Chuck Lever - Nov. 3, 2011, 3:28 p.m.
The example in the fedfs-create-junction(8) man page suggests the UUID
can be specified without the "-u" switch, which is not correct.  For
readability, split the example over two lines.

The fedfs-create-replication(8) man page has similar problems.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---

 doc/man/fedfs-create-junction.8    |    3 ++-
 doc/man/fedfs-create-replication.8 |    9 +++++----
 2 files changed, 7 insertions(+), 5 deletions(-)

Patch

diff --git a/doc/man/fedfs-create-junction.8 b/doc/man/fedfs-create-junction.8
index f9c4530..7423198 100644
--- a/doc/man/fedfs-create-junction.8
+++ b/doc/man/fedfs-create-junction.8
@@ -196,7 +196,8 @@  To create a new FedFS junction on the remote server
 use:
 .RS
 .sp
-$ fedfs-create-junction -h fs.example.net -l nsdb.example.net `uuidgen -t` -p /export/junction1
+$ fedfs-create-junction -h fs.example.net -l nsdb.example.net \\
+	-u `uuidgen -t` -p /export/junction1
 .sp
 .RE
 In this example, a new FSN UUID is created on the spot.
diff --git a/doc/man/fedfs-create-replication.8 b/doc/man/fedfs-create-replication.8
index b500ae5..6b7e82a 100644
--- a/doc/man/fedfs-create-replication.8
+++ b/doc/man/fedfs-create-replication.8
@@ -34,7 +34,7 @@  fedfs-create-replication \- send a FEDFS_CREATE_REPLICATION ADMIN protocol reque
 .RB [ \-h
 .IR hostname ]
 .BI "-p " path
-.BI "-u " fsn-uuid
+.BI "-u " uuid
 .RB [ \-l
 .IR nsdbname ]
 .RB [ \-r
@@ -72,7 +72,7 @@  The meaning of these arguments is described in more detail in
 .IP "\fB\-d, \-\-debug"
 Specifies that debugging messages be produced during operation.
 .IP "\fB\-u, \-\-fsnuuid=\fIuuid\fP"
-Specifies the FSN UUID to insert into the new FedFS replication.
+Specifies the UUID to insert into the new FedFS replication.
 .IP "\fB\-?, \-\-help"
 Prints a
 .BR fedfs-create-replication (8)
@@ -196,10 +196,11 @@  To create a new FedFS replication on the remote server
 use:
 .RS
 .sp
-$ fedfs-create-replication -h fs.example.net -l nsdb.example.net `uuidgen -t` -p /export/replication1
+$ fedfs-create-replication -h fs.example.net -l nsdb.example.net \\
+	-u `uuidgen -t` -p /export/replication1
 .sp
 .RE
-In this example, a new FSN UUID is created on the spot.
+In this example, a new UUID is created on the spot.
 It can be read back from the server using the
 .BR fedfs-lookup-replication (8)
 command.