wiki:pm-autotools

Version 3 (modified by andreasw, 14 years ago) (diff)

--

Working With the GNU Autotools

Mosf of the COIN projects use the GNU autotools to manage the automatic configuration of the compilation process on a user's machine. The goal is that users don't need to edit Makefiles by hand, and to make the code and compilation as portable as possible.

Because the autotools try to serve many operating systems, compilers, and other environment characteristics, they might seem at the first sight somewhat complicated. However, we tried to hide most of the details that are required to successully use those tools by encapsulating the difficult issues and provide a COIN project manager friendly layer on top of the autotools.

Introduction

In COIN, we make use of the three GNU packages autoconf, automake, and libtool.

A good description of those tools and how they play together can be found in the Autobook; but the versions of the tools discussed there are not the most recent ones. The documentation for each tool are here for autoconf, automake, and libtool.

Here you find a short description of those tools and how they are used in COIN in our wiki pages.

The configure.ac Files

The configure script is generated by autoconf based on the configure.ac input file. This script usually contains autoconf macros and maybe some /bin/sh commands. To make the usage of autoconf easier for COIN developers, we define a number of new autoconf macros (in the file BuildTools/coin.m4).

Many projects in COIN have a simple configure script in the base directory of a package (the directory Coin-Clp in the example for the directory structure, which is the trunk directory in the repository). This configure script usually only verifies which components are available in the subdirectories, and generates the main Makefile. Here we discuss an example of the base directory configure.ac file.

In the project subdirectories (such as the CoinUtils and Clp subdirectories in directory structure example) are the real configuration files. This is where the tests for each package are performed. The configure.ac files here can be more involved. For an example of a project configure.ac file check here.

The Makefile.am Files

The Makefiles are generated by automake based on Makefile.am input files. Those usually contain