Document scripts/lookups-Makefile for new lookups.

[exim.git] / doc / doc-docbook / spec.xfpt

diff --git a/doc/doc-docbook/spec.xfpt b/doc/doc-docbook/spec.xfpt
index 9d2dc4b270b7286cc131433cbbd69e0430d6c668..e049936a32fd17e46c42fd5f02bf08582c75232e 100644 (file)
--- a/doc/doc-docbook/spec.xfpt
+++ b/doc/doc-docbook/spec.xfpt
@@ -42,6 +42,7 @@
 
 . /////////////////////////////////////////////////////////////////////////////
 . These definitions set some parameters and save some typing.
+. Update the Copyright year (only) when changing content.
 . /////////////////////////////////////////////////////////////////////////////
 
 .set previousversion "4.80"
@@ -50,6 +51,9 @@
 .set ACL "access control lists (ACLs)"
 .set I   "    "
 
+.macro copyyear
+2012
+.endmacro
 
 . /////////////////////////////////////////////////////////////////////////////
 . Additional xfpt markup used by this document, over and above the default
@@ -184,7 +188,7 @@
   <authorinitials>EM</authorinitials>
 </revision></revhistory>
 <copyright><year>
-.year
+.copyyear
            </year><holder>University of Cambridge</holder></copyright>
 </bookinfo>
 .literal off
@@ -36321,6 +36325,12 @@ Add to &_src/config.h.defaults_& the line:
 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
 and create a table entry as is done for all the other drivers and lookup types.
 .next
+Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
+near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
+Add your &`NEWDRIVER`& to that list.
+As long as the dynamic module would be named &_newdriver.so_&, you can use the
+simple form that most lookups have.
+.next
 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
 driver or lookup type and add it to the definition of OBJ.