6.3.5 Serial Numbers

Because third-party macros defined in ‘*.m4’ files are naturally shared between multiple projects, some people like to version them. This makes it easier to tell which of two M4 files is newer. Since at least 1996, the tradition is to use a ‘#serial’ line for this.

A serial number should be a single line of the form

# serial version

where version is a version number containing only digits and dots. Usually people use a single integer, and they increment it each time they change the macro (hence the name of “serial”). Such a line should appear in the M4 file before any macro definition.

The ‘#’ must be the first character on the line, and it is OK to have extra words after the version, as in

#serial version garbage

Normally these serial numbers are completely ignored by aclocal and autoconf, like any genuine comment. However when using aclocal's ‘--install’ feature, these serial numbers will modify the way aclocal selects the macros to install in the package: if two files with the same basename exists in your search path, and if at least one of them use a ‘#serial’ line, aclocal will ignore the file that has the older ‘#serial’ line (or the file that has none).

Note that a serial number applies to a whole M4 file, not to any macro it contains. A file can contains multiple macros, but only one serial.

Here is a use case that illustrate the use of ‘--install’ and its interaction with serial numbers. Let's assume we maintain a package called MyPackage, the ‘configure.ac’ of which requires a third-party macro AX_THIRD_PARTY defined in ‘/usr/share/aclocal/thirdparty.m4’ as follows:

# serial 1
AC_DEFUN([AX_THIRD_PARTY], [...])

MyPackage uses an ‘m4/’ directory to store local macros as explained in Handling Local Macros, and has

ACLOCAL_AMFLAGS = -I m4 --install

in its top-level ‘Makefile.am’.

Initially the ‘m4/’ directory is empty. The first time we run autoreconf, it will fetch the options to pass to aclocal in ‘Makefile.am’, and run ‘aclocal -I m4 --install’. aclocal will notice that

• ‘configure.ac’ uses AX_THIRD_PARTY
• No local macros define AX_THIRD_PARTY
• ‘/usr/share/aclocal/thirdparty.m4’ defines AX_THIRD_PARTY with serial 1.

Because ‘/usr/share/aclocal/thirdparty.m4’ is a system-wide macro and aclocal was given the ‘--install’ option, it will copy this file in ‘m4/thirdparty.m4’, and output an ‘aclocal.m4’ that contains ‘m4_include([m4/thirdparty.m4])’.

The next time ‘aclocal -I m4 --install’ is run (either via autoreconf, by hand, or from the ‘Makefile’ rebuild rules) something different happens. aclocal notices that

• ‘configure.ac’ uses AX_THIRD_PARTY
• ‘m4/thirdparty.m4’ defines AX_THIRD_PARTY with serial 1.
• ‘/usr/share/aclocal/thirdparty.m4’ defines AX_THIRD_PARTY with serial 1.

Because both files have the same serial number, aclocal uses the first it found in its search path order (see section Macro search path). aclocal therefore ignores ‘/usr/share/aclocal/thirdparty.m4’ and outputs an ‘aclocal.m4’ that contains ‘m4_include([m4/thirdparty.m4])’.

Local directories specified with ‘-I’ are always searched before system-wide directories, so a local file will always be preferred to the system-wide file in case of equal serial numbers.

Now suppose the system-wide third-party macro is changed. This can happen if the package installing this macro is updated. Let's suppose the new macro has serial number 2. The next time ‘aclocal -I m4 --install’ is run the situation is the following:

• ‘configure.ac’ uses AX_THIRD_PARTY
• ‘m4/thirdparty.m4’ defines AX_THIRD_PARTY with serial 1.
• ‘/usr/share/aclocal/thirdparty.m4’ defines AX_THIRD_PARTY with serial 2.

When aclocal sees a greater serial number, it immediately forgets anything it knows from files that have the same basename and a smaller serial number. So after it has found ‘/usr/share/aclocal/thirdparty.m4’ with serial 2, aclocal will proceed as if it had never seen ‘m4/thirdparty.m4’. This brings us back to a situation similar to that at the beginning of our example, where no local file defined the macro. aclocal will install the new version of the macro in ‘m4/thirdparty.m4’, in this case overriding the old version. MyPackage just had its macro updated as a side effect of running aclocal.

If you are leery of letting aclocal update your local macro, you can run ‘aclocal -I m4 --diff’ to review the changes ‘aclocal -I m4 --install’ would perform on these macros.

Finally, note that the ‘--force’ option of aclocal has absolutely no effect on the files installed by ‘--install’. For instance, if you have modified your local macros, do not expect ‘--install --force’ to replace the local macros by their system-wide versions. If you want to do so, simply erase the local macros you want to revert, and run ‘aclocal -I m4 --install’.