Added dependency support for configure.ad files too.
[autodist.git] / apps / autodist / doc / autodist.texi
index c167a0eb10fb9afae2c929ffe84c3b1345762bd0..a054dac701185bfb3a39ad51e928f985c4fb31ac 100644 (file)
@@ -80,6 +80,7 @@ Integrating Autodist
 * Makefile.ad files::           Makefile.ad for creating Makefile.am
 * Other .ad files::             Other files with .ad suffix
 * Distdefines::                 Using distdefs in files
+* Dependencies::                Autodist dependency support
 
 Invoking Autodist
 
@@ -240,6 +241,7 @@ as they may not exist yet.
 * Makefile.ad files::           Makefile.ad for creating Makefile.am
 * Other .ad files::             Other files with .ad suffix
 * Distdefines::                 Using distdefs in files
+* Dependencies::                Autodist dependency support
 @end menu
 
 
@@ -1023,19 +1025,18 @@ configure scripts.  They must not use 'AD_INIT', 'AD_INCLUDE_CONFIGURE',
 @end defmac
 
 
-@defmac AD_ENABLE_DEPENDENCIES
+@defmac AD_DISABLE_DEPENDENCIES
 
-This macro is used to enable Autodist dependencies in 'Makefile.ad' files.  
-If this macro is used, then after editing 'Makefile.ad' file running 
-Autodist manually is not required, but it is run automatically when the 
-source is compiled with 'make'.  This macro has no arguments.
+This macro is used to disable Autodist dependencies.  If this macro is
+used, then after editing 'Makefile.ad' and 'configure.ad' files the
+Autodist must be run manually.  When dependencies are enabled Autodist is
+run automatically when source is compiled with 'make'.  Dependencies make
+the development easier.  This macro has no arguments.
 
 Note that, the dependencies are enabled only in the prepared source tree.  
 Depedencies are not delivered to distribution, as they would require the 
-presence of 'Makefile.ad' files, which are not delivered to distribution. 
-
-Current Autodist version does not support dependencies in 'configure.ad' 
-files, only in 'Makefile.ad' files.
+presence of 'Makefile.ad' and 'configure.ad' files, which are not 
+delivered to distribution.
 @end defmac
 
 @menu
@@ -1288,6 +1289,28 @@ Example:
 In this example, in both of the files the source code format is used.
 
 
+@node Dependencies
+@section Autodist dependency support
+
+Autodist support dependencies for 'Makefile.ad' and 'configure.ad' files.  
+When these files are edited, they are processed by Autodist automatically 
+when the source tree is compiled with 'make'.  This makes development in 
+the source tree easier, when Autodist does not have to be run manually.
+The dependencies can be disabled by using 'AD_DISABLE_DEPENDENCIES' macro 
+in the 'configure.ad' file.
+
+When editing 'configure.ad' fragments the modifcation is detected when the 
+source tree is compiled with 'make' from the top source directory.  
+Giving 'make' in a subdirectory will not detect a change in 'configure.ad' 
+fragment.
+
+Dependencies are present only in the prepared source tree.  They are not 
+delivered to created distribution, as they depend on 'Makefile.ad' and 
+'configure.ad' files which are not present in the created distribution.  
+Autodist automatically removes the dependencies when the distribution is 
+created.
+
+
 @node Invoking Autodist
 @chapter Invoking Autodist
 
@@ -1328,9 +1351,10 @@ directory 'distdir', 'autodist.conf' configuration file and the
 default distribution 'default', then exits.
 
 @item -p
-@itemx --process <src> <dst>
-process file <src> into <dst> for distribution, only non-source files can 
-be processed with -p.
+@itemx --process <type> <src> <dst>
+Process file <src> into <dst> for distribution, <type> is 'makefile',
+'configure', 'non-source' or 'source' and defines the type of <src>,
+then exits.
 
 @item -m
 @itemx --makedist