krb5 commit [krb5-1.13]: Fix minor documentation errors
Tom Yu
tlyu at mit.edu
Mon May 4 19:09:45 EDT 2015
https://github.com/krb5/krb5/commit/2c31abee54d193a007d2f170d6b6746ce277146f
commit 2c31abee54d193a007d2f170d6b6746ce277146f
Author: Michael Mattioli <mattiolimichael at gmail.com>
Date: Thu Apr 23 01:39:37 2015 -0400
Fix minor documentation errors
Fix typos, remove excess header underlines, and remove trailing
whitespace.
[ghudson at mit.edu: squashed several commits, summarized commit
messages]
(cherry picked from commit 4ad099d28437b542b76053f44f18f763bdcd5152)
ticket: 8170
version_fixed: 1.13.2
status: resolved
doc/appdev/refs/index.rst | 2 +-
doc/kadmin/README | 20 ++++++++++----------
doc/plugindev/hostrealm.rst | 2 +-
doc/tools/README | 5 +----
4 files changed, 13 insertions(+), 16 deletions(-)
diff --git a/doc/appdev/refs/index.rst b/doc/appdev/refs/index.rst
index 6d28447..37a895f 100644
--- 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 72b3694..f3e6dfd 100644
--- 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 fe1ec38..4d488ef 100644
--- 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 c86fe8b..4bed11b 100644
--- 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.
-
-
-
More information about the cvs-krb5
mailing list