Document error return values

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

diff --git a/src/lib/krb5/krb/unparse.c b/src/lib/krb5/krb/unparse.c
index 7c8858d51032553b88b0d904a1f40e4dfa772f26..6f87347e31aee16417e6d63766ce32e58d1655cb 100644 (file)
--- a/src/lib/krb5/krb/unparse.c
+++ b/src/lib/krb5/krb/unparse.c
@@ -36,7 +36,11 @@ static char rcsid_unparse_c[] =
  * appear in any the component, they will be representing using
  * backslash encoding.  ("\/", "\@", or '\0', respectively)
  *
- * returns system errors XXX
+ * returns error
+ *     KRB_PARSE_MALFORMED     principal is invalid (does not contain
+ *                             at least 2 components)
+ * also returns system errors
+ *     ENOMEM                  unable to allocate memory for string
  */
 
 #define REALM_SEP      '@'