AD_ENABLE_DEPENDENCIES -> AD_DISABLE_DEPENDENCIES.

[autodist.git] / apps / autodist / doc / autodist.texi

diff --git a/apps/autodist/doc/autodist.texi b/apps/autodist/doc/autodist.texi
index 393eb6a2b542dcf697878ca663af71ed2a9853a9..3cc7f19d979f44bf6d5b2179e5bc76de4a100b4b 100644 (file)
--- a/apps/autodist/doc/autodist.texi
+++ b/apps/autodist/doc/autodist.texi
@@ -500,6 +500,10 @@ Will replace all appearances of the license header in 'license/BSD-header'
 file to the license header in 'license/GPL-header' in any file in the
 distribution.  Note that, the header change will be performed when
 the distribution is packaged (@pxref{Creating distribution, , , , }).
 file to the license header in 'license/GPL-header' in any file in the
 distribution.  Note that, the header change will be performed when
 the distribution is packaged (@pxref{Creating distribution, , , , }).

+The 'makedist.log' file created by Autodist during distribution packaging
+will list all files that were not re-licensed.  The log file can be used
+to check that the distribution is re-licensed correctly, and fix any
+possible mistakes.

 
 With 'license-header' directive you may initially set your files in the
 source tree into what ever license you prefer.  However, if you need to
 
 With 'license-header' directive you may initially set your files in the
 source tree into what ever license you prefer.  However, if you need to


@@ -785,26 +789,24 @@ This will exclude the file 'README' and anything that match 'doc/client*'.
 
 @section Directive: noprocess <filename> [...]
 
 
 @section Directive: noprocess <filename> [...]
 

-The 'noprocess' directive can be used to tell Autodist specificly not to
-process a file.  The Autodist will not process the file during
-preparation or during distribution packaging.  This directive is optional.
-One or more file can be specified in the 'noprocess' directive.  Zero or
-more 'noprocess' directives can be used in distribution.  The <filename>
-can be a single file or a regular expression that will match several files.
-Note that, in current Autodist version 'noprocess' cannot be used to
-specify directories.
+The 'noprocess' directive can be used to tell Autodist specificly not to 
+process files or directories.  The Autodist will not process the files 
+during distribution packaging.  This directive is optional.  One or more 
+files can be specified in the 'noprocess' directive.  Zero or more 
+'noprocess' directives can be used in distribution.  The <filename> can be 
+a single file, a single directory or a regular expression that will match 
+several files and/or directories.

 
 Example:
 @example
 noprocess autodist.texi
 
 Example:
 @example
 noprocess autodist.texi

-noprocess apps/foo/*
+noprocess apps/foo/

 @end example
 
 @end example
 

-Autodist will not process 'autodist.texi' file, and any file that match
-'apps/foo/*'.  Note that, any subdirectory under 'apps/foo/' will not
-match, and will be processed.
+Autodist will not process 'autodist.texi' file, and any files and 
+directories under 'apps/foo/'.

 
 

-Also note that, 'noprocess' directive cannot be used to disallow 
+Note that, 'noprocess' directive cannot be used to disallow 

 processing of any file with '.ad' suffix.
 
 
 processing of any file with '.ad' suffix.
 
 


@@ -1018,7 +1020,23 @@ macro 'AC_OUTPUT'.  This macro has no arguments.
 Note that, the 'configure.ad' fragments are not real full featured
 configure scripts.  They must not use 'AD_INIT', 'AD_INCLUDE_CONFIGURE',
 'AC_INIT' or any other initialization macros.
 Note that, the 'configure.ad' fragments are not real full featured
 configure scripts.  They must not use 'AD_INIT', 'AD_INCLUDE_CONFIGURE',
 'AC_INIT' or any other initialization macros.

+@end defmac
+
+
+@defmac AD_DISABLE_DEPENDENCIES
+
+This macro is used to disable Autodist dependencies in 'Makefile.ad' 
+files.  If this macro is used, then after editing 'Makefile.ad' file the 
+Autodist must be run manually.  When dependencies are enabled editing 
+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.

 @end defmac
 
 @menu
 @end defmac
 
 @menu


@@ -1066,7 +1084,9 @@ If you need processed files during configuration or compilation then they
 need to have '.ad' suffix.
 
 Note that, the distdef format used in these files must be the non-source
 need to have '.ad' suffix.
 
 Note that, the distdef format used in these files must be the non-source

-format.
+format, even if the file is source file.  This is because the distdefs
+are processed during source tree preparation, and the source file will
+have all distdefs removed when it is compiled.

 
 @menu
 * Distdefines::                 Using distdefs in files
 
 @menu
 * Distdefines::                 Using distdefs in files


@@ -1256,8 +1276,18 @@ The following suffixes will be considered as source files by the Autodist:
     .hh
 @end example
 
     .hh
 @end example
 

+Also, any file that has '.in' suffix with any of the above source file 
+suffixes, the format inside the file must follow the source code format.  

 Using distdefs in any other file must follow the non-source format.
 
 Using distdefs in any other file must follow the non-source format.
 

+Example:
+@example
+    .c.in
+    .h.in
+@end example
+
+In this example, in both of the files the source code format is used.
+

 
 @node Invoking Autodist
 @chapter Invoking Autodist
 
 @node Invoking Autodist
 @chapter Invoking Autodist


@@ -1298,6 +1328,11 @@ Initializes Autodist environment.  Creates the default distribution
 directory 'distdir', 'autodist.conf' configuration file and the
 default distribution 'default', then exits.
 
 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.
+

 @item -m
 @itemx --makedist
 Creates and packages distribution
 @item -m
 @itemx --makedist
 Creates and packages distribution


@@ -1407,6 +1442,9 @@ Creating the distribution that file will be read by the Autodist
 automatically.  That file should not be removed or the distribution
 cannot be packaged.
 
 automatically.  That file should not be removed or the distribution
 cannot be packaged.
 

+Autodist also created a log file, 'autodist.log', that will include
+messages created by Autodist during preparation.
+

 @menu
 * Creating distribution::       Creating distribution with Autodist
 @end menu
 @menu
 * Creating distribution::       Creating distribution with Autodist
 @end menu


@@ -1448,6 +1486,14 @@ are being packaged you may set 'pre-process-dist-hook',
 distribution file.  Also note that any hooks provided by Automake in 
 Makefiles will be run in normal manner.
 
 distribution file.  Also note that any hooks provided by Automake in 
 Makefiles will be run in normal manner.
 

+When creating the distribution Autodist creates a log file, 
+'makedist.log', that will include messages created by Autodist.  It is 
+suggested that this file is checked after distribution is created.  For 
+example, when the 'license-header' directive is used to re-license the 
+distribution, the 'makedist.log' will include list of files that were not 
+re-licensed.  The log file can be used to verify that the distribution was 
+re-licensed correctly, and fix any possible mistakes.
+

 
 @node Examples
 @chapter Examples
 
 @node Examples
 @chapter Examples