Documentation/Maemo 5 Developer Guide/GNU Build System - Revision history

sicelo at 18:23, 13 October 2014

sicelo — Mon, 13 Oct 2014 18:23:05 GMT

← Older revision		Revision as of 18:23, 13 October 2014
Line 1,160:		Line 1,160:
	For the purpose of this example, only one macro is used, <code>PKG_CHECK_MODULES</code>, which is used as part of <code>configure.ac</code> for pkg-config integration		For the purpose of this example, only one macro is used, <code>PKG_CHECK_MODULES</code>, which is used as part of <code>configure.ac</code> for pkg-config integration

-	<source lang="~~autoconf~~">	+	<source lang="text">
	# Check whether the necessary pkg-config packages are present. The		# Check whether the necessary pkg-config packages are present. The
	# PKG_CHECK_MODULES macro is supplied by pkg-config		# PKG_CHECK_MODULES macro is supplied by pkg-config

dukenukem at 18:58, 20 September 2012

dukenukem — Thu, 20 Sep 2012 18:58:37 GMT

← Older revision		Revision as of 18:58, 20 September 2012
Line 1,178:		Line 1,178:
	# Makefile or supplied by the user running ./configure.		# Makefile or supplied by the user running ./configure.
	CFLAGS="$HHW_CFLAGS $CFLAGS"		CFLAGS="$HHW_CFLAGS $CFLAGS"
-	LIBS="$HHW_LIBS $LIBS	+	LIBS="$HHW_LIBS $LIBS"
	</source>		</source>

amigadave: /* Checking for Distribution Sanity */ add link

amigadave — Fri, 12 Nov 2010 10:01:58 GMT

Checking for Distribution Sanity: add link

← Older revision		Revision as of 10:01, 12 November 2010
Line 1,119:		Line 1,119:
	To test whether building the software from the distribution tarball is possible, execute the distcheck-target. It first creates a distribution tarball, then extracts it in a new subdirectory, runs configure there and tries and builds the software with the default make target. If it fails, the relevant error is given.		To test whether building the software from the distribution tarball is possible, execute the distcheck-target. It first creates a distribution tarball, then extracts it in a new subdirectory, runs configure there and tries and builds the software with the default make target. If it fails, the relevant error is given.

-	Making the distcheck target each time before making a dist target is recommended, so that you can be sure that the distribution tarball can be used outside the source tree. This step is especially critical later when making Debian packages.	+	Making the distcheck target each time before making a dist target is recommended, so that you can be sure that the distribution tarball can be used outside the source tree. This step is especially critical later when [[packaging\|making Debian packages]].

	=== Cleaning up ===		=== Cleaning up ===

amigadave: use and `, wikify slightly, add links to examples`


amigadave — Fri, 12 Nov 2010 09:58:09 GMT
use <source> and <code>, wikify slightly, add links to examples
Show changes



amigadave: use 

amigadave — Tue, 07 Sep 2010 15:04:46 GMT
use <code>

		
		
		
		
		
		
		← Older revision
		Revision as of 15:04, 7 September 2010
		
		Line 1,150:
Line 1,150:
 Pkg-config comes with a macro package ('''pkg.m4'''), which contains some useful macros for integration. The best documentation for these can be found in the pkg-config manual pages.  Pkg-config comes with a macro package ('''pkg.m4'''), which contains some useful macros for integration. The best documentation for these can be found in the pkg-config manual pages.
  
- For the purpose of this example, only one macro is used, PKG_CHECK_MODULES, which is used as part of configure.ac for pkg-config integration + For the purpose of this example, only one macro is used, <code>PKG_CHECK_MODULES</code>, which is used as part of configure.ac for pkg-config integration
  
   <tt><span>''<span><font color="#9A1900"><nowiki># Check whether the necessary pkg-config packages are present. The</nowiki></font></span>''</span>    <tt><span>''<span><font color="#9A1900"><nowiki># Check whether the necessary pkg-config packages are present. The</nowiki></font></span>''</span>
Line 1,171:
Line 1,171:
   <span><font color="#009900">LIBS</font></span><span><font color="#990000"><nowiki>=</nowiki></font></span><span><font color="#FF0000">"$HHW_LIBS $LIBS"</font></span></tt>    <span><font color="#009900">LIBS</font></span><span><font color="#990000"><nowiki>=</nowiki></font></span><span><font color="#FF0000">"$HHW_LIBS $LIBS"</font></span></tt>
  
- The proper placing for this code is after all the AC_PROG_* checks and before the AC_OUTPUT macros (so that the build flags may affect the substituted files). + The proper placing for this code is after all the <code>AC_PROG_*</code> checks and before the <code>AC_OUTPUT</code> macros (so that the build flags may affect the substituted files).
  
 Check also the validity of the package names by using:  Check also the validity of the package names by using:




amigadave: /* Cleaning up */ use 
amigadave — Mon, 19 Jul 2010 14:30:15 GMT
Cleaning up:  use <source>

		
		
		
		
		
		
		← Older revision
		Revision as of 14:30, 19 July 2010
		
		Line 1,121:
Line 1,121:
 The contents of antigen.sh that is suitable for simple projects: autoconf-automake/example3/antigen.sh  The contents of antigen.sh that is suitable for simple projects: autoconf-automake/example3/antigen.sh
  
