Autotools 基础

主要的 Autotools 组件

Autotools 是一个相关软件包的集合，当一起使用时，可以消除创建可移植软件过程中的大部分困难。这些工具连同一些相对简单的上游提供的输入文件一起，用于创建软件包的构建系统。

主要 Autotools 组件如何协同工作的一个基本概述。

在简单的设置中

• autoconf 程序从 configure.in 或 configure.ac（参见下面的注释）生成 configure 脚本。
• automake 程序从 Makefile.am 生成 Makefile.in。
• configure 脚本运行以从 Makefile.in 文件生成一个或多个 Makefile 文件。
• make 程序使用 Makefile 编译程序。

您可能会看到 Autotools 在各种阶段函数中使用。 src_prepare 函数是在配置和编译之前操作源代码的最合适的地方。特别是，在 src_configure 之前调用 src_prepare，后者通常期望 configure 脚本存在。

autoreconf 工具据说根据需要运行 autoconf（以及 automake、autoheader、aclocal、autopoint 和 libtoolize）。有时它能正常工作。一些软件包附带一个名为 autogen.sh 的 shell 脚本，它执行相同的功能（这与 autogen 无关）。autotools.eclass 包含用于独立工具的帮助器函数，以及它们对应的名称，例如 eautoconf 和 eautomake。

简单的 Autotools 打补丁示例

以下代码片段说明了在修补 Makefile.am 或 configure.ac 后继续进行的正确方法。

EAPI=8

WANT_AUTOCONF=2.5
WANT_AUTOMAKE=1.9
inherit autotools

IUSE="nls"

BDEPEND="nls? ( sys-devel/gettext )"

src_prepare() {
	default

	# Remove problematic LDFLAGS declaration
	sed -i -e '/^LDFLAGS/d' src/Makefile.am || die

	# Rerun autotools
	eautoreconf
}

src_configure() {
	econf $(use_enable nls)
}

configure.ac 文件

configure.ac 文件用于创建 ./configure 脚本。它由一系列宏组成，这些宏由 autoconf 处理和扩展。这些宏可以检查软件包和库，处理 --enable 和 --with 开关，并生成各种文件。

dnl Process this file with autoconf
AC_INIT(appname, 0.1)
AC_PREREQ(2.5)
AC_CONFIG_SRCDIR(src/main.c)
AC_CONFIG_AUX_DIR(config)
AM_INIT_AUTOMAKE(1.8)

dnl Check for toolchain and install components
AC_PROG_CC
AC_PROG_INSTALL
AC_PROG_LN_S
AC_PROG_RANLIB

dnl Check for sed
AC_CHECK_PROGS(regex_cmd, sed)
if test x$regex_cmd = "x" ; then
    AC_MSG_ERROR([sed is required to build the data files.])
fi

dnl Check that our compiler can do const and inline
AC_C_CONST
AC_C_INLINE

dnl Check for standard headers:
AC_HEADER_STDC
AC_HEADER_DIRENT
AC_CHECK_HEADERS([stdlib.h stdio.h libintl.h locale.h])

dnl Check for libraries:
AC_CHECK_LIB(ssl, SSL_free)

dnl Check for functions:
AC_CHECK_FUNCS([setlocale strtol])

AM_CONFIG_HEADER(config.h)
AC_OUTPUT(Makefile src/Makefile nls/Makefile man/Makefile tests/Makefile)

AC_MSG_CHECKING(--enable-cscope argument)
AC_ARG_ENABLE(cscope,
    [  --enable-cscope         Include cscope interface.],
    [enable_cscope=$enableval],
    [enable_cscope="no"])
AC_MSG_RESULT($enable_cscope)
if test "$enable_cscope" = "yes"; then
  AC_DEFINE(FEAT_CSCOPE)
fi

AC_MSG_CHECKING([whether to enable foo])
AC_ARG_WITH(foo,
    [  --with-foo           enable foo support],
    with_foo=$withval,
    with_foo=yes)
AC_MSG_RESULT($with_foo)

AC_MSG_RESULT(the first)
AC_MSG_RESULT([the second])
AC_MSG_RESULT("the third")
AC_MSG_RESULT(@<:@the fourth@:>@)
AC_MSG_RESULT([@<:@the fifth@:>@])

    the first
    the second
    "the third"
    [the fourth]
    [the fifth]

Makefile.am 文件

