Mostly formatting nitpicking. Fix some typos in function names as well

git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@5814 dc483132-0cff-0310-8789-dd5450dbe970

diff --git a/doc/api/ChangeLog b/doc/api/ChangeLog
index dfc124b5e0a5384ee5d5575eb98518be894a8064..b53551c943e8c7b2c684d4cd370ce9553574d9fd 100644 (file)
--- a/doc/api/ChangeLog
+++ b/doc/api/ChangeLog
@@ -1,3 +1,12 @@
+Sun May  7 13:56:43 1995  Ezra Peisach  <epeisach@kangaroo.mit.edu>
+
+       * krb5.tex (subsubsection{The krb5_auth_context}): Some function
+               names were misformed. 
+
+       * errors.tex (subsection{error_table kv5m}): Reformatting nits.
+
+       * tables.tex: Formatting fixes.
+
 Thu May  4 14:29:45 1995  Ezra Peisach  <epeisach@kangaroo.mit.edu>
 
        * krb5.tex: Reorganized into subsubsections. Added principal

diff --git a/doc/api/errors.tex b/doc/api/errors.tex
index 1b6f2bfaa5605ded66557cf09140c4a45f6a222f..ad90cac53bb219c82c290f6a6a4dc2eb575f196b 100644 (file)
--- a/doc/api/errors.tex
+++ b/doc/api/errors.tex
@@ -239,7 +239,10 @@ The Kerberos v5 database library error code table
 % $Source$
 % $Author$
 
-\subsection{The Kerberos v5 magic numbers errorcode table}
+\subsection{error_table kv5m}
+
+The Kerberos v5 magic numbers errorcode table follows. These are used
+for the magic numbers found in data structures.
 
 \begin{small}
 \begin{tabular}{ll} 

diff --git a/doc/api/krb5.tex b/doc/api/krb5.tex
index 89f89dc4d2d57efe006190b903e3cfdaa9c8abd6..4aa6a3301206c84588193ad2b8e5d45c2b9ebdef 100644 (file)
--- a/doc/api/krb5.tex
+++ b/doc/api/krb5.tex
@@ -54,7 +54,7 @@ Returns {\sc enomem}.
 \subsubsection{The krb5_auth_context}
 
 While the \datatype{krb5_context} represents a per-process or per-thread
-contex, the \datatype{krb5_auth_context} represents a per-connection
+context, the \datatype{krb5_auth_context} represents a per-connection
 context are are used by the various functions involved directly in
 client/server authentication.  Some of the data stored in this context
 include keyblocks, addresses, sequence numbers, authenticators, checksum
@@ -68,19 +68,11 @@ type, and replay cache pointer.
 
 The auth_context may be described as a per connection context. This
 context contains all data pertinent to the the various authentication
-routines. This function initializes the auth_context. The default flags
-for the context are set to enable the use of the replay cache
-(KRB5_AUTH_CONTEXT_DO_TIME) but no sequence numbers. 
+routines. This function initializes the auth_context. 
 
-Valid flags that may be set with \funcname{krb5_auth_con_setflags}:
-
-\begin{tabular}{ll}
-\multicolumn{1}{c}{Symbol} & Meaning \\
-KRB5_AUTH_CONTEXT_DO_TIME & Use timestamps \\
-KRB5_AUTH_CONTEXT_RET_TIME & Save timestamps\\ &\  to output structure\\
-KRB5_AUTH_CONTEXT_DO_SEQUENCE  & Use sequence numbers \\
-KRB5_AUTH_CONTEXT_RET_SEQUENCE & Copy sequence numbers \\ &\ to output structure\\
-\end{tabular}
+The default flags for the context are set to enable the use of the replay cache
+(KRB5_AUTH_CONTEXT_DO_TIME) but no sequence numbers. The function
+\funcname{krb5_auth_con_setflags} allows the flags to be changed.
 
 The default checksum type is set to CKSUMTYPE_RSA_MD4_DES. This may be
 changed with \funcname{krb5_auth_con_setcksumtype}.
@@ -104,7 +96,15 @@ Frees the auth_context \funcparam{auth_context} returned by
 \end{funcdecl}
 
 Sets the flags of \funcparam{auth_context} to funcparam{flags}. Valid
