svn rev #24283: branches/plugins2/src/include/krb5/

[ghudson@MIT.EDU]

http://src.mit.edu/fisheye/changelog/krb5/?cs=24283
Commit By: ghudson
Log Message:
Expand the pwqual_plugin.h documentation to tell module implementors
what a pwqual initvt function should look like.



Changed Files:
U   branches/plugins2/src/include/krb5/pwqual_plugin.h
Modified: branches/plugins2/src/include/krb5/pwqual_plugin.h
===================================================================
--- branches/plugins2/src/include/krb5/pwqual_plugin.h	2010-08-31 21:37:51 UTC (rev 24282)
+++ branches/plugins2/src/include/krb5/pwqual_plugin.h	2010-09-01 16:00:56 UTC (rev 24283)
@@ -32,8 +32,14 @@
  * number of 1.
  *
  * Password quality plugin modules should define a function named
- * pwqual_<modulename>_initvt.  The initvt function should:
+ * pwqual_<modulename>_initvt, matching the signature:
  *
+ *   krb5_error_code
+ *   pwqual_modname_initvt(krb5_context context, int maj_ver, int min_ver,
+ *                         krb5_plugin_vtable vtable);
+ *
+ * The initvt function should:
+ *
  * - Check that the supplied maj_ver number is supported by the module, or
  *   return KRB5_PLUGIN_VER_NOTSUPP if it is not.
  *