From 61ddfbaa19f28bd8b352dea307ab752239470026 Mon Sep 17 00:00:00 2001 From: Steve Simmons Date: Tue, 31 Aug 2010 19:21:50 -0400 Subject: [PATCH 1/1] Update the man pages pod source adding text to discourage use of uss. Usually the text added was a copy of a CAUTION section that had already been added in a few places. This change applies it consistently across all uss-related man pages. In pod1/afs.pod that text would be excessively wordy; a briefer note is used there to direct the reader to the full text. This is a partial fix for RT bug #128018. It does not fully close the bug; the AFS Administrators Guide needs to be updated as well. Change-Id: Id64646d20a9b22c0e11c9654842fa255fb4258ea Reviewed-on: http://gerrit.openafs.org/2637 Tested-by: BuildBot Reviewed-by: Jeffrey Altman --- doc/man-pages/pod1/afs.pod | 8 +++++--- doc/man-pages/pod5/uss.pod | 11 ++++++++++- doc/man-pages/pod5/uss_bulk.pod | 9 +++++++++ doc/man-pages/pod8/uss.pod | 18 +++++++++--------- doc/man-pages/pod8/uss_add.pod | 9 +++++++++ doc/man-pages/pod8/uss_apropos.pod | 9 +++++++++ doc/man-pages/pod8/uss_bulk.pod | 9 +++++++++ doc/man-pages/pod8/uss_delete.pod | 9 +++++++++ doc/man-pages/pod8/uss_help.pod | 9 +++++++++ 9 files changed, 78 insertions(+), 13 deletions(-) diff --git a/doc/man-pages/pod1/afs.pod b/doc/man-pages/pod1/afs.pod index c991c78..9c37d1e 100644 --- a/doc/man-pages/pod1/afs.pod +++ b/doc/man-pages/pod1/afs.pod @@ -40,7 +40,9 @@ membership information. =item uss -Interface for automated administration of user accounts. +Interface for automated administration of user accounts. Deprecated, may +be removed from a future version of OpenAFS. See B man page for more +detail. =item vos @@ -66,8 +68,8 @@ name>. The I specifies the group of related commands to which the command belongs, and indicates which command interpreter and server process perform the command. AFS has several command suites, including -B, B, B, B, B, B and B. Some of -these suites have an interactive mode in which the issuer omits the +B, B, B, B, B, B (deprecated) and B. +Some of these suites have an interactive mode in which the issuer omits the I portion of the command name. The I tells the command interpreter and server process diff --git a/doc/man-pages/pod5/uss.pod b/doc/man-pages/pod5/uss.pod index 1e4ee4c..f0598f6 100644 --- a/doc/man-pages/pod5/uss.pod +++ b/doc/man-pages/pod5/uss.pod @@ -1,6 +1,15 @@ =head1 NAME -uss - Provides instructions for the uss add command +uss - Provides instructions for the uss add command (deprecated) + +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. =head1 DESCRIPTION diff --git a/doc/man-pages/pod5/uss_bulk.pod b/doc/man-pages/pod5/uss_bulk.pod index da97578..69d3a9b 100644 --- a/doc/man-pages/pod5/uss_bulk.pod +++ b/doc/man-pages/pod5/uss_bulk.pod @@ -2,6 +2,15 @@ uss_bulk - Provides instructions for the uss bulk command +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The uss bulk input file lists instructions for the B command diff --git a/doc/man-pages/pod8/uss.pod b/doc/man-pages/pod8/uss.pod index 3b45590..f71a5a8 100644 --- a/doc/man-pages/pod8/uss.pod +++ b/doc/man-pages/pod8/uss.pod @@ -2,6 +2,15 @@ uss - Introduction to the uss command suite +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The commands in the B command suite help administrators to create AFS @@ -33,15 +42,6 @@ The B command removes most parts of a user account. To obtain help, issue the B and B commands. -=head1 CAUTIONS - -The B command suite is currently designed for cells using the -obsolete Authentication Server, and therefore is primarily useful for -sites that have not yet migrated to a Kerberos version 5 KDC. The -Authentication Server and supporting commands will be removed in a future -version of OpenAFS, which may include B unless someone who finds it -useful converts it to work with a Kerberos version 5 KDC. - =head1 OPTIONS The following arguments and flags are available on many commands in the diff --git a/doc/man-pages/pod8/uss_add.pod b/doc/man-pages/pod8/uss_add.pod index b9027d8..5941601 100644 --- a/doc/man-pages/pod8/uss_add.pod +++ b/doc/man-pages/pod8/uss_add.pod @@ -34,6 +34,15 @@ B S<<< B<-us> > >>> S<<< [B<-r> >] =for html +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The B command creates entries in the Protection Database and diff --git a/doc/man-pages/pod8/uss_apropos.pod b/doc/man-pages/pod8/uss_apropos.pod index 1977669..036b473 100644 --- a/doc/man-pages/pod8/uss_apropos.pod +++ b/doc/man-pages/pod8/uss_apropos.pod @@ -14,6 +14,15 @@ B S<<< B<-t> > >>> [B<-h>] =for html +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The B command displays the first line of the online help diff --git a/doc/man-pages/pod8/uss_bulk.pod b/doc/man-pages/pod8/uss_bulk.pod index 6de7bbe..b86c5d5 100644 --- a/doc/man-pages/pod8/uss_bulk.pod +++ b/doc/man-pages/pod8/uss_bulk.pod @@ -24,6 +24,15 @@ B S<<< B<-f> > >>> S<<< [B<-t> +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The B command executes the uss commands listed in the I S<<< B<-u> > >>> S<<< [B<-m> +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The B command removes the Authentication Database and diff --git a/doc/man-pages/pod8/uss_help.pod b/doc/man-pages/pod8/uss_help.pod index b337926..a269e82 100644 --- a/doc/man-pages/pod8/uss_help.pod +++ b/doc/man-pages/pod8/uss_help.pod @@ -14,6 +14,15 @@ B S<<< [B<-t> >+] >>> [B<-h>] =for html +=head1 CAUTIONS + +The B command suite is currently designed for cells using the +obsolete Authentication Server, and therefore is primarily useful for +sites that have not yet migrated to a Kerberos version 5 KDC. The +Authentication Server and supporting commands will be removed in a future +version of OpenAFS, which may include B unless someone who finds it +useful converts it to work with a Kerberos version 5 KDC. + =head1 DESCRIPTION The B command displays the complete online help entry (short -- 1.9.4