-  <tt><span>''<span><font color="#9A1900"><nowiki>#!/bin/sh</nowiki></font></span>''</span> + <source lang="bash">
-  <span>''<span><font color="#9A1900"><nowiki>#</nowiki></font></span>''</span> + #!/bin/sh
-  <span>''<span><font color="#9A1900"><nowiki># A utility script to remove all generated files.</nowiki></font></span>''</span> + #
-  <span>''<span><font color="#9A1900"><nowiki>#</nowiki></font></span>''</span> + # A utility script to remove all generated files.
-  <span>''<span><font color="#9A1900"><nowiki># Running autogen.sh will be required after running this script since</nowiki></font></span>''</span> + #
-  <span>''<span><font color="#9A1900"><nowiki># the 'configure' script will also be removed.</nowiki></font></span>''</span> + # Running autogen.sh will be required after running this script since
-  <span>''<span><font color="#9A1900"><nowiki>#</nowiki></font></span>''</span> + # the 'configure' script will also be removed.
-  <span>''<span><font color="#9A1900"><nowiki># This script is mainly useful when testing autoconf/automake changes</nowiki></font></span>''</span> + #
-  <span>''<span><font color="#9A1900"><nowiki># and as a part of their development process.</nowiki></font></span>''</span> + # This script is mainly useful when testing autoconf/automake changes
-  <span>''<span><font color="#9A1900"><nowiki># If there's a Makefile, then run the 'distclean' target first (which</nowiki></font></span>''</span> + # and as a part of their development process.
-  <span>''<span><font color="#9A1900"><nowiki># will also remove the Makefile).</nowiki></font></span>''</span> + # If there's a Makefile, then run the 'distclean' target first (which
-  <span>'''<span><font color="#0000FF">if</font></span>'''</span> <span>'''<span><font color="#0000FF">test</font></span>'''</span> -f Makefile<span><font color="#990000"><nowiki>;</nowiki></font></span> <span>'''<span><font color="#0000FF">then</font></span>'''</span> + # will also remove the Makefile).
-    make distclean + if test -f Makefile; then
-  <span>'''<span><font color="#0000FF">fi</font></span>'''</span> +   make distclean
-  <span>''<span><font color="#9A1900"><nowiki># Remove all tar-files (assuming there are some packages).</nowiki></font></span>''</span> + fi
-  rm -f <span><font color="#990000"><nowiki>*.</nowiki></font></span>tar<span><font color="#990000">.*</font></span> <span><font color="#990000"><nowiki>*.</nowiki></font></span>tgz + # Remove all tar-files (assuming there are some packages).
-  <span>''<span><font color="#9A1900"><nowiki># Also remove the autotools cache directory.</nowiki></font></span>''</span> + rm -f *.tar.* *.tgz
-  rm -Rf autom4te<span><font color="#990000">.</font></span>cache + # Also remove the autotools cache directory.
-  <span>''<span><font color="#9A1900"><nowiki># Remove rest of the generated files.</nowiki></font></span>''</span> + rm -Rf autom4te.cache
-  rm -f Makefile<span><font color="#990000">.</font></span><span>'''<span><font color="#0000FF">in</font></span>'''</span> aclocal<span><font color="#990000">.</font></span>m4 configure depcomp install-sh missing + # Remove rest of the generated files.
-  </tt> + rm -f Makefile.in aclocal.m4 configure depcomp install-sh missing
  + </source>
  
 === Integration with Pkg-Config ===  === Integration with Pkg-Config ===




amigadave: /* Introducing Automake */ use 
amigadave — Mon, 19 Jul 2010 14:21:51 GMT
Introducing Automake:  use <source>
Show changes


amigadave: /* Substitutions */ use ,  and 

amigadave — Mon, 19 Jul 2010 13:59:08 GMT
Substitutions:  use <source>, <pre> and <code>

		
		
		
		
		
		
		← Older revision
		Revision as of 13:59, 19 July 2010
		
		Line 772:
Line 772:
 This is best illustrated with a small example. The input file contents are listed after the autoconf configuration file. In this example, the substitution is only made for one file, but it is also possible to process multiple files using the substitution mechanism. autoconf-automake/example2/configure.ac  This is best illustrated with a small example. The input file contents are listed after the autoconf configuration file. In this example, the substitution is only made for one file, but it is also possible to process multiple files using the substitution mechanism. autoconf-automake/example2/configure.ac
  
