Each macro in the Archive has an all-upper-case name with the prefix
AX_. The macro is stored in a file with the same name, in lower
case, and with the suffix
The file should begin with a header comment containing three named sections: synopsis, description, and license.
The synopsis gives a summary of the macro usage and arguments. In this
section, square brackets (
) are used to indicate optional
parameters, and may be nested.
The description contains a prose description of the macro. It should describe the function of the macro, and the meaning of any arguments given in the synopsis. The description should also identify:
--enableoptions, and their default values
Macros should be defined with
AC_DEFUN, using correct quoting.
Comments should be used liberally within the macro, with
used for comments at the m4sh level and
# used for comments at
the shell level.
If a macro is renamed, the
AU_ALIAS macro should be used to
guide users of the old name to the new name:
Please post to the patch tracker to submit a macro for inclusion in the Archive. Your submission should contain:
Macros can be submitted under any GPL-compatible free software license. The Free Software Foundation, however, recommends use of the all-permissive license for Autoconf macros.
Autoconf macros are used in a surprising variety of ways, and a well-written macro should be flexible enough to suit all of these uses.
See the Autotools Mythbuster for suggestions on how to write well-encapsulated, portable macros.