diff options
| author | Greg Hudson <ghudson@mit.edu> | 2012-05-02 18:38:33 +0000 |
|---|---|---|
| committer | Greg Hudson <ghudson@mit.edu> | 2012-05-02 18:38:33 +0000 |
| commit | 4f9ed9aa7e4bfb6e4890d795ae733376ecd2a2d4 (patch) | |
| tree | 77bf4d82b49744b644a8dac05ce0ef57e1fdde26 | |
| parent | b7b9468ad05e9d2492cf0edf5846135ae62b1156 (diff) | |
| download | krb5-4f9ed9aa7e4bfb6e4890d795ae733376ecd2a2d4.tar.gz krb5-4f9ed9aa7e4bfb6e4890d795ae733376ecd2a2d4.tar.xz krb5-4f9ed9aa7e4bfb6e4890d795ae733376ecd2a2d4.zip | |
Clarify profile pluggable interface documentation
Explain how profile plugin modules integrate with libkrb5, since it's
a bit different than usual. Also fix a broken note.
git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25843 dc483132-0cff-0310-8789-dd5450dbe970
| -rw-r--r-- | doc/rst_source/krb_admins/host_config.rst | 2 | ||||
| -rw-r--r-- | doc/rst_source/krb_plugindev/profile.rst | 12 |
2 files changed, 11 insertions, 3 deletions
diff --git a/doc/rst_source/krb_admins/host_config.rst b/doc/rst_source/krb_admins/host_config.rst index 08a5378b49..26335490b0 100644 --- a/doc/rst_source/krb_admins/host_config.rst +++ b/doc/rst_source/krb_admins/host_config.rst @@ -90,6 +90,8 @@ and *options* (if present) are options provided to the plugin module, surrounded in square brackets. +.. _profile_plugin_config: + Configuration profile modules ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/rst_source/krb_plugindev/profile.rst b/doc/rst_source/krb_plugindev/profile.rst index 852bad18a2..26703330b2 100644 --- a/doc/rst_source/krb_plugindev/profile.rst +++ b/doc/rst_source/krb_plugindev/profile.rst @@ -6,9 +6,15 @@ configuration information is obtained by the Kerberos library and applications. For a detailed description of the profile interface, see the header file ``<profile.h>``. -.. note: The locate interface does not follow the normal conventions - for MIT krb5 pluggable interfaces, because it is part of a - lower-level component of the krb5 library. +.. note:: The profile interface does not follow the normal conventions + for MIT krb5 pluggable interfaces, because it is part of a + lower-level component of the krb5 library. + +As with other types of plugin modules, a profile module is a Unix +shared object or Windows DLL, built separately from the krb5 tree. +The krb5 library will dynamically load and use a profile plugin module +if it reads a ``module`` directive at the beginning of krb5.conf, as +described in :ref:`profile_plugin_config`. A profile module exports a function named ``profile_module_init`` matching the signature of the profile_module_init_fn type. This |