-  <tt><span>''<span><font color="#9A1900"><nowiki># An example showing how to use a variable-based substitution.</nowiki></font></span>''</span> + <source lang="autoconf">
-  + # An example showing how to use a variable-based substitution.
-  AC_INIT<span><font color="#990000">(</font></span>hello<span><font color="#990000">,</font></span> version-<span><font color="#993399">0.1</font></span><span><font color="#990000">)</font></span> +  
-  + AC_INIT(hello, version-0.1)
-  AC_PROG_CC +  
-  AC_PROG_AWK + AC_PROG_CC
-  AC_CHECK_HEADER<span><font color="#990000">(</font></span>unistd<span><font color="#990000">.</font></span>h<span><font color="#990000">)</font></span> + AC_PROG_AWK
-  AC_CHECK_HEADERS<span><font color="#990000">([</font></span>math<span><font color="#990000">.</font></span>h stdio<span><font color="#990000">.</font></span>h<span><font color="#990000">])</font></span> + AC_CHECK_HEADER(unistd.h)
-  AC_CHECK_HEADER<span><font color="#990000">(</font></span>b0rk<span><font color="#990000">.</font></span>h<span><font color="#990000">,</font></span> <span><font color="#990000">[</font></span>echo <span><font color="#FF0000">"b0rk.h present in system"</font></span><span><font color="#990000">],</font></span> <span><font color="#990000">\</font></span> + AC_CHECK_HEADERS([math.h stdio.h])
-                          <span><font color="#990000">[</font></span>echo <span><font color="#FF0000">"b0rk.h not present in system"</font></span><span><font color="#990000">])</font></span> + AC_CHECK_HEADER(b0rk.h, [echo "b0rk.h present in system"], \
-  +                         [echo "b0rk.h not present in system"])
-  echo <span><font color="#FF0000">"But that doesn't stop us from continuing!"</font></span> +  
-  + echo "But that doesn't stop us from continuing!"
-  <span>''<span><font color="#9A1900"><nowiki># Run the test-output.txt(.in) through autoconf substitution logic.</nowiki></font></span>''</span> +  
-  AC_OUTPUT<span><font color="#990000">(</font></span>test-output<span><font color="#990000">.</font></span>txt<span><font color="#990000">)</font></span> + # Run the test-output.txt(.in) through autoconf substitution logic.
-  </tt> + AC_OUTPUT(test-output.txt)
  + </source>
  
 autoconf-automake/example2/test-output.txt.in  autoconf-automake/example2/test-output.txt.in
  
-  <code>This file will go through autoconf variable substitution. + <pre>
-  The output file will be named as 'test-output.txt' (the '.in'-suffix + This file will go through autoconf variable substitution.
-  is stripped). + The output file will be named as 'test-output.txt' (the '.in'-suffix
-  All the names surrounded by '@'-characters will be replaced by the values + is stripped).
-  of the variables (if present) by the configure script, when it is run + All the names surrounded by '@'-characters will be replaced by the values
-  by the end user. + of the variables (if present) by the configure script, when it is run
-  Prefix: @prefix@ + by the end user.
-  C compiler: @CC@ + Prefix: @prefix@
-  This is a name for which there is no variable. + C compiler: @CC@
-  Stuff: @stuff@</code> + This is a name for which there is no variable.
  + Stuff: @stuff@
  + </pre>
  
 We then run autoconf and configure:  We then run autoconf and configure:
  
-  [sbox-FREMANTLE_X86: ~/example2] &gt; autoconf + <pre>
-  [sbox-FREMANTLE_X86: ~/example2] &gt; ./configure + [sbox-FREMANTLE_X86: ~/example2] > autoconf
-  checking for gcc... gcc + [sbox-FREMANTLE_X86: ~/example2] > ./configure
-  checking for C compiler default output file name... a.out + checking for gcc... gcc
-  checking whether the C compiler works... yes + checking for C compiler default output file name... a.out
-  checking whether we are cross compiling... no + checking whether the C compiler works... yes
-  checking for suffix of executables... + checking whether we are cross compiling... no
-  checking for suffix of object files... o + checking for suffix of executables...
-  checking whether we are using the GNU C compiler... yes + checking for suffix of object files... o
-  checking whether gcc accepts -g... yes + checking whether we are using the GNU C compiler... yes
-  checking for gcc option to accept ANSI C... none needed + checking whether gcc accepts -g... yes
-  checking for gawk... gawk + checking for gcc option to accept ANSI C... none needed
-  checking how to run the C preprocessor... gcc -E + checking for gawk... gawk
-  checking for egrep... grep -E + checking how to run the C preprocessor... gcc -E
-  checking for ANSI C header files... yes + checking for egrep... grep -E
-  checking for sys/types.h... yes + checking for ANSI C header files... yes
-  checking for sys/stat.h... yes + checking for sys/types.h... yes
-  checking for stdlib.h... yes + checking for sys/stat.h... yes
-  checking for string.h... yes + checking for stdlib.h... yes  
-  checking for memory.h... yes + checking for string.h... yes
-  checking for strings.h... yes + checking for memory.h... yes
-  checking for inttypes.h... yes + checking for strings.h... yes
-  checking for stdint.h... yes + checking for inttypes.h... yes
-  checking for unistd.h... yes + checking for stdint.h... yes
-  checking for unistd.h... (cached) yes + checking for unistd.h... yes
-  checking math.h usability... yes + checking for unistd.h... (cached) yes
-  checking math.h presence... yes + checking math.h usability... yes
-  checking for math.h... yes + checking math.h presence... yes
-  checking stdio.h usability... yes + checking for math.h... yes
-  checking stdio.h presence... yes + checking stdio.h usability... yes
-  checking for stdio.h... yes + checking stdio.h presence... yes
-  checking b0rk.h usability... no + checking for stdio.h... yes
-  checking b0rk.h presence... no + checking b0rk.h usability... no
-  checking for b0rk.h... no + checking b0rk.h presence... no
-  b0rk.h not present in system + checking for b0rk.h... no
-  But that doesn't stop us from continuing! + b0rk.h not present in system
-  configure: creating ./config.status + But that doesn't stop us from continuing!
-  config.status: creating test-output.txt + configure: creating ./config.status
-  [sbox-FREMANTLE_X86: ~/example2] &gt; cat test-output.txt + config.status: creating test-output.txt
-  This file will go through autoconf variable substitution. + [sbox-FREMANTLE_X86: ~/example2] > cat test-output.txt
-  + This file will go through autoconf variable substitution.
-  The output file will be named as 'test-output.txt' (the '.in'-suffix +  
-  is stripped). + The output file will be named as 'test-output.txt' (the '.in'-suffix
-  + is stripped).
-  All names surrounded by '@'-characters will be replaced by the values +  
-  of the variables (if present) by the configure script when it is run + All names surrounded by '@'-characters will be replaced by the values
-  by end user. + of the variables (if present) by the configure script when it is run
-  + by end user.
-  Prefix: /usr/local +  
-  C compiler: gcc + Prefix: /usr/local
-  + C compiler: gcc
-  This is a name for which there is no variable. + 
-  Stuff: @stuff@ + 
  
  + This is a name for which there is no variable.
  + Stuff: @stuff@
  + </pre>
  
