summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGreg Hudson <ghudson@mit.edu>2010-09-01 16:00:56 +0000
committerGreg Hudson <ghudson@mit.edu>2010-09-01 16:00:56 +0000
commite83cfa14b519803cda3454af74bb5cbdf721e5b3 (patch)
treeec79c751304f9eee3f6622af4e2ff6c8b2ea6974
parent44c2a4a83acb02360e4c5adc5b46f362a17790f4 (diff)
downloadkrb5-plugins2.tar.gz
Expand the pwqual_plugin.h documentation to tell module implementorsplugins2
what a pwqual initvt function should look like. git-svn-id: svn://anonsvn.mit.edu/krb5/branches/plugins2@24283 dc483132-0cff-0310-8789-dd5450dbe970
-rw-r--r--src/include/krb5/pwqual_plugin.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/src/include/krb5/pwqual_plugin.h b/src/include/krb5/pwqual_plugin.h
index 61f806277..403bb1152 100644
--- a/src/include/krb5/pwqual_plugin.h
+++ b/src/include/krb5/pwqual_plugin.h
@@ -32,7 +32,13 @@
* 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.