The 'name' directive defines the name of the distribution. It is optional
directive, and if omitted the distribution name will be the name of the
-distfile.
+distfile. The 'PACKAGE_NAME' define delivered by Autoconf will contain
+this name string.
Example:
@example
be the name of the distribution, if defined, or if omitted, then the name
of the distfile. If this directive is omitted then normal GNU convention
is used to decide the package name, derived from the distribution name.
+The 'PACKAGE_TARNAME' define delivered by Autoconf will contain this
+package name string.
Example:
@example
The 'bug-report' directive can be used to define the email address where
the bug-reports for the distribution should be sent. The directive is
-optional. The 'bug-report' email address will be set for the Autoconf
-which will deliver it via AC_INIT macro.
+optional. The 'PACKAGE_BUGREPORT' define delivered by Autoconf will
+contain this bug report string.
@section Directive: license <filename>
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 file
-has equal amount of lines in them.
+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,
though not mandatory, that the header files have the same indentation as
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
+the distribution.
+
Example current header:
@example
--- Start example
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 and excludes. 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.
+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
no-dist
Note that, only the format defined above is supported. Other more complex
use of the preprocessor directives such as using '&&' and '||' in the
'#ifdef' or '#ifndef' are not supported, and neither is '#elif'. Also
-note, that the name of the distdef in '#else' and '#ifdef' directives in
+note, that the name of the distdef in '#else' and '#endif' directives in
non-source format and in source format inside C comments (/* */), and the
use of '!' character in the '#else' branch of '#ifdef'" are mandatory.
Also note, that the distdef conditionals must be placed at the start of
#ifndef SILC_DIST_FOOBAR
foobar_replacement();
+ foobar_hack_init();
+ foobar_init();
#else /* SILC_DIST_FOOBAR */
real_foobar();
#endif /* SILC_DIST_FOOBAR */
This prepares your source tree for 'example-distribution' of version
'1.0.3'. After that you may run './configure' and continue to compile
with 'make'. If the version is omitted the version will be '0.0'.
+The 'PACKAGE_VERSION' define delivered by Autoconf will contain this
+version.
Note that, running Autodist for preparation merely prepares your source
tree for the distribution, it does not create an actual distribution
However, the source files, or any other file (except files ending with
'.ad' suffix) are not processed by the Autodist. When compiling
your sources the preprocessor, however, will respect your distdef
-conditionals inside your source files if you include the distdef header
+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
by the Autodist. Rest of the files in the distribution will be processed
the same way as if it was already packaged with Autodist (providing that
you remember to include the distdef header file in your code).
+When preparing the source tree Autodist will create a file 'autodist.dist'
+which will contain information on the prepared distribution. When
+Creating the distribution that file will be read by the Autodist
+automatically. That file should not be removed or the distribution
+cannot be packaged.
+
@menu
* Creating distribution:: Creating distribution with Autodist
@end menu
'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-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.
-
-For additional help, you may give:
-
-@example
- makedist --help
-@end example
+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.
@node Examples
Then, you create the 'configure.ad' file from your existing 'configure.ac'
or 'configure.in' file. If you don't have configure script written yet,
-please refer to the Autoconf manual. In the 'autodist.ad' you add as
+please refer to the Autoconf manual. In the 'configure.ad' you add as
first macro in the file:
@example
Then, you create the 'configure.ad' file from your existing 'configure.ac'
or 'configure.in' file. If you don't have configure script written yet,
-please refer to the Autoconf manual. In the 'autodist.ad' you add as
+please refer to the Autoconf manual. In the 'configure.ad' you add as
first macro in the file:
@example
projects / autodist.git / blobdiff