- This feature is used later on. When you run your own version of the file, notice the creation of file called '''config.status'''. It is the file that actually does the substitution for external files, so if the configuration is otherwise complex, and you only want to re-run the substitution of the output files, you can run the config.status script. + This feature is used later on. When you run your own version of the file, notice the creation of file called <code>config.status</code>. It is the file that actually does the substitution for external files, so if the configuration is otherwise complex, and you only want to re-run the substitution of the output files, you can run the config.status script.
  
 === Introducing Automake ===  === Introducing Automake ===




amigadave: /* GNU Autoconf */ use  and 

amigadave — Mon, 19 Jul 2010 13:53:47 GMT
GNU Autoconf:  use <source> and <code>
Show changes


amigadave: /* Recursive Variables */ use 
amigadave — Mon, 19 Jul 2010 13:47:32 GMT
Recursive Variables:  use <source>

		
		
		
		
		
		
		← Older revision
		Revision as of 13:47, 19 July 2010
		
		Line 396:
Line 396:
 Now the previously used makefile is reused, but some variables are introduced. This also shows the syntax of defining the variables, and how to use them (reference them): simple-make-files/Makefile.5  Now the previously used makefile is reused, but some variables are introduced. This also shows the syntax of defining the variables, and how to use them (reference them): simple-make-files/Makefile.5
  
-  <tt><span>''<span><font color="#9A1900"><nowiki># define the command that we use for compilation</nowiki></font></span>''</span> + <source lang="make">
-  CC <span><font color="#990000"><nowiki>=</nowiki></font></span> gcc -Wall + # define the command that we use for compilation
-  <span>''<span><font color="#9A1900"><nowiki># which targets do we want to build by default?</nowiki></font></span>''</span> + CC = gcc -Wall
-  <span>''<span><font color="#9A1900"><nowiki># note that 'targets' is just a variable, its name</nowiki></font></span>''</span> + # which targets do we want to build by default?
-  <span>''<span><font color="#9A1900"><nowiki># does not have any special meaning to make</nowiki></font></span>''</span> + # note that 'targets' is just a variable, its name
-  targets <span><font color="#990000"><nowiki>=</nowiki></font></span> hello + # does not have any special meaning to make
-  <span>''<span><font color="#9A1900"><nowiki># first target defined will be the default target</nowiki></font></span>''</span> + targets = hello
-  <span>''<span><font color="#9A1900"><nowiki># we use the variable to hold the dependencies</nowiki></font></span>''</span> + # first target defined will be the default target
-  <span><font color="#990000">.</font></span>PHONY<span><font color="#990000"><nowiki>:</nowiki></font></span> all + # we use the variable to hold the dependencies
-  all<span><font color="#990000"><nowiki>:</nowiki></font></span> <span><font color="#009900">$(targets)</font></span> + .PHONY: all
-  hello<span><font color="#990000"><nowiki>:</nowiki></font></span> hello<span><font color="#990000">.</font></span>o hello_func<span><font color="#990000">.</font></span>o + all: $(targets)
-          <span><font color="#009900">$(CC)</font></span> hello<span><font color="#990000">.</font></span>o hello_func<span><font color="#990000">.</font></span>o -o hello + hello: hello.o hello_func.o
-  hello<span><font color="#990000">.</font></span>o<span><font color="#990000"><nowiki>:</nowiki></font></span> hello<span><font color="#990000">.</font></span>c hello_api<span><font color="#990000">.</font></span>h +         $(CC) hello.o hello_func.o -o hello
-          <span><font color="#009900">$(CC)</font></span> -c hello<span><font color="#990000">.</font></span>c -o hello<span><font color="#990000">.</font></span>o + hello.o: hello.c hello_api.h
-  hello_func<span><font color="#990000">.</font></span>o<span><font color="#990000"><nowiki>:</nowiki></font></span> hello_func<span><font color="#990000">.</font></span>c hello_api<span><font color="#990000">.</font></span>h +         $(CC) -c hello.c -o hello.o
-          <span><font color="#009900">$(CC)</font></span> -c hello_func<span><font color="#990000">.</font></span>c -o hello_func<span><font color="#990000">.</font></span>o + hello_func.o: hello_func.c hello_api.h
-  <span>''<span><font color="#9A1900"><nowiki># we'll make our cleaning target more powerful</nowiki></font></span>''</span> +         $(CC) -c hello_func.c -o hello_func.o
-  <span>''<span><font color="#9A1900"><nowiki># we remove the targets that we build by default and also</nowiki></font></span>''</span> + # we'll make our cleaning target more powerful
-  <span>''<span><font color="#9A1900"><nowiki># remove all object files</nowiki></font></span>''</span> + # we remove the targets that we build by default and also
-  <span><font color="#990000">.</font></span>PHONY<span><font color="#990000"><nowiki>:</nowiki></font></span> clean + # remove all object files
-  clean<span><font color="#990000"><nowiki>:</nowiki></font></span> + .PHONY: clean
-          rm -f <span><font color="#009900">$(targets)</font></span> <span><font color="#990000"><nowiki>*.</nowiki></font></span>o + clean:
-  </tt> +         rm -f $(targets) *.o
  + </source>
  
 The CC variable is the standard variable to hold the name of the C compiler executable. GNU make comes preloaded with a list of tools that can be accessed in similar way (as will be shown with $(RM) shortly, but there are others). Most UNIX tools related to building software already have similar pre-defined variables in GNU make. Here one of them is overridden to demonstrate how it is done. Overriding variables like this is not recommended, because the user running make later might want to use some other compiler, and would have to edit the makefile to do so.  The CC variable is the standard variable to hold the name of the C compiler executable. GNU make comes preloaded with a list of tools that can be accessed in similar way (as will be shown with $(RM) shortly, but there are others). Most UNIX tools related to building software already have similar pre-defined variables in GNU make. Here one of them is overridden to demonstrate how it is done. Overriding variables like this is not recommended, because the user running make later might want to use some other compiler, and would have to edit the makefile to do so.

