Document error codes returned

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

diff --git a/src/lib/krb5/krb/parse.c b/src/lib/krb5/krb/parse.c
index 65a188c4448ff25f9b746e374c646530123d033c..31c8a7399962e0461069faf1f4ebf1c1d99e6188 100644 (file)
--- a/src/lib/krb5/krb/parse.c
+++ b/src/lib/krb5/krb/parse.c
@@ -35,13 +35,18 @@ static char rcsid_parse_c [] =
  * string, then the rest of the string after it represents the realm name.
  * Otherwise the local realm name is used.
  * 
- * returns system errors XXX
+ * error return:
+ *     KRB5_PARSE_MALFORMED    badly formatted string
+ *
+ * also returns system errors:
+ *     ENOMEM  malloc failed/out of memory
+ *
+ * get_default_realm() is called; it may return other errors.
  */
 
 #define REALM_SEP      '@'
 #define        COMPONENT_SEP   '/'
 #define QUOTECHAR      '\\'
-#define        MAXRLMSZ        256             /* XXX! */
 
 #define FCOMPNUM       2