Fix minor documentation errors

Fix typos, remove excess header underlines, and remove trailing
whitespace.

[ghudson@mit.edu: squashed several commits, summarized commit
messages]

(cherry picked from commit 4ad099d28437b542b76053f44f18f763bdcd5152)

ticket: 8170
version_fixed: 1.13.2
status: resolved

diff --git a/doc/appdev/refs/index.rst b/doc/appdev/refs/index.rst
index 6d2844716934b7199faefe326d857ec572cb61bf..37a895f3bee4e3adcbf8215bb7aac1089ec5b21b 100644 (file)
--- a/doc/appdev/refs/index.rst
+++ b/doc/appdev/refs/index.rst
@@ -1,5 +1,5 @@
 Complete reference - API and datatypes
-==========================================================
+======================================
 
 .. toctree::
    :maxdepth: 1

diff --git a/doc/kadmin/README b/doc/kadmin/README
index 72b3694997846189725bb02244a9f045a19e2fc3..f3e6dfdf107dbe4a62fe05cf9ddd941989e4b86e 100644 (file)
--- a/doc/kadmin/README
+++ b/doc/kadmin/README
@@ -7,7 +7,7 @@ b) Old kadmin protocol - which was in the beta code (kadmin/v5passwdd)
 c) Newer kadm5 gssrpc based code (kadmin/server)
 
 d) Simple password changing protocol implemented in our kadmin server
-with client in clients/kpasswd. 
+with client in clients/kpasswd.
 
 
 
@@ -16,31 +16,31 @@ the code is used in the source tree.
 
 
 - kpasswd.protocol: Describes the password changing protocol in
-                       src/kadmin/v5passwdd. 
-                       include/adm.h has some defintions.
+                       src/kadmin/v5passwdd.
+                       include/adm.h has some definitions.
 
                    Client and server provided
 
-- kadmin.protocol: Describes other administrative protocol options that 
+- kadmin.protocol: Describes other administrative protocol options that
                        src/kadmin/v5passwdd supports
 
                    No client in the source tree uses it.
 
-- draft-ietf-cat-kerb-chg-password-02.txt: Describes the 
-                   password changing service that 
-                   clients/kpasswd uses through krb5_change_password() 
+- draft-ietf-cat-kerb-chg-password-02.txt: Describes the
+                   password changing service that
+                   clients/kpasswd uses through krb5_change_password()
                    located in lib/krb5/os/changepw.c
 
                    kadmin/server/schpw.c implements this as part of
                    the kadmin server.
 
                    This is version 1 of the protocol. Version 2 is
-                   in the IETF draft stage and is very different. 
+                   in the IETF draft stage and is very different.
 
-                   Currently: Version 1 is supported - but we may not 
+                   Currently: Version 1 is supported - but we may not
                    be implementing the TCP handling aspects.
 
-- ../doc/kadm5: Describes the current protocol. 
+- ../doc/kadm5: Describes the current protocol.
 
                    kadmin/passwd (which is not installed) uses
                    the kadm5 protocol for password changing.

diff --git a/doc/plugindev/hostrealm.rst b/doc/plugindev/hostrealm.rst
index fe1ec3845ab459776af740ee19c24568b82e68b7..4d488ef7bddc3510aef7043bfa5b5f6054d5204c 100644 (file)
--- a/doc/plugindev/hostrealm.rst
+++ b/doc/plugindev/hostrealm.rst
@@ -29,7 +29,7 @@ credentials.
 The optional **fallback_realm** method allows a module to determine
 fallback mappings for a hostname.  The first fallback mapping is tried
 if there is no authoritative mapping for a realm, and KDC referrals
-failed to produce a succesful result.
+failed to produce a successful result.
 
 The optional **default_realm** method allows a module to determine the
 local default realm.

diff --git a/doc/tools/README b/doc/tools/README
index c86fe8b5124cfd6bf185a09dac5f83ae3a795b2e..4bed11b0fb8f766719782fdc9da9acf1ec30d20e 100644 (file)
--- a/doc/tools/README
+++ b/doc/tools/README
@@ -49,7 +49,7 @@ Part A:    Transforming Doxygen XML output into reStructuredText (rst)  without
 Part B:    Bridge to Doxygen HTML output.
 
 1. Transform Doxygen XML output into reStructuredText.
-   In src/Doxygen configuration file request genetation of the tag file and XML output:
+   In src/Doxygen configuration file request generation of the tag file and XML output:
        GENERATE_TAGFILE       = krb5doxy.tag
        GENERATE_XML           = YES
 
@@ -60,6 +60,3 @@ Part B:    Bridge to Doxygen HTML output.
    where doxy_html_dir is the location of the Doxygen HTML output
 
 3.  Continue with steps 3 - 6 of Part A.
-
-
-