← Older revision		Revision as of 15:04, 7 September 2010
Line 1,150:		Line 1,150:
	Pkg-config comes with a macro package ('''pkg.m4'''), which contains some useful macros for integration. The best documentation for these can be found in the pkg-config manual pages.		Pkg-config comes with a macro package ('''pkg.m4'''), which contains some useful macros for integration. The best documentation for these can be found in the pkg-config manual pages.

-	For the purpose of this example, only one macro is used, PKG_CHECK_MODULES, which is used as part of configure.ac for pkg-config integration	+	For the purpose of this example, only one macro is used, <code>PKG_CHECK_MODULES</code>, which is used as part of configure.ac for pkg-config integration

	<tt><span>''<span><font color="#9A1900"><nowiki># Check whether the necessary pkg-config packages are present. The</nowiki></font></span>''</span>		<tt><span>''<span><font color="#9A1900"><nowiki># Check whether the necessary pkg-config packages are present. The</nowiki></font></span>''</span>
Line 1,171:		Line 1,171:
	<span><font color="#009900">LIBS</font></span><span><font color="#990000"><nowiki>=</nowiki></font></span><span><font color="#FF0000">"$HHW_LIBS $LIBS"</font></span></tt>		<span><font color="#009900">LIBS</font></span><span><font color="#990000"><nowiki>=</nowiki></font></span><span><font color="#FF0000">"$HHW_LIBS $LIBS"</font></span></tt>

-	The proper placing for this code is after all the AC_PROG_* checks and before the AC_OUTPUT macros (so that the build flags may affect the substituted files).	+	The proper placing for this code is after all the <code>AC_PROG_*</code> checks and before the <code>AC_OUTPUT</code> macros (so that the build flags may affect the substituted files).

	Check also the validity of the package names by using:		Check also the validity of the package names by using:

← Older revision		Revision as of 14:30, 19 July 2010
Line 1,121:		Line 1,121:
	The contents of antigen.sh that is suitable for simple projects: autoconf-automake/example3/antigen.sh		The contents of antigen.sh that is suitable for simple projects: autoconf-automake/example3/antigen.sh

-	<~~tt><span>''<span><font color~~="~~#9A1900~~">~~<nowiki>~~#!/bin/sh~~</nowiki></font></span>''</span>~~	+	<source lang="bash">
-	~~<span>''<span><font color="~~#~~9A1900"><nowiki>#</nowiki></font></span>''</span>~~	+	#!/bin/sh
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# A utility script to remove all generated files.~~</nowiki></font></span>''</span>~~	+	#
-	~~<span>''<span><font color="~~#~~9A1900"><nowiki>#</nowiki></font></span>''</span>~~	+	# A utility script to remove all generated files.
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# Running autogen.sh will be required after running this script since~~</nowiki></font></span>''</span>~~	+	#
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# the 'configure' script will also be removed.~~</nowiki></font></span>''</span>~~	+	# Running autogen.sh will be required after running this script since
-	~~<span>''<span><font color="~~#~~9A1900"><nowiki>#</nowiki></font></span>''</span>~~	+	# the 'configure' script will also be removed.
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# This script is mainly useful when testing autoconf/automake changes~~</nowiki></font></span>''</span>~~	+	#
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# and as a part of their development process.~~</nowiki></font></span>''</span>~~	+	# This script is mainly useful when testing autoconf/automake changes
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# If there's a Makefile, then run the 'distclean' target first (which~~</nowiki></font></span>''</span>~~	+	# and as a part of their development process.
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# will also remove the Makefile).~~</nowiki></font></span>''</span>~~	+	# If there's a Makefile, then run the 'distclean' target first (which
-	~~<span>'''<span><font color="#0000FF">~~if~~</font></span>'''</span> <span>'''<span><font color="#0000FF">~~test~~</font></span>'''</span>~~ -f Makefile~~<span><font color="#990000"><nowiki>~~;~~</nowiki></font></span> <span>'''<span><font color="#0000FF">~~then~~</font></span>'''</span>~~	+	# will also remove the Makefile).
-	make distclean	+	if test -f Makefile; then
-	~~<span>'''<span><font color="#0000FF">~~fi~~</font></span>'''</span>~~	+	make distclean
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# Remove all tar-files (assuming there are some packages).~~</nowiki></font></span>''</span>~~	+	fi
-	rm -f ~~<span><font color="#990000"><nowiki>~~.~~</nowiki></font></span>~~tar~~<span><font color="#990000">~~.~~</font></span> <span><font color="#990000"><nowiki>~~*.~~</nowiki></font></span>~~tgz	+	# Remove all tar-files (assuming there are some packages).
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# Also remove the autotools cache directory.~~</nowiki></font></span>''</span>~~	+	rm -f .tar. *.tgz
-	rm -Rf autom4te~~<span><font color="#990000">~~.~~</font></span>~~cache	+	# Also remove the autotools cache directory.
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# Remove rest of the generated files.~~</nowiki></font></span>''</span>~~	+	rm -Rf autom4te.cache
-	rm -f Makefile~~<span><font color="#990000">~~.~~</font></span><span>'''<span><font color="#0000FF">~~in~~</font></span>'''</span>~~ aclocal~~<span><font color="#990000">~~.~~</font></span>~~m4 configure depcomp install-sh missing	+	# Remove rest of the generated files.
-	</tt>	+	rm -f Makefile.in aclocal.m4 configure depcomp install-sh missing
		+	</source>

	=== Integration with Pkg-Config ===		=== Integration with Pkg-Config ===

