X-Git-Url: http://git.silcnet.org/gitweb/?a=blobdiff_plain;f=apps%2Fautodist%2Fdoc%2Fautodist.texi;h=3cc7f19d979f44bf6d5b2179e5bc76de4a100b4b;hb=4e0d1bf04b2a627f9b313b1d2db9401fe13f707c;hp=577db0ae8bfcd06b45fc9c5e2711f150bf372d1c;hpb=c231fb5a3b62c5f1c34f64b08d152459973552d3;p=autodist.git diff --git a/apps/autodist/doc/autodist.texi b/apps/autodist/doc/autodist.texi index 577db0a..3cc7f19 100644 --- 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, , , , }). +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 @@ -785,26 +789,24 @@ This will exclude the file 'README' and anything that match 'doc/client*'. @section Directive: noprocess [...] -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 -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 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 -noprocess apps/foo/* +noprocess apps/foo/ @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. @@ -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. +@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 @@ -1310,6 +1328,11 @@ Initializes Autodist environment. Creates the default distribution directory 'distdir', 'autodist.conf' configuration file and the default distribution 'default', then exits. +@item -p +@itemx --process +process file into for distribution, only non-source files can +be processed with -p. + @item -m @itemx --makedist Creates and packages distribution @@ -1419,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. +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 @@ -1460,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. +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