svn rev #25843: trunk/doc/rst_source/ krb_admins/ krb_plugindev/

[ghudson@MIT.EDU]

http://src.mit.edu/fisheye/changelog/krb5/?cs=25843
Commit By: ghudson
Log Message:
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.


Changed Files:
U   trunk/doc/rst_source/krb_admins/host_config.rst
U   trunk/doc/rst_source/krb_plugindev/profile.rst
Modified: trunk/doc/rst_source/krb_admins/host_config.rst
===================================================================
--- trunk/doc/rst_source/krb_admins/host_config.rst	2012-04-30 23:33:45 UTC (rev 25842)
+++ trunk/doc/rst_source/krb_admins/host_config.rst	2012-05-02 18:38:33 UTC (rev 25843)
@@ -90,6 +90,8 @@
 surrounded in square brackets.
 
 
+.. _profile_plugin_config:
+
 Configuration profile modules
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

Modified: trunk/doc/rst_source/krb_plugindev/profile.rst
===================================================================
--- trunk/doc/rst_source/krb_plugindev/profile.rst	2012-04-30 23:33:45 UTC (rev 25842)
+++ trunk/doc/rst_source/krb_plugindev/profile.rst	2012-05-02 18:38:33 UTC (rev 25843)
@@ -6,10 +6,16 @@
 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
 function accepts a residual string, which may be used to help locate