← Older revision		Revision as of 13:59, 19 July 2010
Line 772:		Line 772:
	This is best illustrated with a small example. The input file contents are listed after the autoconf configuration file. In this example, the substitution is only made for one file, but it is also possible to process multiple files using the substitution mechanism. autoconf-automake/example2/configure.ac		This is best illustrated with a small example. The input file contents are listed after the autoconf configuration file. In this example, the substitution is only made for one file, but it is also possible to process multiple files using the substitution mechanism. autoconf-automake/example2/configure.ac

-	<~~tt><span>''<span><font color~~="~~#9A1900~~">~~<nowiki>~~# An example showing how to use a variable-based substitution.~~</nowiki></font></span>''</span>~~	+	<source lang="autoconf">
-		+	# An example showing how to use a variable-based substitution.
-	AC_INIT~~<span><font color="#990000">~~(~~</font></span>~~hello~~<span><font color="#990000">~~,~~</font></span>~~ version-~~<span><font color="#993399">~~0.1~~</font></span><span><font color="#990000">~~)~~</font></span>~~	+
-		+	AC_INIT(hello, version-0.1)
-	AC_PROG_CC	+
-	AC_PROG_AWK	+	AC_PROG_CC
-	AC_CHECK_HEADER~~<span><font color="#990000">~~(~~</font></span>~~unistd~~<span><font color="#990000">~~.~~</font></span>~~h~~<span><font color="#990000">~~)~~</font></span>~~	+	AC_PROG_AWK
-	AC_CHECK_HEADERS~~<span><font color="#990000">~~([~~</font></span>~~math~~<span><font color="#990000">~~.~~</font></span>~~h stdio~~<span><font color="#990000">~~.~~</font></span>~~h~~<span><font color="#990000">~~])~~</font></span>~~	+	AC_CHECK_HEADER(unistd.h)
-	AC_CHECK_HEADER~~<span><font color="#990000">~~(~~</font></span>~~b0rk~~<span><font color="#990000">~~.~~</font></span>~~h~~<span><font color="#990000">~~,~~</font></span> <span><font color="#990000">~~[~~</font></span>~~echo ~~<span><font color="#FF0000">~~"b0rk.h present in system"~~</font></span><span><font color="#990000">~~],~~</font></span> <span><font color="#990000">~~\~~</font></span>~~	+	AC_CHECK_HEADERS([math.h stdio.h])
-	~~<span><font color="#990000">~~[~~</font></span>~~echo ~~<span><font color="#FF0000">~~"b0rk.h not present in system"~~</font></span><span><font color="#990000">~~])~~</font></span>~~	+	AC_CHECK_HEADER(b0rk.h, [echo "b0rk.h present in system"], \
-		+	[echo "b0rk.h not present in system"])
-	echo ~~<span><font color="#FF0000">~~"But that doesn't stop us from continuing!"~~</font></span>~~	+
-		+	echo "But that doesn't stop us from continuing!"
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# Run the test-output.txt(.in) through autoconf substitution logic.~~</nowiki></font></span>''</span>~~	+
-	AC_OUTPUT~~<span><font color="#990000">~~(~~</font></span>~~test-output~~<span><font color="#990000">~~.~~</font></span>~~txt~~<span><font color="#990000">~~)~~</font></span>~~	+	# Run the test-output.txt(.in) through autoconf substitution logic.
-	</tt>	+	AC_OUTPUT(test-output.txt)
		+	</source>

	autoconf-automake/example2/test-output.txt.in		autoconf-automake/example2/test-output.txt.in

-	<~~code~~>This file will go through autoconf variable substitution.	+	<pre>
-	The output file will be named as 'test-output.txt' (the '.in'-suffix	+	This file will go through autoconf variable substitution.
-	is stripped).	+	The output file will be named as 'test-output.txt' (the '.in'-suffix
-	All the names surrounded by '@'-characters will be replaced by the values	+	is stripped).
-	of the variables (if present) by the configure script, when it is run	+	All the names surrounded by '@'-characters will be replaced by the values
-	by the end user.	+	of the variables (if present) by the configure script, when it is run
-	Prefix: @prefix@	+	by the end user.
-	C compiler: @CC@	+	Prefix: @prefix@
-	This is a name for which there is no variable.	+	C compiler: @CC@
-	Stuff: @stuff@</~~code~~>	+	This is a name for which there is no variable.
		+	Stuff: @stuff@
		+	</pre>

	We then run autoconf and configure:		We then run autoconf and configure:

