1 \input texinfo @c -*-texinfo-*-
3 @setfilename autodist.info
12 This manual is for SILC Autodist (version @value{VERSION},
13 @value{UPDATED}), a program which is used to manage and create source
16 Copyright @copyright{} 2004 - 2005 Pekka Riikonen, SILC Project
19 Permission is granted to copy, distribute and/or modify this document
20 under the terms of the @acronym{GNU} Free Documentation License,
21 Version 1.2 or any later version published by the Free Software
22 Foundation; with no Invariant Sections, with the Front-Cover texts
23 being ``A @acronym{GNU} Manual,'' and with the Back-Cover Texts as in
24 (a) below. A copy of the license is included in the section entitled
25 ``@acronym{GNU} Free Documentation License.''
27 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and
28 modify this @acronym{GNU} Manual, like @acronym{GNU} software. Copies
29 published by the Free Software Foundation raise funds for
30 @acronym{GNU} development.''
34 @dircategory Software development
36 * autodist: (autodist). Managing and creating source distributions.
39 @dircategory Individual utilities
41 * makedist: (autodist)Invoking makedist. Creating distribution
46 @subtitle For version @value{VERSION}, @value{UPDATED}
47 @author Pekka Riikonen
49 @vskip 0pt plus 1filll
55 @comment node-name, next, previous, up
61 * Introduction:: Purpose of Autodist
62 * Integrating Autodist:: Integrating Autodist into your project
63 * Invoking Autodist:: Running Autodist
64 * Examples:: Examples using Autodist
67 --- The Detailed Node Listing ---
71 * Motivation:: Reasons for using Autodist
75 * Creating distdir:: Creating distributions directory
76 * autodist.conf:: Configuring Autodist
77 * Creating new distribution:: Adding new distribution
78 * Distribution file format:: Detailed document for distfile format
79 * configure.ad files:: configure script for creating configure.ac
80 * Makefile.ad files:: Makefile.ad for creating Makefile.am
81 * Other .ad files:: Other files with .ad suffix
82 * Distdefines:: Using distdefs in files
86 * Preparing source tree:: Preparing source tree with Autodist
87 * Creating distribution:: Creating distribution with Autodist
91 * Single distribution tree:: Single distribution example
92 * Multiple distribution tree:: Multiple distributions example
101 @chapter Introduction
103 The Autodist is a source distribution management system that allows
104 powerful mechanisms to define what is included in and excluded from a
105 distribution, and what license the distribution is released under. It is
106 also used to create the actual distribution source packages. Autodist
107 allows distribution management in file, directory and file content level.
108 Different distributions may include different portions of files, for
109 example, excluding certain features from certain distributions. It is
110 always guaranteed that anything not defined for the distribution, is
111 removed automatically (files, file content, directories), thus ensuring
112 that nothing is accidentally included in the distribution.
114 The Autodist creates 'Makefile.am' files from 'Makefile.ad' files and
115 'configure.ac' file from one or more 'configure.ad' files. Any other file
116 ending with '.ad' suffix will also be processed. The processed file will
117 have the '.ad' suffix removed (@pxref{Preparing source tree, , , , }).
118 Autodist also creates and packages the distribution using common GNU
119 distribution creation process, specificly `make dist'. Autodist, however,
120 controls this process and during packaging phase the Autodist processes
121 all files in the distribution (other than '*.ad' files, which has already
122 been processed earlier by Autodist). The resulted package is a processed
123 source distribution package, processed according to the rules specified
124 in the distribution file(s) (@pxref{Creating distribution, , , , }).
126 Any file in the source tree may use distdefs (distribution defines (@pxref{Distdefines, , , , })) which are defined in the distributions. When distribution
127 is packaged only the files, directories and file content that is either
128 outside of any distdef, or inside the defined distdefs will be included
129 in the distribution. Any other file, directory or content in the file
130 will be removed. It is guaranteed, if a file, a directory or a piece of
131 file content is not inside a defined distdef it will not be delivered to
134 Any file, 'Makefile.am', 'configure.ac', or source file processed with
135 Autodist is always compliant with the tools needed to process them. All
136 files can also be processed with the corresponding tools even before
137 processing them with Autodist. This makes it possible, for example, to
138 compile sources before they have been processed, and undefined lines
139 are removed. The distdefs are respected in source files by the
142 Autodist is not a binary packaging system. It is specificly used to
143 create source distributions. A binary packaging system, however can be
144 hooked to the distribution creation process, if needed.
147 * Motivation:: Reasons for using Autodist
152 @section Reasons for using Autodist
154 Autodist is closely related to the Autoconf and Automake tools, and
155 complements the features Autoconf and Automake provides. It is especially
156 targeted into circumstances where multiple distributions are created from
157 one source tree. The Autoconf and Automake environment is mainly designed
158 for one distribution (one application) per one source tree situations.
159 Autodist provides mechanisms to create all kinds of distributions that can
160 be created from one source tree. To be able to use Autodist, the Autoconf
161 and Automake must be installed into the system (@pxref{Integrating Autodist, , , , }).
162 Autoconf version must be at least 2.52g.
164 Small software projects usually do very well with Autoconf and Automake
165 and their distribution management features. Often these projects do not
166 need Autodist, though they can benefit from it. However, if your software
167 project is large, you need to create multiple distributions from one source
168 tree, you have complex licensing terms for different distributions, you
169 have different target users or customers that may require different
170 feature set or licenses in different distributions, you have need to
171 continue concurrent development in the main source tree and still be able
172 to create stable distributions, and/or you have need to control file
173 content in different distributions (to avoid distributing code or features
174 that aren't supposed to be distributed, or to avoid leaking information
175 to your competitors on what new features you are working on), then Autodist
176 is a tool you may find usefull.
178 The motivation behind Autodist stems from need to be able to create
179 multiple distributions from one large source tree in a precise and
180 controllable manner, and guarantee that anything that is not part of the
181 distribution is removed from the distribution. The Autoconf and Automake
182 provides mere basic control what is included in and excluded from
183 distributions and how the distributions are created. They also do not
184 provide mechanism to define different licensing conditions for different
185 distributions, or changing the license automatically for different user
186 or customer purposes. Many large software projects, companies and
187 corporations have commonly been using Autoconf and Automake tools, but
188 have had the need to create their own ad-hoc mechanisms to control
189 distribution creation. The Autodist attempts to provide a tool that any
190 size software project can effectively use to manage their distributions.
192 Without a tool like Autodist, large software projects usually has to be
193 split into separate source trees, which may not always be possible because
194 they may share large portions of common code (which may further make
195 concurrent development of the applications hard), or multiple Autoconf and
196 Automake environments (multiple configure scripts) needs to be created
197 in one source tree. In this case the source tree usually gets very
198 complicated and controlling what is compiled and what is included in
199 distributions becomes harder, especially when different parts code is shared
200 between applications and libraries.
203 @node Integrating Autodist
204 @chapter Integrating Autodist
206 Integrating Autodist into existing software project can be a very simple
207 task or a fairly complicated task. It depends on the size and complexity
208 of the software project. Generally speaking, integrating Autodist into
209 software project is fairly straightforward process:
211 1. The distributions directory and 'default' distribution are created
213 2. The 'configure.ad' is created
215 3. If needed, 'Makefile.ad' file(s) are created
217 After this the Autodist can already be used to prepare the source tree
218 for configuration and compilation (@pxref{Preparing source tree, , , , }).
219 Adding a new distribution would then allow the actual distribution
222 If the software project has had own ad-hoc distribution system already in
223 place, it may take some work to move from that system into the Autodist.
224 If there are multiple applications and distributions created from the
225 source tree, the distributions and distribution defines for them need to
226 be created. While this may be unthankful job, it only needs to be done
229 Integrating Autodist into a new software project is a very simple task as
230 renaming 'configure.ac' and possibly 'Makefile.am' files are not required,
231 as they may not exist yet.
235 * Creating distdir:: Creating distributions directory
236 * autodist.conf:: Configuring Autodist
237 * Creating new distribution:: Adding new distribution
238 * Distribution file format:: Detailed document for distfile format
239 * configure.ad files:: configure script for creating configure.ac
240 * Makefile.ad files:: Makefile.ad for creating Makefile.am
241 * Other .ad files:: Other files with .ad suffix
242 * Distdefines:: Using distdefs in files
246 @node Creating distdir
247 @section Creating distributions directory
249 The distributions directory is 'distdir', which is expected to be
250 located in the root of the source tree. This directory will hold all
251 the distribution files, and the Autodist configuration file 'autodist.conf' (@pxref{autodist.conf, , , , }).
252 If this directory does not exist it can be created with the Autodist.
258 This will create the 'distdir' and copy the default 'autodist.conf'
259 configuration file and the 'default' distribution into the directory.
260 The 'default' distribution will be used by default by the Autodist
261 unless other distribution is specified.
263 After this the Autodist has effectively been integrated into the
264 software project. However, usually after this, one would create new
265 distributions, the 'configure.ad' and possibly 'Makefile.ad' file(s).
266 Without 'configure.ad' file a distribution package cannot be created.
267 However, even without 'configure.ad' file the source tree can be
268 prepared for configuration and compilation (@pxref{Preparing source tree, , , , }).
271 * autodist.conf:: Configuring Autodist
276 @section Configuring Autodist
278 After the Autodist has been integrated into the software by creating
279 the 'distdir', the 'autodist.conf' configuration file was added to the
280 'distdir' also. Usually software projects will want to modify some of
281 the 'autodist.conf' options, mainly specifying the distdef prefix.
283 The 'autodist.conf' is a text file. The following options are available
291 By default the distdef prefix is '_DIST_'. To add own software package
292 specific prefix the 'DISTPREFIX' can be defined.
299 Will set the distdef prefix as 'SILC_DIST_'.
303 DISTDEFS="distdefs.h"
306 The 'DISTDEFS' option specifies the file name of the distdef header file
307 which Autodist will create. The software project should '#include' the
308 header file in order for the preprocessor to respect the distdef
309 conditionals (@pxref{Distdefines, , , , }). By default the file name
310 is 'distdefs.h' and is created at the root of source tree. Other location
311 may be specified if needed.
315 DISTDEFS="include/distdefs.h"
323 The 'ACLOCAL' specifies the location of the 'aclocal' tool. If Autodist
324 should not run 'aclocal' this option may be removed or set to empty value.
325 User need to then run it manually.
329 AUTOHEADER="autoheader"
332 The 'AUTOHEADER' specifies the location of the 'autoheader' tool. If
333 Autodist should not run 'autoheader' this option may be removed or set
334 to empty value. User need to then run it manually.
340 The 'AUTOCONF' specifies the location of the 'autoconf' tool. If
341 Autodist should not run 'autoconf' this option may be removed or set
342 to empty value. User need to then run it manually.
346 AUTOMAKE="automake -a -c"
349 The 'AUTOMAKE' specifies the location of the 'automake' tool. If
350 Autodist should not run 'automake' this option may be removed or set
351 to empty value. User need to then run it manually. By default, the
352 '-a' and '-c' options are given to 'automake' to add any missing required
357 LIBTOOLIZE="libtoolize --automake -c"
360 The 'LIBTOOLIZE' specifies the location of the 'libtoolize' tool.
361 This option should be removed or ste to empty value if 'libtool' is not
362 used in the source tree.
369 The 'MAKE' specifies the location of the 'make' program. This option must
370 be set to valid value in order to create distributions.
374 * Creating new distribution:: Adding new distribution
378 @node Creating new distribution
379 @section Creating new distribution
381 After the Autodist has been integrated into the software project by
382 creating the 'distdir' and 'default' distribution, the source tree
383 can be prepared for configuration and compilation (@pxref{Preparing source tree, , , , }). However, the 'default' distribution should be used only as
384 a development distribution. Usually it is used to prepare the raw source
385 tree (such as a tree just checkout
386 from CVS) for configuration and compilation. By default, the 'default'
387 distribution cannot be packaged. However, if the software project is
388 small (one distribution), it may be convenient to edit the 'default'
389 distribution to be as the distribution that is packaged from the source
390 tree. In software project where multiple distributions are created using
391 the 'default' only as a development distribution is recommended. The
392 real distributions should be defined as separate distributions.
394 Creating a new distribution is a simple process. Each distribution
395 is placed in the 'distdir' and the file name of the distribution file is
396 used to reference to it. By default, the distribution name is the
397 file name of the distribution file. The actual distribution file is
398 a simple text file with various directives that define the distribution.
400 If the 'default' distribution is used as a development distribution it
401 might be desired to inherit some or all of the created distributions in
402 it, so that development becomes possible with the 'default' distribution.
403 Adding 'inherit' directive into the 'distdir/default' will inherit the
404 specified distribution.
408 * Distribution file format:: Detailed document for distfile format
412 @node Distribution file format
413 @section Distribution file format in detail
415 The distribution file, or distfile from now on, defines your distribution,
416 distribution defines, options, included and excluded files and
417 directories, license, and additional processing. Each distribution is
418 defined in a separate file and the distributions are referenced by
421 The distfile is a text file that contains various directives that define
422 the actual distribution. Lines starting with '#' are considered comments
426 @section Directive: name <name>
428 The 'name' directive defines the name of the distribution. It is optional
429 directive, and if omitted the distribution name will be the name of the
437 Will set your distribution name as 'Foo Application'.
440 @section Directive: package <package>
442 The 'package' directive defines the name of the distribution package. It is
443 optional directive, and if omitted the distribution package name will
444 be the name of the distribution, if defined, or if omitted, then the name
445 of the distfile. If this directive is omitted then normal GNU convention
446 is used to decide the package name, derived from the distribution name.
453 Will create distribution packages named, for example, as
454 'foo-client-1.0.tar.gz'.
457 @section Directive: bug-report <email address>
459 The 'bug-report' directive can be used to define the email address where
460 the bug-reports for the distribution should be sent. The directive is
461 optional. The 'bug-report' email address will be set for the Autoconf
462 which will deliver it via AC_INIT macro.
465 @section Directive: license <filename>
467 The 'license' directive can be used to define the license file for the
468 distribution. This directive is optional. The license file will be
469 copied into the distribution in the name 'COPYING'. If the 'COPYING'
470 file already exist it will be replaced.
477 Will include the file 'license/GPL' into the distribution in the file
481 @section Directive: license-header <current-license> <new-license>
483 The 'license-header' can be used to re-license your files into a new
484 license. This directive is optional. There may be zero or more
485 'license-header' directives in distribution. The 'license-header'
486 directive will compare the license header that usually appear at the
487 start of a file to the <current-license>. If it matches it will
488 be replaced with the <new-license>. The license header in the file
489 will be replaced and the file will have effectively been re-licensed.
493 license-header license/BSD-header license/GPL-header
496 Will replace all appearances of the license header in 'license/BSD-header'
497 file to the license header in 'license/GPL-header' in any file in the
498 distribution. Note that, the header change will be performed when
499 the distribution is packaged (@pxref{Creating distribution, , , , }).
501 With 'license-header' directive you may initially set your files in the
502 source tree into what ever license you prefer. However, if you need to
503 re-license parts of the source tree in certain distributions the
504 'license-header' will achieve this automatically. For example, suppose
505 one wants to create two different versions of a library distribution, with
506 different feature sets, in two different licenses.
508 There are several limitations in the current implementation of Autodist
509 with the 'license-header' directive:
511 First limitation is that the header files must have equal amount of lines.
512 If the new header file has fewer lines that the current header file, all
513 of the lines from the current header will not be replaced. If the new header
514 has fewer lines, empty lines must be added to it. If the new header file
515 has more lines than the current header file, the extra lines will not appear
516 in the replaced header. Basic rule is to always make sure the header file
517 has equal amount of lines in them.
519 Second limitation is in indentation of the header files. It is suggested,
520 though not mandatory, that the header files have the same indentation as
521 is commonly used in the source tree; if the license header text in a file
522 starts at the second character instead of at the start of the line, then
523 the header file should start the license text at the second character also.
524 If same indentation is not used the appearance of the replaced header
525 may not be perfect. While this is a cosmetic issue, one still to remember.
527 Example current header:
530 This program is free software; you can redistribute it and/or modify
531 it under the terms of the GNU General Public License as published by
532 the Free Software Foundation; version 2 of the License.
534 This program is distributed in the hope that it will be useful,
535 but WITHOUT ANY WARRANTY; without even the implied warranty of
536 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
537 GNU General Public License for more details.
546 Redistribution and use in source and binary forms, with or without
547 modification, are permitted provided that the conditions listed in the
548 COPYING file are met.
555 In this example, if the text in the current header file is found in any
556 file in the distribution it will be replaced with the new header file.
557 Notice that, both header files has same amount of lines (8 lines).
559 Note that, the current header must match exactly the header used in
560 files. Otherwise the replacement will not be complete.
563 @section Directive: inherit <distfile>
565 The Autodist provides inheritance of distributions. The 'inherit'
566 directive is used to define the distribution which will be inherited
567 into the distribution. The <distfile> specifies the name of the
568 inherited distribution. If the distribution cannot be inherited Autodist
571 The 'inherit' will inherit the following information from the distribution:
572 distdefs, undefines, includes, excludes and noprocess. Other information
573 will not be inherited. If the inherited distribution inherits other
574 distributions, they will also be inherited automatically. User should be
575 careful when inheriting distributions as it may be possible to create an
576 infinite recursion. The Autodist would allow for this and not detect this
577 error. Zero or more 'inherit' directives may be set for distribution.
586 Will inherit distributions 'common', 'client' and 'toolkit' into this
587 distribution. All distdefs, undefines, includes, excludes and noprocesses
588 from these distributions are now also part this distribution.
591 @section Directive: define <symbol>
593 The 'define' directive is used to define the distdef symbols for the
594 distribution. This directive is optional, however, all distributions
595 should define at least one distdef so that the distribution may be
596 controlled with the distdef conditionals in files in the source tree (@pxref{Distdefines, , , , }). By default, the distdef prefix is '_DIST_'. Many
597 software projects will want to set their own prefix for the distdefs
598 for consistency. The prefix may be defined in the 'autodist.conf' file
599 (@pxref{autodist.conf, , , , }).
604 define _DIST_FEATURE_X
605 define _DIST_LIBRARY_Y
608 Will define the following distdefs for the distribution: '_DIST_FOO',
609 '_DIST_FEATURE_X' and '_DIST_LIBRARY_Y'. These distdefs may then be
610 used in the source tree and source code to control what is included in
611 or excluded from this distribution.
614 @section Directive: undef <symbol>
616 The 'undef' directive may be used to explicitly undefine a distdef.
617 When inheriting distributions it may be desired to be able undefine
618 certain distdefs. This directive is optional.
622 undef _DIST_FEATURE_Y
625 Will undefine '_DIST_FEATURE_Y' distdef. This distdef will not be part
626 of this distribution anymore, even if it is defined in some inherited
630 @section Directive: option <option> [...]
632 The 'option' directive is used to define various options for the
633 distribution. The options can change the behavior of the distribution.
634 This directive is optional. One or more options may be defined in one
635 'option' directive. Zero or more 'option' directives may be set for
636 distribution. The following options are available.
642 When set, the distribution is a template distribution. Templates are
643 special distributions which cannot be prepared or packaged with Autodist.
644 Templates can only be inherited. Usually, templates are used to define a
645 common template distribution for other distributions. Templates may set
646 distdefs, undefines, includes and excludes. A large software project
647 could have several distributions that share a common base. In this case
648 defining the common base as a template distribution and then inheriting
649 that distribution makes it easier to manage the distfiles.
655 Distributions with the 'no-dist' option are similar to templates, except
656 that they can be prepared with Autodist, but they cannot be packaged.
657 These are usually used as a common development distribution, such as the
658 'default' distribution created with 'autodist -i'.
664 If this option is set to normal distributions or distributions with
665 'no-dist' option, the distribution cannot be inherited. For template
666 this option has no effect. If distribution with this option is inherited
667 the Autodist will give an error.
670 @section Directive: include <source> [<destination>]
672 The 'include' directive can be used to include files or directories into
673 the distribution. Sometimes it may be desired to specify included
674 files and directories in distribution instead of Makefile.am and
675 EXTRA_DIST, especially if there are many distributions that need to
676 include specific files and directories. While it would be possible
677 to define them in Makefile.ad and use distdef conditionals to define
678 which will be included in which distribution, if there are many different
679 distributions it may pollute the Makefile.ad unnecessarily.
681 This directive is optional. The <source> may be a single file, a single
682 directory or a regular expression which will match several files and/or
683 directories. The <destination> is optional. If it is omitted then
684 the <source> will be copied into the same location in the distribution.
685 If the <destination> is provided the <source> will be copied into the
690 include apps/foobar/README README
692 include lib/libfoobar lib/foobarlib
694 include scripts/foobar.sh foo.sh
697 Will include the file 'apps/foobar/README' into the top distribution
698 directory in the name 'README', the directory 'lib/libfoo' into same
699 location in distribution, the directory 'lib/libfoobar' into
700 'lib/foobarlib' changing the name of the directory into 'foobarlib',
701 the files and directories that match 'doc/foo*' into the same locations
702 in distribution, and finally the 'scripts/foobar.sh' into the top
703 distribution directory changing the name of the file into 'foo.sh'.
705 Note that, the 'include' directives will be processed by the Autodist
706 only when the distribution is packaged (@pxref{Creating distribution, , , , }). When preparing the source
707 tree for configuration and compilation (@pxref{Preparing source tree, , , , })
708 the 'include' directives are ignored. This is same behavior as with
709 Makefile.am's EXTRA_DIST.
711 If the included file or directory does not exist the Autodist will
712 give an error and stop the distribution creation. If the destination
713 file exist, it will be replaced with the included file. If the
714 destination directory already exists, the contents of the source
715 directory will be copied into the directory. Note that, the directory
716 will not be copied into the directory; if the <destination> is specified,
717 also the name of the <source> file or directory must be specified,
718 otherwise the 'include' will change the name into the one specified.
722 include lib/libfoo lib
725 In this example the 'lib/libfoo' will be included as 'lib'. If the 'lib'
726 already exists, this effectively copies the contents of the 'lib/libfoo'
727 into 'lib'. In order to include the directory with same name, the
728 name must be specified.
732 include lib/libfoo lib/libfoo
733 include lib/foobar new_lib/foobar
736 This will include the 'lib/libfoo' into 'lib/libfoo' in distribution,
737 and 'lib/foobar' into 'new_lib/foobar' in distribution.
740 @section Directive: exclude <filename> [...]
742 The 'exclude' directive can be used to exclude files and directories from
743 the distribution. This directive is optional. This directive is
744 processed before processing the 'include' directive. The <filename>
745 can be a single file, a single directory or a regular expression that
746 will match several files and/or directories.
754 This will exclude the file 'README' and anything that match 'doc/client*'.
757 @section Directive: noprocess <filename> [...]
759 The 'noprocess' directive can be used to tell Autodist specificly not to
760 process a file. The Autodist will not process the file during
761 preparation or during distribution packaging. This directive is optional.
762 One or more file can be specified in the 'noprocess' directive. Zero or
763 more 'noprocess' directives can be used in distribution. The <filename>
764 can be a single file, a single directory or a regular expression that
765 will match several files and/or directories. If directory is specified
766 then all files inside the directory will not be processed.
770 noprocess autodist.texi
773 Autodist will not process 'autodist.texi' file.
775 Note that, 'noprocess' directive cannot be used to disallow processing
776 of any file with '.ad' suffix.
779 @section Directive: pre-hook <filename> [...]
781 The 'pre-hook' directive can be used define additional scripts that
782 will be run before the source tree is prepared. This directive is
783 optional. One or more scripts may be defined in one 'pre-hook' directive.
784 Zero or more 'pre-hook' directives may be set for distribution. The
785 'pre-hook' hook will be run immediately after invoking Autodist to start
786 preparing the source tree for configuration and compilation (@pxref{Preparing source tree, , , , }).
788 The scripts will get three (3) command line arguments when Autodist
789 executes the script: distribution name, distribution version and package
790 name of distribution. The script may use these arguments if it needs them.
793 @section Directive: post-hook <filename> [...]
795 The 'post-hook' directive can be used define additional scripts that
796 will be run after the source tree is prepared. This directive is
797 optional. One or more scripts may be defined in one 'post-hook' directive.
798 Zero or more 'post-hook' directives may be set for distribution. The
799 'post-hook' hook will be run immediately after the Autodist has finished
800 preparing the source three for configuration and compilation (@pxref{Preparing source tree, , , , }). The Autodist will exit after it has run the
803 The scripts will get three (3) command line arguments when Autodist
804 executes the script: distribution name, distribution version and package
805 name of distribution. The script may use these arguments if it needs them.
808 @section Directive: pre-process-dist-hook <filename> [...]
810 The 'pre-process-dist-hook' directive can be used define additional
811 scripts that will be run when Autodist has started distribution creation.
812 This directive is optional. One or more scripts may be defined in one
813 'pre-process-dist-hook' directive. Zero or more 'pre-process-dist-hook'
814 directives may be set for distribution. The 'pre-process-dist-hook' hook
815 will be run immediately after the Autodist has created the distribution
816 directory but has not yet started any distribution processing.
818 The scripts will get four (4) command line arguments when Autodist
819 executes the script: distribution name, distribution version, package
820 name of distribution and destination distribution directory name. The
821 script may use these arguments if it needs them.
824 @section Directive: post-process-dist-hook <filename> [...]
826 The 'post-process-dist-hook' directive can be used define additional
827 scripts that will be run when Autodist has finished distribution
828 processing. This directive is optional. One or more scripts may be
829 defined in one 'post-process-dist-hook' directive. Zero or more
830 'post-process-dist-hook' directives may be set for distribution. The
831 'post-process-dist-hook' hook will be run immediately after the Autodist
832 has finished processing the destination distribution directory but has not
833 yet created the distribution package.
835 The scripts will get four (4) command line arguments when Autodist
836 executes the script: distribution name, distribution version, package
837 name of distribution and destination distribution directory name. The
838 script may use these arguments if it needs them.
841 @section Directive: pre-dist-hook <filename> [...]
843 The 'pre-dist-hook' directive can be used define additional scripts that
844 will be run when Autodist has started distribution creation. This directive
845 is optional. One or more scripts may be defined in one 'pre-dist-hook'
846 directive. Zero or more 'pre-dist-hook' directives may be set for
847 distribution. The 'pre-dist-hook' hook will be run immediately after
848 the Autodist has started distribution creation, but has not yet created
849 the distribution directory. This hook is run before 'pre-process-dist-hook'.
851 The scripts will get four (4) command line arguments when Autodist
852 executes the script: distribution name, distribution version, package
853 name of distribution and destination distribution directory name. The
854 script may use these arguments if it needs them.
857 @section Directive: post-dist-hook <filename> [...]
859 The 'post-dist-hook' directive can be used define additional scripts that
860 will be run when Autodist has finished distribution creation. This
861 directive is optional. One or more scripts may be defined in one
862 'post-dist-hook' directive. Zero or more 'post-dist-hook' directives may
863 be set for distribution. The 'post-dist-hook' hook will be run
864 immediately after the Autodist has finished creating the distribution
865 package. This is the last hook Autodist runs.
867 The scripts will get four (4) command line arguments when Autodist
868 executes the script: distribution name, distribution version, package
869 name of distribution and destination distribution directory name. The
870 script may use these arguments if it needs them.
873 @section Running hooks
875 The Autodist runs the hooks in the following order:
877 Preparing source tree for configuration and compilation:
883 Creating distribution:
886 pre-process-dist-hook
887 post-process-dist-hook
891 When creating distribution the 'pre-hook' and 'post-hook' are not run.
894 @section Example distfile
896 The following is a simple distfile example. The example assumes that the
897 distdefs prefix is 'SILC'.
900 # SILC Client distribution
903 bug-report silc-client-bugs@@silcnet.org
905 inherit platform-unix
906 inherit platform-win32
907 define SILC_DIST_CLIENT
908 define SILC_DIST_CLIENTLIB
909 define SILC_DIST_IRSSI
912 pre-hook scripts/client-pre-run
913 post-process-dist-hook scripts/client-post-process
914 post-dist-hook scripts/client-post-dist-bin
918 * configure.ad files:: configure script for creating configure.ac
922 @node configure.ad files
923 @section configure.ad files
925 Autodist creates 'configure.ac' file from the 'configure.ad' file. The
926 'configure.ad' file is a rather normal 'configure.ac' except that it accepts
927 also Autodist macros. Autodist also supports configure script fragments,
928 also named as 'configure.ad'. Any 'configure.ad' file in the source tree
929 can be incorporated into the the top 'configure.ad' file. Sometimes it may
930 be useful to split a large configure script into smaller fragments.
931 Especially in multi distribution system where certain libraries or features
932 can be excluded from certain distributions it may be useful to handle
933 their configuration from a configure fragment. If the library is
934 excluded then also its configuration can be excluded.
936 If the software project already has a 'configure.ac' or 'configure.in'
937 file, the 'configure.ad' can be created by simply renaming the current
938 file to 'configure.ad'. In this case the current configure script
939 must be edited to support Autodist. This is done by replacing the
940 'AC_INIT' to 'AD_INIT'. After specifying the 'AD_INIT' as the first
941 macro in the 'configure.ad', the Autodist support has been fully
942 integrated into the software project.
944 If your software project is going to use configure fragments, then
945 also Autodist macro 'AD_INCLUDE_CONFIGURE' must be used. Autodist will
946 automatically combine the fragments with the top 'configure.ac' script.
947 To exclude a 'configure.ad' fragment from a distribution use the distdef
948 conditionals inside the 'configure.ad' fragment file. If the distdef is
949 not defined the fragment will be excluded automatically.
951 The following macros are available in current Autodist version.
955 The 'AD_INIT' macro is used in place of Autoconf macro 'AC_INIT'. The
956 'AD_INIT' must be the first macro in the 'configure.ad', just like the
957 'AC_INIT' macro in 'configure.ac'. The AD_INIT macro is used to deliver
958 the distribution names, distribution version, package name and bug-report
959 email address to the 'configure.ac' file that Autodist will create.
960 The 'AC_INIT' macro must not be used in 'configure.ad' file.
962 This macro is mandatory and Autodist will exit with error if it is not
963 specified in 'configure.ad'. This macro has no arguments.
967 @defmac AD_INCLUDE_CONFIGURE
969 This macro is used to tell Autodist that it should include any other
970 'configure.ad' fragment that is found from the source tree into the
971 top 'configure.ad' file. Note that, the 'configure.ad' fragments will
972 be incorporated at the location where this macro is used in the
973 'configure.ad'. Usually this macro is placed just before the Autoconf
974 macro 'AC_OUTPUT'. This macro has no arguments.
976 Note that, the 'configure.ad' fragments are not real full featured
977 configure scripts. They must not use 'AD_INIT', 'AD_INCLUDE_CONFIGURE',
978 'AC_INIT' or any other initialization macros.
983 * Makefile.ad files:: Makefile.ad for creating Makefile.am
987 @node Makefile.ad files
988 @section Makefile.ad files
990 Autodist creates 'Makefile.am' files from 'Makefile.ad' files. A software
991 project do not need to use 'Makefile.ad' files if there is no need to
992 use distdef conditionals inside makefiles. Usually a multi distribution
993 software project, however will need to define certain things to different
994 distributions. In these cases 'Makefile.ad' file needs to be created.
996 Even though it would be possible to use distdef conditionals also inside
997 'Makefile.am' files, Autodist does not process 'Makefile.am' files when
998 preparing the source tree for configuration and compilation (@pxref{Preparing source tree, , , , }). Thus, the prepared environment would not be
999 identical to the created distribution package (when the 'Makefile.am'
1000 will be processed), and configuration and compilation would be inconsistent.
1001 Basic rule is, if you need distdefs (@pxref{Distdefines, , , , }) inside
1002 makefiles, put them inside 'Makefile.ad' file.
1006 * Other .ad files:: Other files with .ad suffix
1010 @node Other .ad files
1011 @section Other .ad files
1013 Any file in the source tree can have the '.ad' suffix appended. Autodist
1014 will process any file that has the suffix when the source tree is
1015 prepared for configuration and compilation (@pxref{Preparing source tree, , , , }). If the files have distdef conditionals the Autodist will process them.
1016 The files will have the '.ad' suffix removed.
1018 Basic rule is, if you need to process some file when preparing the
1019 source tree for configuration and compilation, add '.ad' suffix to it.
1020 Distdefs (@pxref{Distdefines, , , , }) can be used in any file in source
1021 tree but without '.ad' suffix Autodist will not process those files during
1022 preparation. They will be processed when creating the distribution package.
1023 If you need processed files during configuration or compilation then they
1024 need to have '.ad' suffix.
1026 Note that, the distdef format used in these files must be the non-source
1030 * Distdefines:: Using distdefs in files
1035 @section Using distribution defines (distdefs)
1037 Distribution defines, or distdefs from now on, are used to define inside
1038 a file what will be included in the distribution. Distribution may define
1039 many different distdefs, for example, based on feature sets, platforms, or
1040 for other similar reasons. If distdef is not defined for the distribution
1041 but is used in a file, anything inside the distdef in that file will be
1042 removed when the distribution is packaged (@pxref{Creating distribution, , , , }). This guarantees that only the files, directories and file content
1043 (such as source code) that is supposed to be delivered with the distribution
1044 are delivered. Delivering files or code accidentally in the distribution
1047 All other files, except files ending with '.ad' suffix are processed for
1048 distdefs only when the distribution is packaged. Files ending with '.ad'
1049 suffix are processed for distdefs when preparing the source tree for
1050 configuration and compilation (@pxref{Preparing source tree, , , , }).
1052 By default the distdefs are named '_DIST_XXX', where 'XXX' is the name of
1053 distdef. However, many projects will want to define their own prefix
1054 for distdefs in the 'autodist.conf' configuration file (@pxref{autodist.conf, , , , }).
1055 In the following examples a prefix 'SILC' is used, hence the prefix for
1056 the distdefs are 'SILC_DIST_'.
1058 The basic format for the distdefs are as follows:
1061 #ifdef SILC_DIST_DEFINE
1062 #endif SILC_DIST_DEFINE
1064 #ifndef SILC_DIST_DEFINE
1065 #endif SILC_DIST_DEFINE
1067 #ifdef SILC_DIST_DEFINE
1068 #else !SILC_DIST_DEFINE
1069 #endif SILC_DIST_DEFINE
1071 #ifndef SILC_DIST_DEFINE
1072 #else SILC_DIST_DEFINE
1073 #endif SILC_DIST_DEFINE
1076 This format should be used only in non-source files, as for example C and
1077 C++ compilers will not like this format inside a file. In source files
1078 a compiler friendly format, defined below, should be used.
1081 #ifdef SILC_DIST_DEFINE
1082 #endif /* SILC_DIST_DEFINE */
1084 #ifndef SILC_DIST_DEFINE
1085 #endif /* SILC_DIST_DEFINE */
1087 #ifdef SILC_DIST_DEFINE
1088 #else /* !SILC_DIST_DEFINE */
1089 #endif /* SILC_DIST_DEFINE */
1091 #ifndef SILC_DIST_DEFINE
1092 #else /* SILC_DIST_DEFINE */
1093 #endif /* SILC_DIST_DEFINE */
1096 Note that, only the format defined above is supported. Other more complex
1097 use of the preprocessor directives such as using '&&' and '||' in the
1098 '#ifdef' or '#ifndef' are not supported, and neither is '#elif'. Also
1099 note, that the name of the distdef in '#else' and '#ifdef' directives in
1100 non-source format and in source format inside C comments (/* */), and the
1101 use of '!' character in the '#else' branch of '#ifdef'" are mandatory.
1102 Also note, that the distdef conditionals must be placed at the start of
1103 the line, they must not be indented.
1105 The following example shows the use of non-source format:
1109 #ifdef SILC_DIST_SERVER
1112 #endif SILC_DIST_SERVER
1113 #ifndef SILC_DIST_CLIENT
1115 #endif SILC_DIST_CLIENT
1116 #ifdef SILC_DIST_TOOLKIT
1119 #else !SILC_DIST_TOOLKIT
1122 #ifdef SILC_DIST_CLIENT
1124 #endif SILC_DIST_CLIENT
1125 #endif SILC_DIST_TOOLKIT
1128 Say, in this example, your distribution has the SILC_DIST_CLIENT and
1129 SILC_DIST_SERVER defined, but not the SILC_DIST_TOOLKIT, the end result
1141 The lines defined specificly for the SILC_DIST_TOOLKIT, which in our
1142 example was not defined, were removed. Also lines that specificly
1143 expected certain distdefs not to be defined ('#ifndef') were removed.
1144 (Note the last remaining '\' in example above would be removed by the
1145 Autodist automatically to avoid errors with Automake.)
1147 The following example shows the use of source code format:
1151 #ifdef SILC_DIST_MPI
1154 #else /* !SILC_DIST_MPI */
1156 #endif /* SILC_DIST_MPI */
1158 #ifndef SILC_DIST_FOOBAR
1159 foobar_replacement();
1160 #else /* SILC_DIST_FOOBAR */
1162 #endif /* SILC_DIST_FOOBAR */
1165 Say, you have both SILC_DIST_MPI and SILC_DIST_FOOBAR defined, the end result
1176 Even before processing the source files with Autodist, the preprocessor
1177 will respect the preprocessor directives if the code use '#include' to
1178 include the distdef header file created by the Autodist (see
1179 'autodist.conf' (@pxref{autodist.conf, , , , })). When the distribution
1180 is packaged (@pxref{Creating distribution, , , , }) the Autodist will
1181 process the files, and will remove any line not defined to be included.
1182 The preprocessor directives will also be removed.
1184 Because the software project includes the header file with '#include' the
1185 distdef header file needs to be present in the distribution, unless it is
1186 placed inside some other '#ifdef' conditional. If the distribution is
1187 prepared but not compiled (it is packaged after preparation without
1188 compilation) then including the distdef header in the source is not
1189 necessary. Including it then in the distribution is not necessary either.
1191 The software project should not use the same name space that distdef
1192 conditionals use for other than distribution usage. The Autodist will
1193 process any line that uses the formats above and has the specified prefix
1194 (eg. 'SILC_DIST_') in those lines. Using same prefix for other purposes
1195 will produce unexpected results and invalid distributions.
1197 The following suffixes will be considered as source files by the Autodist:
1215 Using distdefs in any other file must follow the non-source format.
1218 @node Invoking Autodist
1219 @chapter Invoking Autodist
1221 The Autodist has two basic functions:
1223 1. Preparing source tree for configuration and compilation (@pxref{Preparing source tree, , , , })
1225 2. Creating distribution packages (@pxref{Creating distribution, , , , })
1227 The 'autodist' accepts the following options:
1233 Prints the help for the Autodist and exits.
1237 Prints version number and exits.
1241 Verbosely report processing.
1244 @itemx --distdir <dir>
1245 Search distributions from <dir> instead of default 'distdir'.
1248 @itemx --distdefs [<dist>]
1249 Prints distribution defines of <dist> and exits.
1253 Initializes Autodist environment. Creates the default distribution
1254 directory 'distdir', 'autodist.conf' configuration file and the
1255 default distribution 'default', then exits.
1259 Creates and packages distribution
1262 Create package compressed with gzip (default)
1265 Create also package compressed with bzip2
1268 Create also package compressed with compress
1271 Create also package compressed with zip
1277 * Preparing source tree:: Preparing source tree with Autodist
1278 * Creating distribution:: Creating distribution with Autodist
1282 @node Preparing source tree
1283 @section Preparing source tree for configuration and compilation
1285 Before distribution can be created from the source tree, the source tree
1286 must be prepared for configuration and compilation. If your project is
1287 not using Autodist, then you would do this by running perhaps 'aclocal',
1288 'autoconf', 'autoheader' and 'automake' tools manually, or you would run an
1289 'autogen.sh' script that prepares your raw source tree. With Autodist
1290 this process is performed by Autodist, and running these tools manually
1291 or using 'autogen.sh' script is not necessary.
1293 By default the 'autodist.conf' (@pxref{autodist.conf, , , , }) has defined
1294 the tools that will be run by the Autodist when preparing the source tree.
1295 These are 'aclocal', 'autoheader', 'autoconf', 'automake' and
1296 'libtoolize'. If you do not wish that Autodist runs some or any of these
1297 tools automatically, do not set them in the 'autodist.conf'. You would
1298 then need to run them manually. However, this is not recommended. If you
1299 need to run additional preparation scripts you may set your scripts either
1300 in the 'pre-hook' and/or 'post-hook' where you can run what ever
1301 additional processing you may need to prepare your source tree.
1303 By default the Autodist creates a 'default' distribution when you
1304 initialize your project by running 'autodist -i'. The 'default'
1305 distribution should be used when you are developing in your source
1306 tree. By default, the 'default' distribution cannot be packaged,
1307 however, if your project creates only one distribution you may find
1308 it more convenient to define your distribution inside the 'default'
1309 distribution and allow it to be packaged also. If your source tree
1310 will create multiple distributions, the 'default' should be used only
1311 as development distribution. You would use it when you, for example,
1312 checkout your source tree from CVS and prepare it for configuration
1313 and compilation. To prepare your source tree with the 'default'
1314 distribution run Autodist without any arguments.
1320 The Autodist will prepare your source tree. After that you may run
1321 './configure' and continue to compile with 'make'.
1323 If you do not wish to use the 'default' distribution, or you wish
1324 to do the development in a tree specificly prepared for some specific
1325 distribution, or you are preparing to create a new distribution package,
1326 you will need to run the Autodist with the distribution you wish to
1330 autodist example-distribution 1.0.3
1333 This prepares your source tree for 'example-distribution' of version
1334 '1.0.3'. After that you may run './configure' and continue to compile
1335 with 'make'. If the version is omitted the version will be '0.0'.
1337 Note that, running Autodist for preparation merely prepares your source
1338 tree for the distribution, it does not create an actual distribution
1339 package. When preparing source tree for configuration and compilation
1340 the Autodist will process any file that ends with '.ad' suffix. It will
1341 process all 'configure.ad' and 'Makefile.ad' files for that distribution.
1342 When you run './configure' your tree will be configured for that
1343 distribution, and when you compile with 'make' it will compile for that
1346 However, the source files, or any other file (except files ending with
1347 '.ad' suffix) are not processed by the Autodist. When compiling
1348 your sources the preprocessor, however, will respect your distdef
1349 conditionals inside your source files if you include the distdef header
1350 file. This way, even the compiled binaries will be compiled for that
1351 distribution, even though the source files has not yet been processed
1352 by the Autodist. Rest of the files in the distribution will be processed
1353 when you create the actual distribution package. It is guaranteed that
1354 the distribution you have prepared will behave in your source tree exactly
1355 the same way as if it was already packaged with Autodist (providing that
1356 you remember to include the distdef header file in your code).
1359 * Creating distribution:: Creating distribution with Autodist
1363 @node Creating distribution
1364 @section Creating distribution package(s)
1366 Before creating a new distribution package, you will need to prepare
1367 the source tree for the distribution you want to create. After preparing
1368 your source tree you will be ready to create a new distribution. The
1369 Autodist package provides a simple helper script 'makedist' that may
1370 be used to create the distribution. However, if you wish, you may
1371 run the Autodist yourself, as the 'makedist' will call Autodist anyway.
1373 To create a new distribution for the distribution you have prepared for
1380 This will run the Autodist and create a new distribution package that
1381 is archived with 'tar' and compressed with 'gzip'. If you wish to
1382 create packages also compressed with 'bzip2', 'compress' and/or 'zip'
1383 you may give one or all of the following options:
1386 makedist --bzip2 --compress --zip
1389 This example would create, in addition of 'tar.gz' package, also a
1390 'tar.bz2', 'tar.Z' and '.zip' packages. Current version of Autodist does
1391 not support archiving with 'shar'.
1393 If you wish to run additional processing for your distributions when
1394 they are being packaged you may set 'pre-dist-hook' and/or 'post-dist-hook'
1395 in your distribution file. Also note that any hooks provided by Automake
1396 in Makefiles will be run in normal manner.
1398 For additional help, you may give:
1409 * Single distribution tree:: Single distribution example
1410 * Multiple distribution tree:: Multiple distributions example
1413 @node Single distribution tree
1414 @section Single distribution tree example, start to finish
1416 Lets suppose you have a simple source tree with one application,
1417 called 'foozbar' you wish to release. While you would probably suffice
1418 using Autoconf and Automake features you may still use Autodist.
1420 First, you create the default 'distdir' into your software package:
1426 Then, you create the 'configure.ad' file from your existing 'configure.ac'
1427 or 'configure.in' file. If you don't have configure script written yet,
1428 please refer to the Autoconf manual. In the 'autodist.ad' you add as
1429 first macro in the file:
1435 Then, you create distribution file for your application:
1438 # Foozbar distribution
1441 bug-report foozbar-bugs@@foo.z.bar
1442 define _DIST_FOOZBAR
1445 This distribution file go into 'distdir/foozbar'.
1447 And there you go. You have succesfully integrated Autodist into your
1448 source tree. If you need to do development and you wish to use the
1449 'default' distribution for that, you should inherit the new 'foozbar'
1450 distribution in it. Add the following line in 'distdir/default':
1456 After that, you can prepare the source tree for configuration and
1457 compilation by giving:
1463 After this command you can give './configure' and 'make'.
1465 If you want to do development directly in a tree prepared for the
1466 'foozbar' distribution, or you are ready to start creating a new
1467 distribution package, you give:
1470 autodist foozbar 1.0
1473 After this command you can give './configure' and 'make'.
1475 To create the distribution package, you will give:
1481 The end result will be a 'foozbar-1.0.tar.gz' package.
1484 @node Multiple distribution tree
1485 @section Multiple distribution tree example, start to finish
1487 Lets suppose you have a source tree from which you create multiple
1488 distributions, say three. If you really have a such source tree you
1489 must have by now noticed the difficulty of maintaining such a source tree
1490 and problems with controlling the distributions. Maybe you have sufficed
1491 with Autoconf and Automake, or perhaps you have created your own scripts
1492 that carry out the kludges. No more, for Autodist is here.
1494 First, you integrate Autodist into your tree by creating the distributions
1495 directory 'distdir':
1501 Then, you create the 'configure.ad' file from your existing 'configure.ac'
1502 or 'configure.in' file. If you don't have configure script written yet,
1503 please refer to the Autoconf manual. In the 'autodist.ad' you add as
1504 first macro in the file:
1510 You then continue with creating the distribution files for your three
1511 distributions. Let's name them 'foozbar', 'libfoozbar' and 'nomad'.
1512 We will also create a common template that all distributions inherit.
1515 # Foozbar distribution
1518 bug-report foozbar-bugs@@foo.z.bar
1520 define _DIST_FOOZBAR
1524 # libfoozbar distribution
1526 bug-report libfoozbar-bugs@@foo.z.bar
1528 define _DIST_LIBFOOZBAR
1532 # Nomad distribution
1534 package nomad-the-server
1535 bug-report nomad-bugs@@foo.z.bar
1539 define _DIST_NOMAD_LIB
1555 You put the distribution files in the 'distdir' directory. In addition
1556 you will be doing development in the source tree using the 'default'
1557 distribution, you will add the new distributions to the 'distdir/default':
1565 To prepare the source tree for configuration and compilation you would
1572 This will prepare your source tree for configuration and compilation. Since
1573 the 'default' distribution inherits all distributions your development
1574 source tree will have all of them included. If you do not want to do this
1575 then don't inherit them in the 'default', but run the autodist specificly
1576 for the distributions, for example:
1582 Since all the distributions inherit the 'common' distribution they get
1583 all the distdefs that the 'common' defines. In this example various distdefs
1584 has been defined. You would use them in your code and in your makefiles
1585 to control various things. For example, let's say the 'common' distdefs
1586 control what directories distributions have. An example 'Makefile.ad'
1599 Perhaps the 'Makefile.ad' in 'lib' subdirectory could define something
1611 #ifdef _DIST_NOMAD_LIB
1613 #endif _DIST_NOMAD_LIB
1614 #ifdef _DIST_LIBFOOZBAR
1616 #endif _DIST_LIBFOOZBAR
1619 Since the 'nomad' distribution undefined the '_DIST_CRYPTO' distdef it
1620 would not have the 'cryptolib' in its distribution. Clearly Nomad
1621 don't need it. In addition of using the distdefs just in the makefiles
1622 you may want to use them in the source code as well:
1628 /* Initialize math library */
1630 #endif /* _DIST_MATH */
1635 After an intensive development period you're ready to create new releases.
1636 Let's say you're going to release all distributions:
1638 First you release Foozbar 0.5.1:
1641 autodist foozbar 0.5.1
1645 The end result is two files: 'foozbar-0.5.1.tar.gz' and
1646 'foozbar-0.5.1.tar.bz2'.
1648 Then you continue with libfoozbar and Nomad:
1651 autodist libfoozbar 1.0.5
1658 The end results are: 'libfoozbar-1.0.5.tar.gz' and 'nomad-2.0.tar.gz'.