Preface
This document is part of the LiveSupport
project, Copyright © 2004 Media
Development Loan Fund, under the GNU GPL.
- Author: $Author: maroy $
- Version: $Revision: 1.2 $
- Location: $Source:
/home/cvs/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html,v
$
Scope
This document describes the autoconf configure file conventions for the
LiveSupport
project. See also the generic description of the file
conventions in the LiveSupport
project.
Introduction
Autoconf configure input files are processed by GNU autoconf and automake to generate
a configure script, which in turn generates Makefiles and other files
based on the system specifics it is run on. These are text
based files, thus they should adhere to the generic text-based
conventions.
Naming
Autoconf configure files are named either configure.ac
(for autoconf) or sometimes configure.am
(for automake).
Structure
Autoconf configure files are partitioned by using the following 80
column
wide partitioning comment:
dnl-----------------------------------------------------------------------------
dnl This is the title of the partition
dnl-----------------------------------------------------------------------------
The file has the
following mandatory structure:
- Header
- Additional sections+
Header
The header holds all information mandated by the generic guidelines, but
starting with the autoconf comment sequence dnl
. Note the
80
column wide partitioning delimiter enclosing the header.
dnl-----------------------------------------------------------------------------
dnl Copyright (c) 2004 Media Development Loan Fund
dnl
dnl This file is part of the LiveSupport project.
dnl http://livesupport.campware.org/
dnl To report bugs, send an e-mail to bugs@campware.org
dnl
dnl LiveSupport is free software; you can redistribute it and/or modify
dnl it under the terms of the GNU General Public License as published by
dnl the Free Software Foundation; either version 2 of the License, or
dnl (at your option) any later version.
dnl
dnl LiveSupport is distributed in the hope that it will be useful,
dnl but WITHOUT ANY WARRANTY; without even the implied warranty of
dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
dnl GNU General Public License for more details.
dnl
dnl You should have received a copy of the GNU General Public License
dnl along with LiveSupport; if not, write to the Free Software
dnl Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
dnl
dnl
dnl Author : $Author: maroy $
dnl Version : $Revision: 1.2 $
dnl Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/doc/developmentEnvironment/autoconfConfigureConventions.html,v $
dnl-----------------------------------------------------------------------------
Additional sections
Additional sections contain the autoconf configuration macro calls.
Bigger
parts of the file may be partitioned by the partitioning commend seen
above.
Template
See a generic template
for autoconf configurations. You may freely copy this
template when starting to create a new document.