automake---configure.in/configure.am和makefile.am编写

最新推荐文章于 2021-07-26 14:13:05 发布

weixin_42050875

最新推荐文章于 2021-07-26 14:13:05 发布

阅读量1.7k

点赞数 1

分类专栏： linux编程

本文链接：https://blog.csdn.net/weixin_42050875/article/details/97113411

版权

linux编程专栏收录该内容

10 篇文章 0 订阅

订阅专栏

https://yq.aliyun.com/articles/243357

参考自：https://blog.csdn.net/zmxiangde_88/article/details/8024223#

https://www.jianshu.com/p/2f5e586c3402

https://www.cnblogs.com/chenshikun/p/6096647.html

在现有项目增加自己的源代码: https://blog.csdn.net/harrison_zhu/article/details/2127136

https://www.ibm.com/developerworks/cn/linux/l-makefile/

实例讲解：https://blog.csdn.net/linuxarmsummary/article/details/19037635

一.为一个项目源文件生成makefile并make的步骤如下：

操作在包含源文件的项目目录下进行。

(1). 运行autoscan，生成文件configure.scan。

(2). 修改configure.scan，改名为configure.in。

(3).运行autoheader，生成文件configure.h.in（现在一般改为configure.ac）。configure.in里有宏AC_CONFIG_HEADER()时用。

(4).运行libtoolize，生成一些支持文件，ltmain.sh。需要用libtool生成共享库用。

(5).运行allocal，生成aclocal.m4。

(6). 运行autoconf，生成configure。

(7).为源文件编写makefie.am，每一个包含源文件的目录和子目录都有一个makefile.am。

(8).运行automake，生成makefile.in，每个包含makefile.am的子目录都生成makefile.in。

automake -a选项可以补齐文件config.guess，config.sub，install-sh，missing，depcomp。

(9).运行./configure，生成config.status，config.h，makefile。

(10).运行make，生成中间文件对象文件，库文件，最后生成可执行文件。

(11).运行make install，相应的可执行文件，库文件，头文件拷贝到系统相应位置。

二、举例说明configure.in：

下面是一个简单的configure.in文件，来自于Gnome版的“Hello,World”：

　　AC_INIT(src/hello.c)
　　AM_CONFIG_HEADER(config.h)
　　AM_INIT_AUTOMAKE(GnomeHello,0.1)
　　AM_MAINTAINER_MODE
　　AM_ACLOCAL_INCLUDE(macros)
　　GNOME_INIT
　　AC_PROG_CC
　　AC_ISC_POSIX
　　AC_HEADER_STDC
　　AC_ARG_PROGRAM
　　AM_PROG_LIBTOOL
　　GNOME_COMPILE_WARNINGS
　　ALL_LINGUAS="deesfrnorusvfi"
　　AM_GNU_GETTEXT
　　AC_SUBST(CFLAGS)
　　AC_SUBST(CPPFLAGS)
　　AC_SUBST(LDFLAGS)
　　AC_OUTPUT([
　　　Makefile
　　　macros/Makefile
　　　src/Makefile
　　　intl/Makefile
　　　po/Makefile.in
　　　pixmaps/Makefile
　　　doc/Makefile
　　　doc/C/Makefile
　　　doc/es/Makefile
　　])

　　上面以AC开头的宏来自autoconf，以AM开头的宏来自automake。要从autoconf或
automake中寻求帮助，这一点很有用。以GNOME开头的宏来自于Gnomemacros目录。这些宏都是用m4宏语言写的。如果将
autoconf和automake安装在/usr目录下，autoconf和automake中的标准宏一般放在/usr/share/aclocal
目录下。

　　AC_INIT总是configure.in中的第一个宏。它扩展为许多可由其他configure脚本共享的模板文件代码。这些代码解析传到
configure中的命令行参数。这个宏的一个参数是一个文件名，这个文件应该在源代码目录中，它用于健全性检查，以保证configure脚本已正确
定位源文件目录。

