update comments describing file format

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

diff --git a/src/lib/krb4/tf_util.c b/src/lib/krb4/tf_util.c
index 85f88d6a158a04104b40e92cc4a6937d4121c053..5ceee51c2d46492af660adbc61acab4bf1bcfdcc 100644 (file)
--- a/src/lib/krb4/tf_util.c
+++ b/src/lib/krb4/tf_util.c
@@ -130,15 +130,22 @@ static int tf_gets (char *, int), tf_read (char *, int);
  *      Where "CREDENTIAL_x" consists of the following fixed-length
  *      fields from the CREDENTIALS structure (see "krb.h"):
  *
- *              char            service[ANAME_SZ]
- *              char            instance[INST_SZ]
- *              char            realm[REALM_SZ]
+ *              string          service[ANAME_SZ]
+ *              string          instance[INST_SZ]
+ *              string          realm[REALM_SZ]
  *              C_Block         session
  *              int             lifetime
  *              int             kvno
  *              KTEXT_ST        ticket_st
  *              long            issue_date
  *
+ * Strings are stored NUL-terminated, and read back until a NUL is
+ * found or the indicated number of bytes have been read.  (So if you
+ * try to store a string exactly that long or longer, reading them
+ * back will not work.)  The KTEXT_ST structure is stored as an int
+ * length followed by that many data bytes.  All ints are stored using
+ * host size and byte order for "int".
+ *
  * Short description of routines:
  *
  * tf_init() opens the ticket file and locks it.