From: Greg Hudson <ghudson@mit.edu>
Date: Mon, 25 Jun 2012 19:26:24 +0000 (-0400)
Subject: Correctly document module setting in host_config
X-Git-Tag: krb5-1.11-alpha1~486
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f6e245f2d1a614a87361a43e547e618af43698f7;p=thirdparty%2Fkrb5.git

Correctly document module setting in host_config

The module variable must take the form modname:path, which was not
reflected in the example or described in the text.
---

diff --git a/doc/rst_source/krb_admins/host_config.rst b/doc/rst_source/krb_admins/host_config.rst
index 26335490b0..706242c663 100644
--- a/doc/rst_source/krb_admins/host_config.rst
+++ b/doc/rst_source/krb_admins/host_config.rst
@@ -21,14 +21,15 @@ off registered or built-in modules.
 A plugin module takes the form of a Unix shared object
 (``modname.so``) or Windows DLL (``modname.dll``).  If you have
 installed a third-party plugin module and want to register it, you do
-so using the **module** directive in the appropriate subsection of the
-[plugins] section.  For example, to register a client
-preauthentication plugin for one-time password authentication
-installed at ``/path/to/otp.so``, you could write::
+so using the **module** relation in the appropriate subsection of the
+[plugins] section.  The value for **module** must give the module name
+and the path to the module, separated by a colon.  For example, to
+register a client preauthentication module named ``otp`` installed at
+``/path/to/otp.so``, you could write::
 
     [plugins]
         clpreauth = {
-            module = /path/to/otp.so
+            module = otp:/path/to/otp.so
         }
 
 Many of the pluggable behaviors in MIT krb5 contain built-in modules