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

diff --git a/doc/rst_source/krb_admins/host_config.rst b/doc/rst_source/krb_admins/host_config.rst
index 08a5378b491d6116c02358270082fe7282461b9b..26335490b0cf3574420202a0a8c264780b59f704 100644 (file)
--- 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 852bad18a2a8cdcab10a20cb341f943ee1f21dcd..26703330b20057b0f914f88409001195850de18e 100644 (file)
--- 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