-	[sbox-FREMANTLE_X86: ~/example2] ~~>~~ autoconf	+	<pre>
-	[sbox-FREMANTLE_X86: ~/example2] ~~>~~ ./configure	+	[sbox-FREMANTLE_X86: ~/example2] > autoconf
-	checking for gcc... gcc	+	[sbox-FREMANTLE_X86: ~/example2] > ./configure
-	checking for C compiler default output file name... a.out	+	checking for gcc... gcc
-	checking whether the C compiler works... yes	+	checking for C compiler default output file name... a.out
-	checking whether we are cross compiling... no	+	checking whether the C compiler works... yes
-	checking for suffix of executables...	+	checking whether we are cross compiling... no
-	checking for suffix of object files... o	+	checking for suffix of executables...
-	checking whether we are using the GNU C compiler... yes	+	checking for suffix of object files... o
-	checking whether gcc accepts -g... yes	+	checking whether we are using the GNU C compiler... yes
-	checking for gcc option to accept ANSI C... none needed	+	checking whether gcc accepts -g... yes
-	checking for gawk... gawk	+	checking for gcc option to accept ANSI C... none needed
-	checking how to run the C preprocessor... gcc -E	+	checking for gawk... gawk
-	checking for egrep... grep -E	+	checking how to run the C preprocessor... gcc -E
-	checking for ANSI C header files... yes	+	checking for egrep... grep -E
-	checking for sys/types.h... yes	+	checking for ANSI C header files... yes
-	checking for sys/stat.h... yes	+	checking for sys/types.h... yes
-	checking for stdlib.h... yes	+	checking for sys/stat.h... yes
-	checking for string.h... yes	+	checking for stdlib.h... yes
-	checking for memory.h... yes	+	checking for string.h... yes
-	checking for strings.h... yes	+	checking for memory.h... yes
-	checking for inttypes.h... yes	+	checking for strings.h... yes
-	checking for stdint.h... yes	+	checking for inttypes.h... yes
-	checking for unistd.h... yes	+	checking for stdint.h... yes
-	checking for unistd.h... (cached) yes	+	checking for unistd.h... yes
-	checking math.h usability... yes	+	checking for unistd.h... (cached) yes
-	checking math.h presence... yes	+	checking math.h usability... yes
-	checking for math.h... yes	+	checking math.h presence... yes
-	checking stdio.h usability... yes	+	checking for math.h... yes
-	checking stdio.h presence... yes	+	checking stdio.h usability... yes
-	checking for stdio.h... yes	+	checking stdio.h presence... yes
-	checking b0rk.h usability... no	+	checking for stdio.h... yes
-	checking b0rk.h presence... no	+	checking b0rk.h usability... no
-	checking for b0rk.h... no	+	checking b0rk.h presence... no
-	b0rk.h not present in system	+	checking for b0rk.h... no
-	But that doesn't stop us from continuing!	+	b0rk.h not present in system
-	configure: creating ./config.status	+	But that doesn't stop us from continuing!
-	config.status: creating test-output.txt	+	configure: creating ./config.status
-	[sbox-FREMANTLE_X86: ~/example2] ~~>~~ cat test-output.txt	+	config.status: creating test-output.txt
-	This file will go through autoconf variable substitution.	+	[sbox-FREMANTLE_X86: ~/example2] > cat test-output.txt
-		+	This file will go through autoconf variable substitution.
-	The output file will be named as 'test-output.txt' (the '.in'-suffix	+
-	is stripped).	+	The output file will be named as 'test-output.txt' (the '.in'-suffix
-		+	is stripped).
-	All names surrounded by '@'-characters will be replaced by the values	+
-	of the variables (if present) by the configure script when it is run	+	All names surrounded by '@'-characters will be replaced by the values
-	by end user.	+	of the variables (if present) by the configure script when it is run
-		+	by end user.
-	Prefix: /usr/local	+
-	C compiler: gcc	+	Prefix: /usr/local
-		+	C compiler: gcc
-	~~This is a name for which there is no variable.~~	+
-	~~Stuff: @stuff@~~	+

		+	This is a name for which there is no variable.
		+	Stuff: @stuff@
		+	</pre>

-	This feature is used later on. When you run your own version of the file, notice the creation of file called ~~'''~~config.status~~'''~~. It is the file that actually does the substitution for external files, so if the configuration is otherwise complex, and you only want to re-run the substitution of the output files, you can run the config.status script.	+	This feature is used later on. When you run your own version of the file, notice the creation of file called <code>config.status</code>. It is the file that actually does the substitution for external files, so if the configuration is otherwise complex, and you only want to re-run the substitution of the output files, you can run the config.status script.

	=== Introducing Automake ===		=== Introducing Automake ===

← Older revision		Revision as of 13:47, 19 July 2010
Line 396:		Line 396:
	Now the previously used makefile is reused, but some variables are introduced. This also shows the syntax of defining the variables, and how to use them (reference them): simple-make-files/Makefile.5		Now the previously used makefile is reused, but some variables are introduced. This also shows the syntax of defining the variables, and how to use them (reference them): simple-make-files/Makefile.5

