Document C API equivalents for Perl functions

diff --git a/lib/Authen/Kerberos.pm b/lib/Authen/Kerberos.pm
index bddf9e66556b667f24e91444abf8056ed954c58d..589fb38cd78932f64eb580009dbf30326434c2c3 100644 (file)
--- a/lib/Authen/Kerberos.pm
+++ b/lib/Authen/Kerberos.pm
@@ -117,6 +117,8 @@ of the keytab type identifiers recognized by the underlying Kerberos
 library.  The most common type is C<FILE>, in which case I<residual> is a
 path.
 
+This is equivalent to the C function krb5_kt_resolve().
+
 =item principal(NAME)
 
 Convert the given principal name to an Authen::Kerberos::Principal object.
@@ -124,6 +126,8 @@ Normally there is no need to use this method since all Authen::Kerberos
 APIs that take principal names will accept the string form of the principal
 name and convert it internally.
 
+This is equivalent to the C function krb5_parse_name().
+
 =back
 
 =head1 AUTHOR

diff --git a/lib/Authen/Kerberos/Keytab.pm b/lib/Authen/Kerberos/Keytab.pm
index 4f3aad57209fce8e059e61718105be0ef3287c6e..96fccedfc9e4b37c72d93f1a611601683932abd0 100644 (file)
--- a/lib/Authen/Kerberos/Keytab.pm
+++ b/lib/Authen/Kerberos/Keytab.pm
@@ -81,6 +81,10 @@ In a scalar context, returns the number of entries in a keytab.  In an
 array context, returns all of the entries of the keytab as
 Authen::Kerberos::KeytabEntry objects.
 
+This function has no direct equivalent in the C API, but it is roughly
+equivalent to krb5_kt_start_seq_get() followed by multiple calls to
+krb5_kt_next_entry().
+
 =back
 
 =head1 AUTHOR

diff --git a/lib/Authen/Kerberos/Principal.pm b/lib/Authen/Kerberos/Principal.pm
index 0eaffbc61e6367ee2cb0cd06a0940d0531c4f2cc..4028270c4de7a1a517672f24fb7d9f4e03d87013 100644 (file)
--- a/lib/Authen/Kerberos/Principal.pm
+++ b/lib/Authen/Kerberos/Principal.pm
@@ -92,6 +92,8 @@ the string form of the principal name.  Special characters in any
 principal component, such as C<@> or C</>, will be escaped using the
 normal Kerberos principal string encoding.
 
+This is equivalent to the C function krb5_unparse_name().
+
 =back
 
 =head1 AUTHOR