Patchwork [07/11] man: Update nsdb-* command man pages to reflect simple NCE discovery

login
register
mail settings
Submitter Chuck Lever
Date Jan. 10, 2014, 4:19 p.m.
Message ID <20140110161951.32524.23423.stgit@seurat.1015granger.net>
Download mbox | patch
Permalink /patch/309330/
State Accepted
Headers show

Comments

Chuck Lever - Jan. 10, 2014, 4:19 p.m.
Update and clarify man pages for nsdb-delete-nsdb(8), nsdb-nces(8),
nsdb-remove-nci(8), nsdb-update-nci(8), and nsdb-simple-nce(8) to
reflect the use of a simpler NCE discovery mechanism.

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 doc/man/nsdb-delete-nsdb.8 |    2 +-
 doc/man/nsdb-nces.8        |   15 ++++++++-------
 doc/man/nsdb-remove-nci.8  |    8 ++++----
 doc/man/nsdb-simple-nce.8  |    2 +-
 doc/man/nsdb-update-nci.8  |    5 ++---
 5 files changed, 16 insertions(+), 16 deletions(-)

Patch

diff --git a/doc/man/nsdb-delete-nsdb.8 b/doc/man/nsdb-delete-nsdb.8
index 2e3bc28..eb1be8e 100644
--- a/doc/man/nsdb-delete-nsdb.8
+++ b/doc/man/nsdb-delete-nsdb.8
@@ -75,7 +75,7 @@  command first removes the NSDB container information
 for the specified NCE to prevent FedFS-enabled clients and servers
 from accessing the FedFS records under that NCE.
 Then, it removes all FSN and FSL records under the NCE.
-The NCE object itself is left on the LDAP server.
+The entry that was the NCE is left on the LDAP server.
 .SH OPTIONS
 .IP "\fB\-d, \-\-debug"
 Enables debugging messages during operation.
diff --git a/doc/man/nsdb-nces.8 b/doc/man/nsdb-nces.8
index fbd18cc..0c3e523 100644
--- a/doc/man/nsdb-nces.8
+++ b/doc/man/nsdb-nces.8
@@ -71,13 +71,14 @@  Some LDAP server implementations call these contexts "root suffixes".
 All LDAP entries on that server are contained under one of these
 contexts.
 .P
-When an LDAP server acts as an NSDB,
-one or more LDAP naming contexts on that server contains the
-distinguished name of an NCE.
-An NCE is the root entry of an LDAP Directory Information Tree
-containing FedFS-related information.
-This design makes the NCE DN easy for any LDAP client to discover
-with no other information than the DNS hostname of the LDAP server.
+The LDAP object under which FedFS-related entries reside
+is known as the
+.I NSDB Container Entry
+(or NCE).
+The NCE can be a naming context object,
+or it can be located somewhere below the naming context.
+Both the naming context and the NCE must be world-readable
+for FedFS-enabled clients and servers to access the NSDB.
 .P
 The
 .BR nsdb-nces (8)
diff --git a/doc/man/nsdb-remove-nci.8 b/doc/man/nsdb-remove-nci.8
index 2e93992..1c87034 100644
--- a/doc/man/nsdb-remove-nci.8
+++ b/doc/man/nsdb-remove-nci.8
@@ -73,7 +73,7 @@  Some LDAP server implementations call these contexts
 .IR "root suffixes" .
 All LDAP entries on that server are contained under naming contexts.
 .P
-The root LDAP object under which FedFS-related entries reside
+The LDAP object under which FedFS-related entries reside
 is known as the
 .I NSDB Container Entry
 (or NCE).
@@ -84,11 +84,11 @@  for FedFS-enabled clients and servers to access the NSDB.
 .P
 The
 .BR nsdb-remove-nci (8)
-command removes the pointer to an NCE from an LDAP server's
-naming context entry.
+command demotes an NCE to an unremarkable LDAP entry so that
+NSDB clients cannot discover it.
 It performs the opposite action from
 .BR nsdb-update-nci (8).
-The target NCE object and the naming context object
+The target NCE object
 .I must
 exist before this operation can complete successfully.
 .SH OPTIONS
diff --git a/doc/man/nsdb-simple-nce.8 b/doc/man/nsdb-simple-nce.8
index 24c0cdb..5a81997 100644
--- a/doc/man/nsdb-simple-nce.8
+++ b/doc/man/nsdb-simple-nce.8
@@ -83,7 +83,7 @@  or it can be located somewhere below a naming context.
 The
 .BR nsdb-simple-nce (8)
 command adds an NSDB Container Entry
-using a simple NCE DN that can be created without
+with a distinguished name that can be created without
 much prior knowledge of the server's DIT.
 .P
 Once this entry is created, the
diff --git a/doc/man/nsdb-update-nci.8 b/doc/man/nsdb-update-nci.8
index eb61972..a5f1a14 100644
--- a/doc/man/nsdb-update-nci.8
+++ b/doc/man/nsdb-update-nci.8
@@ -86,10 +86,9 @@  for FedFS-enabled clients and servers to access the NSDB.
 .P
 The
 .BR nsdb-update-nci (8)
-command inserts a pointer to an NCE
-into one of an LDAP server's naming contexts.
+command promotes an unremarkable LDAP entry to become an NCE.
 This is the step that turns an LDAP server into an NSDB.
-The target NCE object and the naming context object
+The target NCE object
 .I must
 exist before this operation can complete successfully.
 .SH OPTIONS