　　AM_CONFIG_HEADER指定了要创建的头文件，差不多总是config.h。创建的头文件包含由configure定义的C预处理符
号。最低限度应该定义PACKAGE和VERSION符号，这样可以将应用程序名称和版本传送到代码中，而无须对它们硬编码(非公用的源文件应该包含
config.h(#include<config.h>)以利用这些定义。然而，不要将config.h文件安装到系统中，因为它有可能与
其他的软件包冲突)。

　　AM_INIT_AUTOMAKE初始化automake。传到这个宏里的参数是要编译的应用程序的名称和版本号(这些参数成为config.h中定义的PACKAGE和VERSION值)。

　　AM_MAINTAINER_MODE关闭缺省时仅供程序维护者使用的makefile目标，并修改以使configure能理解
--enable-maintainer-mode选项。--enable-maintainer-mode将maintaineronly目标重新打
开。仅供维护者使用的makefile目标允许最终用户清除自动生成的文件，
比如configure，这意味着要修复编译故障，必须安装有autoconf和automake软件。注意，
因为autogen.sh脚本主要是给开发人员用的，autogen.sh会自动传递一个--enable-
maintainer-mode选项给configure。

　　AM_ACLOCAL_INCLUDE指定一个附加的目录，用于搜索m4宏。在这里，它指定为macros子目录。在这个目录中应该有Gnome宏的拷贝。

　　GNOME_INIT给configure添加一个与Gnome相关的命令行参数个数，并为Gnome程序定义一些makefile变量，这些
变量中包含了必要的预处理程序和链接程序标志。这些标志是由gnome-config脚本取得的。安装gnome-libs时会安装gnome-
config脚本。

　　AC_PROG_CC定位C编译器。

　　AC_ISC_POSIX添加一些在某些平台上实现POSIX兼容需要的标志。

　　AC_HEADER_STDC检查当前平台上是否有标准的ANSI头文件，如果有，则定义STDC_HEADERS。

　　AC_ARG_PROGRAM添加一些选项到configure中，让用户能够修改安装程序的名称(如果在用户系统上碰巧有一个与要安装的程序名称相同的程序，这是很有用的)。

　　AM_PROG_LIBTOOL是由automake用来设置libtool的用途的。只在计划编译共享库或动态可加载模块时才需要设置这个值。

　　GNOME_COMPILE_WARNINGS给gcc命令行添加许多警告选项，但是在其他绝大多数的编译器上什么也不做。

　　ALL_LINGUAS=“es”不是一个宏，只是一句shell代码。它包含一个由空格分隔的语言种类缩写表，对应于po子目录下的.po文件。.po文件包含翻译成其他语言的文本，所以ALL_LINGUAS应该列出程序已经被翻译成的所有语言。

　　AM_GNU_GETTEXT由automake使用，但是这个宏会随gettext软件包发布。它让 automake执行一些与国际化相关的任务。

　　AC_SUBST输出一个变量到由configure生成的文件中。具体内容将在后面说明。

　　AC_OUTPUT列出由configure脚本创建的文件。这些文件都是由带.in后缀的同名文件生成的。例如，src/Makefile是
由src/Makefile.in生成的，config.h是由config.h.in生成的。在执行AC_OUTPUT宏时，configure脚本处
理包含有两个@符号标志的变量(例如@PACKAGE@)的文件。只有用AC_SUBST输出了变量，它才能识别这些变量(许多在上面讨论过的预先写好的
宏都用AC_SUBST定义变量)。这些特征用于将一个Makefile.in文件转换成一个Makefile文件。典型情况下，Makefile.in
是由automake从Makefile.am生成的(不过，你可以只用autoconf，而不用automake，自己编写一个
Makefile.in)。

三.Makefile.am

来讨论Makefile.am的编写。我觉得主要是要注意的问题是将编译什么文件？这个文件会不会安装？这个文件被安装到什么目录下？可以将文件编译成可执行文件来安装，也可以编译成静态库文件安装，常见的文件编译类型有下面几种：

PROGRAMS。表示可执行文件
LIBRARIES。表示库文件
LTLIBRARIES。这也是表示库文件，前面的LT表示libtool。
HEADERS。头文件。
SCRIPTS。脚本文件，这个可以被用于执行。如：example_SCRIPTS，如果用这样的话，需要我们自己定义安装目录下的example目录，很容易的，往下看。
DATA。数据文件，不能执行。

对于可执行文件和静态库类型，如果只想编译，不想安装到系统中，可以用noinst_PROGRAMS代替bin_PROGRAMS，noinst_LIBRARIES代替lib_LIBRARIES。以此类推。

下面就直接引入一个例子进行详细讲解，如下：

AUTOMAKE_OPTIONS = foreign

bin_PROGRAMS = client

client_SOURCES = key.c connect.c client.c main.c session.c hash.c

client_CPPFLAGS = -DCONFIG_DIR=\“$(sysconfdir)\” -DLIBRARY_DIR=\”$(pkglibdir)\”

client_LDFLAGS = -export-dynamic -lmemcached

noinst_HEADERS = client.h

INCLUDES = -I/usr/local/libmemcached/include/

client_LDADD = $(top_builddir)/sx/libsession.la \

$(top_builddir)/util/libutil.la

分析如下：

AUTOMAKE_OPTIONS：这个是用来设定automake的选项。automake主要是帮助开发GNU软件的人员维护软件套件，一般在执行automake时会检查目录下是否存在标准GNU套件中应具备的文件档案，例如NEWS、AUTHOR、ChangeLog等，设成foreign时，automake会改用一般软件套件标准来检查，而gnu是缺省设置，该级别下将尽可能地检查包是否服从GNU标准，gnits是严格标准，不推荐。

bin_PROGRAMS：表示要生成的可执行应用程序文件，这里的bin表示可执行文件在安装时需要被安装到系统中，如果只是想编译。不想被安装到系统中，可以用noinst_PROGRAMS来代替。

那么整个第一行 bin_PROGRAMS=client 详细表示什么意思那，解释如下：

PROGRAMS知道这是一个可执行文件。

client表示编译的目标文件。

如程序和图片所示，包括头文件，静态库的定义等等都是这种形式，如lib_LIBRARIES=util，表示将util库安装到lib目录下。

client_SOURCES：表示生成可执行应用程序所用的所有源文件，多个就空格隔开，我们注意到client_是由前面的bin_PROGRAMS指定的，如果前面是生成example, 那么这里也就变成example_SOURCES，其它的规则类似标识也是一样。

client_CPPFLAGS：这个和我们写Makefile的时候意思是一样的，都表示C语言的预处理器参数，这里指定了DCONFIG_DIR，以后在程序中，就可以直接使用CONFIG_DIR,不要把这个和另一个CFLAGS混淆，后者表示编译器参数。

client_LDFLAGS：表示在连接时所需要的库文件选项标识。这个也就是对应一些如-l,-shared等选项。

noinst_HEADERS：表示该头文件只是参加可执行文件的编译，而不用安装到安装目录下。如果需要安装到系统中，可以用include_HEADERS来代替。

INCLUDES：表示连接时所需要的头文件。

client_LDADD：表示连接时所需要的库文件,这里表示需要两个库文件的支持，下面会看到这个库文件又是怎么用Makefile.am文件后成的。

（在Makefile.am中尽量使用相对路径，系统预定义了两个基本路径）

$(sysconfdir)：在系统安装工具的时候，我们经常能遇到配置安装路径的命令，如：./configure –prefix=/install/apache 其实在调用这个之后，就定义了一个变量$(prefix), 表示安装的路径，如果没有指定安装的路径，会被安装到默认的路径，一般都是/usr/local。在定义$(prefix)，还有一些预定义好的目录,其实这一些定义都可以在顶层的Makefile文件中可以看到，如下面一些值：

bindir = $(prefix)/bin。

libdir = $(prefix)/lib。

datadir=$(prefix)/share。

sysconfdir=$(prefix)/etc。

includedir=$(prefix)/include。

这些量还可以用于定义其它目录，例如我想将client.h安装到include/client目录下，这样写Makefile.am文件：

clientincludedir=$(includedir)/client

clientinclude_HEADERS=$(top_srcdir)/client/client.h

这就达到了我的目的，相当于定义了一个安装类型，这种安装类型是将文件安装到include/client目录下。

四、配置静态库：

下面我们来说下编译静态库和编译动态库，我们说下静态库，下面这个例子比较简单。直接指定 XXXX_LTLIBRARIES或者XXXX_LIBRARIES就可以了。同样如果不需要安装到系统，将XXXX换成noinst就可以。

一般推荐使用libtool库编译目标，因为automake包含libtool，这对于跨平台可移植的库来说，肯定是一个福音。

看例子：

------------------------------------------------------------------------------------------------------------------------------------------------------------------

noinst_LTLIBRARIES = libutil.la

noinst_HEADERS = inaddr.h util.h compat.h pool.h xhash.h url.h device.h

libutil_la_SOURCES = access.c config.c datetime.c hex.c inaddr.c log.c device.c pool.c rate.c sha1.c stanza.c str.c xhash.c

libutil_la_LIBADD = @LDFLAGS@

------------------------------------------------------------------------------------------------------------------------------------------------------------------

第一行的noinst_LTLIBRARIES，这里要注意的是LTLIBRARIES，另外还有LIBRARIES，两个都表示库文件。前者表示libtool库，用法上基本是一样的。如果需要安装到系统中的话，用lib_LTLIBRARIES。

.la为libtool自动生成的一些共享库，vi编辑查看，主要记录了一些配置信息。可以用如下命令查看*.la文件的格式 $file *.la

.a为静态库,是好多个.o合在一起,用于静态连接

如果想编译 .a 文件，那么上面的配置就改成如下结果：

noinst_LTLIBRARIES = libutil.a

noinst_HEADERS = inaddr.h util.h compat.h pool.h xhash.h url.h device.h

ibutil_a_SOURCES = access.c config.c datetime.c hex.c inaddr.c log.c device.c pool.c rate.c sha1.c stanza.c str.c xhash.c

ibutil_a_LIBADD = @LDFLAGS@

注意：静态库编译连接时需要其它的库的话，采用XXXX_LIBADD选项，而不是前面的XXXX_LDADD。编译静态库是比较简单的，因为直接可以指定其类型。

五、配置动态库：

如果想要编译XXX.so动态库文件，需要用到_PROGRAMS类型，有一个关于安装路径的问题，如果希望将动态库安装到lib目录下，按照前面所说的，只需要写成lib_PROGRAMS就可以了，lib表示安装的路径，但是automake不允许这样直接定义，所以可以采用下面的办法，同样是将动态库安装到lib目录下：

projectlibdir=$(libdir)//新建一个目录，该目录就是lib目录

projectlib_PROGRAMS=project.so

project_so_SOURCES=xxx.C

project_so_LDFLAGS=-shared -fpic//GCC编译动态库的选项

这个动态库的编译写法是鹏博客网上总结的，希望有要的人自己来验证下。

六、SUBDIRS功能语法：

SUBDIRS这是一个很重要的词，我们前面生成了一个目标文件，但是一个大型的工程项目是由许多个可执行文件和库文件组成，也就是包含多个目录，每个目录下都有用于生成该目录下的目标文件的Makefile.am文件，但顶层目录是如何调用，才能使下面各个目录分别生成自己的目标文件呢？就是SUBDIRS关键词的用法了。

看一下我的工程项目，这是顶层的Makefile.am文件
EXTRA_DIST = Doxyfile.in README.win32 README.protocol contrib UPGRADE

devicedir = ${prefix}/device
device_DATA = package

SUBDIRS = etc man
if USE_LIBSUBST
SUBDIRS += subst
endif
SUBDIRS += tools io sessions util client dispatch server hash storage sms

SUBDIRS表示在处理目录之前，要递归处理哪些子目录，这里还要注意处理的顺序。比如我的client对sessions和utils这两上目标文件有依赖，就在client之前需要处理这两个目标文件。

EXTRA_DIST：将哪些文件一起打包。