-	<~~tt><span>''<span><font color~~="~~#9A1900~~">~~<nowiki>~~# define the command that we use for compilation~~</nowiki></font></span>''</span>~~	+	<source lang="make">
-	CC ~~<span><font color~~=~~"#990000"><nowiki>=</nowiki></font></span>~~ gcc -Wall	+	# define the command that we use for compilation
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# which targets do we want to build by default?~~</nowiki></font></span>''</span>~~	+	CC = gcc -Wall
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# note that 'targets' is just a variable, its name~~</nowiki></font></span>''</span>~~	+	# which targets do we want to build by default?
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# does not have any special meaning to make~~</nowiki></font></span>''</span>~~	+	# note that 'targets' is just a variable, its name
-	targets ~~<span><font color~~=~~"#990000"><nowiki>=</nowiki></font></span>~~ hello	+	# does not have any special meaning to make
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# first target defined will be the default target~~</nowiki></font></span>''</span>~~	+	targets = hello
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# we use the variable to hold the dependencies~~</nowiki></font></span>''</span>~~	+	# first target defined will be the default target
-	~~<span><font color="#990000">~~.~~</font></span>~~PHONY~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span>~~ all	+	# we use the variable to hold the dependencies
-	all~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span> <span><font color="#009900">~~$(targets)~~</font></span>~~	+	.PHONY: all
-	hello~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span>~~ hello~~<span><font color="#990000">~~.~~</font></span>~~o hello_func~~<span><font color="#990000">~~.~~</font></span>~~o	+	all: $(targets)
-	~~<span><font color="#009900">~~$(CC)~~</font></span>~~ hello~~<span><font color="#990000">~~.~~</font></span>~~o hello_func~~<span><font color="#990000">~~.~~</font></span>~~o -o hello	+	hello: hello.o hello_func.o
-	hello~~<span><font color="#990000">~~.~~</font></span>~~o~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span>~~ hello~~<span><font color="#990000">~~.~~</font></span>~~c hello_api~~<span><font color="#990000">~~.~~</font></span>~~h	+	$(CC) hello.o hello_func.o -o hello
-	~~<span><font color="#009900">~~$(CC)~~</font></span>~~ -c hello~~<span><font color="#990000">~~.~~</font></span>~~c -o hello~~<span><font color="#990000">~~.~~</font></span>~~o	+	hello.o: hello.c hello_api.h
-	hello_func~~<span><font color="#990000">~~.~~</font></span>~~o~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span>~~ hello_func~~<span><font color="#990000">~~.~~</font></span>~~c hello_api~~<span><font color="#990000">~~.~~</font></span>~~h	+	$(CC) -c hello.c -o hello.o
-	~~<span><font color="#009900">~~$(CC)~~</font></span>~~ -c hello_func~~<span><font color="#990000">~~.~~</font></span>~~c -o hello_func~~<span><font color="#990000">~~.~~</font></span>~~o	+	hello_func.o: hello_func.c hello_api.h
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# we'll make our cleaning target more powerful~~</nowiki></font></span>''</span>~~	+	$(CC) -c hello_func.c -o hello_func.o
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# we remove the targets that we build by default and also~~</nowiki></font></span>''</span>~~	+	# we'll make our cleaning target more powerful
-	~~<span>''<span><font color="#9A1900"><nowiki>~~# remove all object files~~</nowiki></font></span>''</span>~~	+	# we remove the targets that we build by default and also
-	~~<span><font color="#990000">~~.~~</font></span>~~PHONY~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span>~~ clean	+	# remove all object files
-	clean~~<span><font color="#990000"><nowiki>~~:~~</nowiki></font></span>~~	+	.PHONY: clean
-	rm -f ~~<span><font color="#009900">~~$(targets)~~</font></span> <span><font color="#990000"><nowiki>~~*.~~</nowiki></font></span>~~o	+	clean:
-	</tt>	+	rm -f $(targets) *.o
		+	</source>

	The CC variable is the standard variable to hold the name of the C compiler executable. GNU make comes preloaded with a list of tools that can be accessed in similar way (as will be shown with $(RM) shortly, but there are others). Most UNIX tools related to building software already have similar pre-defined variables in GNU make. Here one of them is overridden to demonstrate how it is done. Overriding variables like this is not recommended, because the user running make later might want to use some other compiler, and would have to edit the makefile to do so.		The CC variable is the standard variable to hold the name of the C compiler executable. GNU make comes preloaded with a list of tools that can be accessed in similar way (as will be shown with $(RM) shortly, but there are others). Most UNIX tools related to building software already have similar pre-defined variables in GNU make. Here one of them is overridden to demonstrate how it is done. Overriding variables like this is not recommended, because the user running make later might want to use some other compiler, and would have to edit the makefile to do so.

Documentation/Maemo 5 Developer Guide/GNU Build System - Revision history

sicelo at 18:23, 13 October 2014

dukenukem at 18:58, 20 September 2012

amigadave: /* Checking for Distribution Sanity */ add link

amigadave: use and , wikify slightly, add links to examples

amigadave: use

amigadave: /* Cleaning up */ use

amigadave: /* Introducing Automake */ use

amigadave: /* Substitutions */ use , and

amigadave: /* GNU Autoconf */ use and

amigadave: /* Recursive Variables */ use

amigadave: use and `, wikify slightly, add links to examples`

amigadave: /* Substitutions */ use ,
and