@copying
-This manual is for SILC Autodist (version @value{VERSION},
-@value{UPDATED}), a program which is used to manage and create source
-distributions.
-
-Copyright @copyright{} 2004 - 2005 Pekka Riikonen, SILC Project
-
-@quotation
-Permission is granted to copy, distribute and/or modify this document
-under the terms of the @acronym{GNU} Free Documentation License,
-Version 1.2 or any later version published by the Free Software
-Foundation; with no Invariant Sections, with the Front-Cover texts
-being ``A @acronym{GNU} Manual,'' and with the Back-Cover Texts as in
-(a) below. A copy of the license is included in the section entitled
-``@acronym{GNU} Free Documentation License.''
-
-(a) The FSF's Back-Cover Text is: ``You have freedom to copy and
-modify this @acronym{GNU} Manual, like @acronym{GNU} software. Copies
-published by the Free Software Foundation raise funds for
-@acronym{GNU} development.''
-@end quotation
+Autodist is a source distribution management system that allows powerful
+mechanisms to define what is included in and excluded from a distribution
+and what license is used. It is especially targeted at large software
+projects that create multiple distributions from a source tree. Autodist
+supports distribution management in directory, file, and file content
+level, and automatic relicensing of a distribution.
+
@end copying
@dircategory Software development
@end direntry
@titlepage
-@title SILC Autodist
+@title Autodist
@subtitle For version @value{VERSION}, @value{UPDATED}
@author Pekka Riikonen
@page
@ifnottex
@node Top
@comment node-name, next, previous, up
-@top SILC Autodist
+@top Autodist
@insertcopying
* Integrating Autodist:: Integrating Autodist into your project
* Invoking Autodist:: Running Autodist
* Examples:: Examples using Autodist
+* Download:: Download @url{http://silcnet.org/download/autodist/, Autodist @value{VERSION}}
@detailmenu
- --- The Detailed Node Listing ---
-
Introduction
* Motivation:: Reasons for using 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
ending with '.ad' suffix will also be processed. The processed file will
have the '.ad' suffix removed (@pxref{Preparing source tree, , , , }).
Autodist also creates and packages the distribution using common GNU
-distribution creation process, specificly `make dist'. Autodist, however,
+distribution creation process, specifically `make dist'. Autodist, however,
controls this process and during packaging phase the Autodist processes
all files in the distribution (other than '*.ad' files, which has already
been processed earlier by Autodist). The resulted package is a processed
are removed. The distdefs are respected in source files by the
preprocessor.
-Autodist is not a binary packaging system. It is specificly used to
+Autodist is not a binary packaging system. It is specifically used to
create source distributions. A binary packaging system, however can be
hooked to the distribution creation process, if needed.
distribution creation. The Autodist attempts to provide a tool that any
size software project can effectively use to manage their distributions.
-Without a tool like Autodist, large software projects usually has to be
+Without a tool like Autodist, large software projects usually have to be
split into separate source trees, which may not always be possible because
they may share large portions of common code (which may further make
concurrent development of the applications hard), or multiple Autoconf and
* 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
of the lines from the current header will not be replaced. If the new header
has fewer lines, empty lines must be added to it. If the new header file
has more lines than the current header file, the extra lines will not appear
-in the replaced header. Basic rule is to always make sure the header
+in the replaced header. Basic rule is to always make sure the header
files have equal amount of lines in them.
Second limitation is in indentation of the header files. It is suggested,
If same indentation is not used the appearance of the replaced header
may not be perfect. While this is a cosmetic issue, one still to remember.
-Third limitation is that the distribution cannot be partially re-licensed.
-If the 'license-header' directive is used then all files that have the
-specified header will be replaced with the new header. There are
-currently two ways to not re-license a file; use different license header
-in the file than one specified in 'license-header', or specify the file or
-directory in 'noprocess' directive. Using 'noprocess' is not possible if
-the file needs to be otherwise processed for the distribution. Future
-versions of Autodist may provide a mechanism to re-license only part of
+Third limitation is that the distribution cannot be partially re-licensed.
+If the 'license-header' directive is used then all files that have the
+specified header will be replaced with the new header. There are
+currently two ways to not re-license a file; use different license header
+in the file than one specified in 'license-header', or specify the file or
+directory in 'noprocess' directive. Using 'noprocess' is not possible if
+the file needs to be otherwise processed for the distribution. Future
+versions of Autodist may provide a mechanism to re-license only part of
the distribution.
Example current header:
In this example, if the text in the current header file is found in any
file in the distribution it will be replaced with the new header file.
-Notice that, both header files has same amount of lines (8 lines).
+Notice that, both header files have same amount of lines (8 lines).
Note that, the current header must match exactly the header used in
files. Otherwise the replacement will not be complete.
+@section Directive: prereq <version>
+
+The 'prereq' may be used to enforce the Autodist version. If the Autodist
+version used to process the distribution is older than the version
+specified with 'prereq' the Autodist will fail.
+
+Example:
+@example
+prereq 1.3.2
+@end example
+
+Will require Autodist 1.3.2 or newer for this distribution.
+
+
@section Directive: inherit <distfile>
The Autodist provides inheritance of distributions. The 'inherit'
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 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
+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:
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
+The distribution that is being prepared or packaged take precedence when
+defining distdefs that were specifically undefined in the inherited
+distribution. This means that if the inherited distribution specifically
+undefines a distdefs but the inheriting distribution (one being prepared
+or packaged) specifically 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 specifically 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.
template
@end example
-When set, the distribution is a template distribution. Templates are
-special distributions which cannot be prepared or packaged with Autodist.
-Templates can only be inherited. Usually, templates are used to define a
-common template distribution for other distributions. Templates may set
-distdefs, undefines, includes, excludes and noprocesses. A large software
-project could have several distributions that share a common base. In
-this case defining the common base as a template distribution and then
+When set, the distribution is a template distribution. Templates are
+special distributions which cannot be prepared or packaged with Autodist.
+Templates can only be inherited. Usually, templates are used to define a
+common template distribution for other distributions. Templates may set
+distdefs, undefines, includes, excludes and noprocesses. A large software
+project could have several distributions that share a common base. In
+this case defining the common base as a template distribution and then
inheriting that distribution makes it easier to manage the distfiles.
@example
@section Directive: noprocess <filename> [...]
-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
+The 'noprocess' directive can be used to tell Autodist specifically 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:
noprocess apps/foo/
@end example
-Autodist will not process 'autodist.texi' file, and any files and
+Autodist will not process 'autodist.texi' file, and any files and
directories under 'apps/foo/'.
-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.
'pre-hook' hook will be run immediately after invoking Autodist to start
preparing the source tree for configuration and compilation (@pxref{Preparing source tree, , , , }).
-The scripts will get three (3) command line arguments when Autodist
-executes the script: distribution name, distribution version and package
-name of distribution. The script may use these arguments if it needs them.
+The scripts will get at least three (3) command line arguments when
+Autodist executes the script: distribution name, distribution version and
+package name of distribution. The script may use these arguments if it
+needs them. If user passed any extra parameters to autodist in the
+command line they will also be passed to the script as last arguments.
@section Directive: post-hook <filename> [...]
preparing the source three for configuration and compilation (@pxref{Preparing source tree, , , , }). The Autodist will exit after it has run the
'post-hook' scripts.
-The scripts will get three (3) command line arguments when Autodist
-executes the script: distribution name, distribution version and package
-name of distribution. The script may use these arguments if it needs them.
+The scripts will get at least three (3) command line arguments when
+Autodist executes the script: distribution name, distribution version and
+package name of distribution. The script may use these arguments if it
+needs them. If user passed any extra parameters to autodist in the
+command line they will also be passed to the script as last arguments.
@section Directive: pre-process-dist-hook <filename> [...]
will be run immediately after the Autodist has created the distribution
directory but has not yet started any distribution processing.
-The scripts will get four (4) command line arguments when Autodist
-executes the script: distribution name, distribution version, package
-name of distribution and destination distribution directory name. The
-script may use these arguments if it needs them.
+The scripts will get at least four (4) command line arguments when
+Autodist executes the script: distribution name, distribution version,
+package name of distribution and destination distribution directory name.
+The script may use these arguments if it needs them. If user passed any
+extra parameters to autodist in the command line they will also be passed
+to the script as last arguments.
@section Directive: post-process-dist-hook <filename> [...]
has finished processing the destination distribution directory but has not
yet created the distribution package.
-The scripts will get four (4) command line arguments when Autodist
-executes the script: distribution name, distribution version, package
-name of distribution and destination distribution directory name. The
-script may use these arguments if it needs them.
+The scripts will get at least four (4) command line arguments when
+Autodist executes the script: distribution name, distribution version,
+package name of distribution and destination distribution directory name.
+The script may use these arguments if it needs them. If user passed any
+extra parameters to autodist in the command line they will also be passed
+to the script as last arguments.
@section Directive: pre-dist-hook <filename> [...]
the Autodist has started distribution creation, but has not yet created
the distribution directory. This hook is run before 'pre-process-dist-hook'.
-The scripts will get four (4) command line arguments when Autodist
-executes the script: distribution name, distribution version, package
-name of distribution and destination distribution directory name. The
-script may use these arguments if it needs them.
+The scripts will get at least four (4) command line arguments when
+Autodist executes the script: distribution name, distribution version,
+package name of distribution and destination distribution directory name.
+The script may use these arguments if it needs them. If user passed any
+extra parameters to autodist in the command line they will also be passed
+to the script as last arguments.
@section Directive: post-dist-hook <filename> [...]
immediately after the Autodist has finished creating the distribution
package. This is the last hook Autodist runs.
-The scripts will get four (4) command line arguments when Autodist
-executes the script: distribution name, distribution version, package
-name of distribution and destination distribution directory name. The
-script may use these arguments if it needs them.
+The scripts will get at least four (4) command line arguments when
+Autodist executes the script: distribution name, distribution version,
+package name of distribution and destination distribution directory name.
+The script may use these arguments if it needs them. If user passed any
+extra parameters to autodist in the command line they will also be passed
+to the script as last arguments.
@section Running hooks
@end defmac
-@defmac AD_ENABLE_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.
+@defmac AD_DISABLE_DEPENDENCIES
-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.
+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.
-Current Autodist version does not support dependencies in 'configure.ad'
-files, only in 'Makefile.ad' files.
+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' and 'configure.ad' files, which are not
+delivered to distribution.
@end defmac
@menu
client \
@end example
-The lines defined specificly for the SILC_DIST_TOOLKIT, which in our
-example was not defined, were removed. Also lines that specificly
+The lines defined specifically for the SILC_DIST_TOOLKIT, which in our
+example was not defined, were removed. Also lines that specifically
expected certain distdefs not to be defined ('#ifndef') were removed.
(Note the last remaining '\' in example above would be removed by the
Autodist automatically to avoid errors with Automake.)
.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.
+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:
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
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
'./configure' and continue to compile with 'make'.
If you do not wish to use the 'default' distribution, or you wish
-to do the development in a tree specificly prepared for some specific
+to do the development in a tree specifically prepared for some specific
distribution, or you are preparing to create a new distribution package,
you will need to run the Autodist with the distribution you wish to
prepare.
your sources the preprocessor, however, will respect your distdef
conditionals inside your source files if you '#include' the distdef header
file. This way, even the compiled binaries will be compiled for that
-distribution, even though the source files has not yet been processed
+distribution, even though the source files have not yet been processed
by the Autodist. Rest of the files in the distribution will be processed
when you create the actual distribution package. It is guaranteed that
the distribution you have prepared will behave in your source tree exactly
'tar.bz2', 'tar.Z' and '.zip' packages. Current version of Autodist does
not support archiving with 'shar'.
-If you wish to run additional processing for your distributions when they
-are being packaged you may set 'pre-process-dist-hook',
-'post-process-dist-hook, 'pre-dist-hook' and/or 'post-dist-hook' in your
-distribution file. Also note that any hooks provided by Automake in
+If you wish to run additional processing for your distributions when they
+are being packaged you may set 'pre-process-dist-hook',
+'post-process-dist-hook, 'pre-dist-hook' and/or 'post-dist-hook' in your
+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
+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.
define _DIST_NOMAD
define _DIST_NOMAD_LIB
undef _DIST_CRYPTO
+pre-dist-hook nomad-pre-dist-hook
@end example
@example
This will prepare your source tree for configuration and compilation. Since
the 'default' distribution inherits all distributions your development
source tree will have all of them included. If you do not want to do this
-then don't inherit them in the 'default', but run the autodist specificly
+then don't inherit them in the 'default', but run the autodist specifically
for the distributions, for example:
@example
Since all the distributions inherit the 'common' distribution they get
all the distdefs that the 'common' defines. In this example various distdefs
-has been defined. You would use them in your code and in your makefiles
+have been defined. You would use them in your code and in your makefiles
to control various things. For example, let's say the 'common' distdefs
control what directories distributions have. An example 'Makefile.ad'
file:
@example
autodist libfoozbar 1.0.5
makedist
+@end example
+
+Nomad has also an RPM .spec file that you have written and a pre-dist-hook
+that will replace the RPM release version with sed tool with the one you
+give as extra parameter to autodist:
-autodist nomad 2.0
+@example
+autodist nomad 2.0 0.fc7
makedist
@end example
-The end results are: 'libfoozbar-1.0.5.tar.gz' and 'nomad-2.0.tar.gz'.
+The end results are: 'libfoozbar-1.0.5.tar.gz' and 'nomad-2.0.tar.gz', and
+the RPM will have a release version '0.fc7' when you compile the RPM. Any
+extra parameter that you pass to autodist will be delivered to your hook
+scripts.
+
+@node Download
+@chapter Download
+
+Download latest version of Autodist at
+@url{http://silcnet.org/download/autodist/}
@page
-@contents
@bye
projects / autodist.git / blobdiff