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
inherited distribution. If the distribution cannot be inherited Autodist
will give an error.
-The 'inherit' will inherit the following information from the distribution:
-distdefs, undefines, includes, excludes and noprocess. Other information
-will not be inherited. If the inherited distribution inherits other
-distributions, they will also be inherited automatically. User should be
-careful when inheriting distributions as it may be possible to create an
-infinite recursion. The Autodist would allow for this and not detect this
-error. Zero or more 'inherit' directives may be set for distribution.
+The 'inherit' will inherit the following information from the
+distribution: distdefs, undefines, includes, excludes and noprocesses.
+Other information will not be inherited. If the inherited distribution
+inherits other distributions, they will also be inherited automatically.
+User should be careful when inheriting distributions as it may be possible
+to create an infinite recursion. The Autodist would allow for this and
+not detect this error. Zero or more 'inherit' directives may be set for
+distribution.
Example:
@example
distribution. All distdefs, undefines, includes, excludes and noprocesses
from these distributions are now also part this distribution.
+The distribution that is being prepared or packaged take precedence when
+defining distdefs that were specificly undefined in the inherited
+distribution. This means that if the inherited distribution specificly
+undefines a distdefs but the inheriting distribution (one being prepared
+or packaged) specificly defines it, the distdef will be defined.
+Similarly, if the inherited distribution defines a distdef but the
+inheriting distribution undefines it, the distdef will be undefined.
+Note that, this precedence works only in the top distribution (the one
+being prepared or packaged). If the inherited distribution inherits other
+distributions, all distdefs (defined and specificly undefined) will be
+inherited as is. This means that if one inherited distribution defines a
+distdef that other inherited distribution distdef undefines, it will be
+undefined. However, the top distribution can then override them if
+needed.
+
@section Directive: define <symbol>
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, a single directory or a regular expression that
-will match several files and/or directories. If directory is specified
-then all files inside the directory will not be processed.
+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.
Example:
@example
noprocess autodist.texi
+noprocess apps/foo/*
@end example
-Autodist will not process 'autodist.texi' file.
+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.
-Note that, 'noprocess' directive cannot be used to disallow processing
-of any file with '.ad' suffix.
+Also note that, 'noprocess' directive cannot be used to disallow
+processing of any file with '.ad' suffix.
@section Directive: pre-hook <filename> [...]
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
.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.
+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
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
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
projects / autodist.git / blobdiff