Makefile.am 文件由 automake 处理以创建 Makefile.in， Makefile.in 又由 configure 处理以创建 Makefile， Makefile 又由 make 用于构建软件。

基本格式类似于 Makefile。但是，您会看到设置了各种“特殊”变量，而不是手动编写每个规则。

一个非常简单的例子

bin_PROGRAMS = myapp
myapp_SOURCES = myapp_commandline.c myapp.c

所有标准的 GNU 规则都将生成，因此 make。 make clean。 make distclean。 make dist 等等都将在这里工作。

您也可能会看到一些标准的 Makefile 结构出现在没有标准的 automake 方法来处理某些任务时。例如

CLEANFILES = glep31check.1
man_MANS = glep31check.1
EXTRA_DIST = glep31check.in

%.1 : %.in
    @regex_cmd@ -e "s,\@VERSION\@,$(VERSION),g" $? > $@

这里， @regex_cmd@ 变量将被替换为 configure 在创建 Makefile 时检测到的任何内容（在本例中为 sed）。这通过 configure.ac 中的宏 AC_SUBST(VARNAME) 处理。

CFLAGS="-Wall"

AM_CFLAGS="-Wall"

config.h.in 文件

config.h.in 文件由 autoheader 生成。通常您不必担心这个问题，但偶尔您可能需要在构建过程中手动运行 autoheader，如果上游没有提供预生成的版本。

aclocal 和 m4 文件

在 configure.ac 或 configure.in 文件中，您不仅可以调用 autoconf 和 automake 定义的默认宏，还可以调用由特定软件包（如库和程序）定义的其他函数，以正确的方式检查其功能。

这些函数（通常）在 m4 文件中定义，这些文件由软件包放置在 /usr/share/aclocal 目录中。当您需要重新生成 autotools 文件时，可能会出现问题，因为 configure.ac 文件使用的函数可以在用户系统上未安装的 m4 宏文件中定义。例如，对于某些需要库并由 USE 标志禁用的可选功能就是这种情况。如果 m4 文件未安装在用户系统上，则 autoconf 步骤将失败。

为了解决这个问题，大多数软件包只是将其 configure.ac 所需的 m4 宏文件放在源软件包中的 m4 子目录中。不幸的是，即使存在，并非所有 m4 目录都是完整的。

在这些情况下，您需要找出 m4 文件，通常由依赖项安装在 /usr/share/aclocal 中，并确保 src_unpack 阶段使 autotools 可以使用这些文件并调用 aclocal 来重新创建 aclocal.m4 文件，该文件在创建配置脚本时由 autoconf 使用。

通常缺少的不仅仅是一个 m4 文件，因此您可能希望将它们打包成一个 tarball，并将其添加到 SRC_URI 中。在确保 tarball 提取到 ${WORKDIR} 中的某个位置（例如，在 gentoo-m4 目录中）后，通常有两种处理这些宏文件的一般方法，一种用于带有不完整 m4 目录的软件包，另一种用于不带 m4 目录的软件包。

在第一种情况下，您通常希望执行以下操作

WANT_AUTOCONF="2.5"
inherit autotools

src_prepare() {
	default

	einfo "Regenerating autotools files..."
	cp "${WORKDIR}/gentoo-m4" "${S}/m4" || die "m4 copy failed"
	eaclocal -I "${S}/m4"
	eautoconf
}

等等。在第二种情况下，您可以通过这种方式简化它

WANT_AUTOCONF="2.5"
inherit autotools

src_prepare() {
	default

	einfo "Regenerating autotools files..."
	eaclocal -I "${WORKDIR}/gentoo-m4"
	eautoconf
}

无需复制文件。

当分发版中缺少所需的 m4 文件时，最好始终通知上游，要求他们在源 tarball 中添加所有所需的文件，以避免如果宏发生更改则版本冲突。

Libtool

更多 autotools 阅读资料

有关 autotools 的更多详细信息

• Gary V. Vaughan、Ben Elliston、Tom Tromey 和 Ian Lance Taylor 合著的《GNU Autoconf、Automake 和 Libtool》一书（通常称为“Autobook”）提供了对 autotools 的良好但略显过时的描述。它可以在线免费获取。
• 各种 autotools 组件的 GNU 文档质量和完整性各不相同
  • GNU automake 手册
  • GNU autoconf 手册
  • GNU libtool 手册
  • GNU m4 手册
  • Autotools 揭秘
• 网上有一些不错的概述讲座。 这些幻灯片就是一个例子。