-flags are listed above.
+flags are:
+
+\begin{tabular}{ll}
+\multicolumn{1}{c}{Symbol} & Meaning \\
+KRB5_AUTH_CONTEXT_DO_TIME & Use timestamps \\
+KRB5_AUTH_CONTEXT_RET_TIME & Save timestamps\\ &\  to output structure\\
+KRB5_AUTH_CONTEXT_DO_SEQUENCE  & Use sequence numbers \\
+KRB5_AUTH_CONTEXT_RET_SEQUENCE & Copy sequence numbers \\ &\ to output structure\\
+\end{tabular}
 
 
 \begin{funcdecl}{krb5_auth_con_getflags}{krb5_error_code}{\funcinout}
@@ -181,7 +181,7 @@ Retrieves the keyblock stored in \funcparam{auth_context}. The memory
 allocated in this function should be freed with a call to
 \funcname{krb5_free_keyblock}. 
 
-\begin{funcdecl}{krb5_auth_con_getkey}{krb5_error_code}{\funcinout}
+\begin{funcdecl}{krb5_auth_con_getlocalsubkey}{krb5_error_code}{\funcinout}
 \funcarg{krb5_context}{context}
 \funcarg{krb5_auth_context *}{auth_context}
 \funcout
@@ -192,7 +192,7 @@ Retrieves the local_subkey keyblock stored in
 \funcparam{auth_context}. The memory allocated in this function should
 be freed with a call to \funcname{krb5_free_keyblock}.
 
-\begin{funcdecl}{krb5_auth_con_getkey}{krb5_error_code}{\funcinout}
+\begin{funcdecl}{krb5_auth_con_getremotesubkey}{krb5_error_code}{\funcinout}
 \funcarg{krb5_context}{context}
 \funcarg{krb5_auth_context *}{auth_context}
 \funcout
@@ -1618,6 +1618,8 @@ The \funcparam{auth_context} flags specify whether timestamps
 
 Returns system errors, integrity errors.
 
+\subsubsection{Miscellaneous main functions}
+
 \begin{funcdecl}{krb5_address_search}{krb5_boolean}{\funcinout}
 \funcarg{krb5_context}{context}
 \funcin

diff --git a/doc/api/libos.tex b/doc/api/libos.tex
index 7b91631e4c6a0d2cab09e6d6f4ff709c524b4890..754abc96fed59438efbf37403810e84cb3f66388 100644 (file)
--- a/doc/api/libos.tex
+++ b/doc/api/libos.tex
@@ -426,8 +426,8 @@ microseconds portion in \funcparam{*microseconds}.}
 
 \begin{funcdecl}{krb5_read_password}{krb5_error_code}{\funcin}
 \funcarg{krb5_context}{context}
-\funcarg{char *}{prompt}
-\funcarg{char *}{prompt2}
+\funcarg{const char *}{prompt}
+\funcarg{const char *}{prompt2}
 \funcout
 \funcarg{char *}{return_pwd}
 \funcinout

diff --git a/doc/api/library.tex b/doc/api/library.tex
index f26ca77bd81d54b86a5cb921909043b272a0bdf7..804da9896cabb7ed28628945608401590fdd2e1d 100644 (file)
--- a/doc/api/library.tex
+++ b/doc/api/library.tex
@@ -92,7 +92,7 @@ programming, maintenance, and porting.
 \subsection{Key table functions}
 \input{keytab.tex}
 
-\subsection{Free routines}
+\subsection{Free functions}
 \input{free.tex}
 
 \subsection{Operating-system specific functions}

diff --git a/doc/api/tables.tex b/doc/api/tables.tex
index 23e6c952ae9cee41e7c71f514a540634e762c9c6..b272a07b9623bb051287962c0047409645385149 100644 (file)
--- a/doc/api/tables.tex
+++ b/doc/api/tables.tex
@@ -27,8 +27,8 @@ KDC_OPT_VALIDATE      & 2.2   &               \\
 
 The following is a list of preauthentication methods which are supported
 by Kerberos.  Most preauthentication methods are used by
-krb5_get_in_tkt(), krb5_get_in_tkt_with_password(), and
-krb5_get_in_tkt_with_skey(); at some sites, the Kerberos server can be
+\funcname{krb5_get_in_tkt}, \funcname{krb5_get_in_tkt_with_password}, and
+\funcname{krb5_get_in_tkt_with_skey}; at some sites, the Kerberos server can be
 configured so that during the initial ticket transation, it will only
 return encrypted tickets after the user has proven his or her identity
 using a supported preauthentication mechanism.  This is done to make