Document kadm5_hook chpass randomize-key behavior

kadmind's randkey operation invokes the kadm5_hook chpass method with
a null newpass parameter, which wasn't documented.

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

diff --git a/src/include/krb5/kadm5_hook_plugin.h b/src/include/krb5/kadm5_hook_plugin.h
index 6a0aa45f2ecbe38fec53c405941555281ff83b5b..c95c17f38c537df9d3e5ab45be8bd48ea951411f 100644 (file)
--- a/src/include/krb5/kadm5_hook_plugin.h
+++ b/src/include/krb5/kadm5_hook_plugin.h
@@ -107,6 +107,7 @@ typedef struct kadm5_hook_vtable_1_st {
     /** Indicates that the password is being changed.
      * @param stage is an integer from #kadm5_hook_stage enumeration
      * @param keepold is true if existing keys are being kept.
+     * @param newpass is NULL if the key sare being randomized.
      */
     kadm5_ret_t (*chpass)(krb5_context,
                           kadm5_hook_modinfo *modinfo,