MP4v2 2.0.0 Building the Repository
***********************************
Table of Contents
*****************
1 Overview
2 Introduction
3 Quickstart
4 Build Process
4.1 Checkout Sources
4.2 Boostrap (Autotools)
4.3 Configure
4.4 Build
4.5 Install
4.6 Create Distribution
4.7 Build Documentation
4.8 Post Site and API Documentation to project website.
5 Platform Notes
5.1 Mac OS X
5.1.1 Default Binaries
5.1.2 Release Binaries
5.1.3 Developer Binaries
5.1.4 Universal Binaries - all architectures
5.1.5 Universal Binaries - selected architectures
5.2 Linux
5.2.1 Default Binaries
5.2.2 Release Binaries
5.2.3 Developer Binaries
5.2.4 Bi-arch compilation
5.3 FreeBSD
5.3.1 Default Binaries
5.3.2 Release Binaries
5.3.3 Developer Binaries
5.3.4 Bi-arch compilation
5.4 Solaris
5.4.1 Default Binaries
5.4.2 Release Binaries
5.4.3 Developer Binaries
5.4.4 Bi-arch compilation
5.5 Cygwin
5.5.1 Default Binaries
5.5.2 Release Binaries
5.5.3 Developer Binaries
5.6 Windows
1 Overview
**********
The documented and supported method to build MP4v2 uses the GNU build
system (also known as the Autotools). You must first obtain the sources
by either downloading and extracting the source-distribution bundle or
working directly MP4v2's Subversion repository. We have build documents
for both methods, but unless you are a member of the MP4v2 project, you
are strongly encouraged to use the source-distribution method.
On other supported platforms which lack Autotools we provide an
alternative method for building the software. Please see the
appropriate platform section.
2 Introduction
**************
This document describes the recommended process to build MP4v2 from the
repository. This process is a superset of the process to build from a
source-distribution bundle. If you are interested in building from a
source-distribution bundle then this document is not for you.
3 Quickstart
************
This chapter is for the impatient or those just looking for a quick
summary of all the commands used in a typical build. You may skip this
summary and jump to *note Build Process::.
svn checkout https://mp4v2.googlecode.com/svn/releases/2.0.0 mp4v2
cd mp4v2
autoreconf -fiv
rm -fr build/
mkdir build/
cd build/
../configure
make
make install
make install-man
make dist
4 Build Process
***************
4.1 Checkout Sources
====================
Checkout sources from the project's Subversion repository.
Sources are checked out from either the trunk, release or a branch.
This document was generated from one of those, and for example
purposes, we will use exactly the same URL which used to create the
distribution which contains this document.
If you are a project member, then you may add the appropriate
login/password information as needed.
svn checkout https://mp4v2.googlecode.com/svn/releases/2.0.0 mp4v2
cd mp4v2
It is recommended to use Subversion 1.5.0 or higher. Lower versions
might work.
4.2 Boostrap (Autotools)
========================
The following command causes forces Autotools to regenerate all files
and install helper scripts needed at configure-time and to regenerate
all files.
autoreconf -fiv
If you are a project member and preparing for a release, it is
important to note that the versions of Autotools available in your path
will directly effect files added to the bundle. At the time of writing,
the following versions of Autotools are recommended; in some cases a
minimum is hard-coded and warnings will be issued if in violation:
* GNU autoconf 2.61 or higher (lower versions might work)
* GNU automake 1.10 or higher (lower versions might work)
* GNU libtool 1.5.26 or higher (lower versions might work)
4.3 Configure
=============
The following command configures the project for a build. It is highly
recommended that you invoke configure from an empty directory.
rm -fr build/
mkdir build/
cd build/
../configure
Please see `INSTALL' for details on configure usage, and standard
options. Additionally, the following custom options have been added to
`configure':
`--disable-debug'
Do not generate debug information. Do not direct compiler to
generate debugging information. By default the compiler will
generate debug information if the platform supports it.
`--disable-optimize'
Do not optimize. Do not direct compiler to optimize code. By
default compiler optimization is enabled if the platform supports
it.
`--disable-fvisibility'
Do not set default ELF symbol visibility. By default configure
attempts to detect if the compiler supports this feature. However
on some platforms detecting incompatibilty of this feature might
not be accurate in which case this option should be given.
`--disable-gch'
By default certain platforms are marked to use GCC precompiled
headers. Generally this greatly decrease build times but may
require more diligence for iterative development; that is to say
dependencies may not properly be tracked and more frequent `make
clean' may be required when headers are changed. Use this option
to disable GCC precompiled headers.
`--disable-largefile'
On some 32-bit platforms or configurations it might be desirable
to build without largefile (LFS) support. By default configure
attempts to detect formal LFS support and enables it if found.
`--disable-util'
Do not build/install utilities. This is convenience option for
users who desire to skip building the utilities (eg. command-line
executables) which are enabled by default.
`--enable-bi=ARCH'
On bi-arch capable platforms it is possible to generate 32 or 64
bit code. This is supported by adding arguments `-m32' or `-m64',
respectively, when compiling or linking. Use this option to
override the platform-specific default.
`--enable-ub[=ARCHS]'
On OSX systems it is possible to generate universal binaries. This
is supported by adding one or more argument patterns `-arch ARCH'
when compiling or linking. Use this option to either target an
architecture different from the platform default, or to produce
universal binaries.
`--enable-dependency-tracking'
Enable automatic dependency tracking for include-files. By default
this feature is disabled.
4.4 Build
=========
The following command will build MP4v2.
make
On some platforms `make' refers to a BSD-flavor of make which is not
compatible with this project. Check if `gmake' is installed, and if it
is, substitute `gmake' wherever you may see `make' in this document.
Otherwise you will need to install GNU make package version 3.81 or
higher. Lower versions might work.
4.5 Install
===========
The following command will install MP4v2.
make install
make install-man
4.6 Create Distribution
=======================
The following command will create a MP4v2 source distribution. It is
during this step that shipped documentation is generated.
make dist
This step in the build process introduces additional requirements to
the host system. While most of the following utilities are generally
available, `help2man' is used to generate man-pages; however if this
command is not available the man-pages will be empty. This is
acceptable for non-release builds but for full quality builds this
command is required.
* GNU help2man 1.36 or higher (lower versions should work)
* GNU tar 1.15.1 or higher (lower versions should work)
* GNU gzip 1.3.10 or higher (lower versions should work)
* bzip2 1.0.4 or higher (lower versions should work)
* Info-ZIP zip 2.32 or higher (lower versions should work)
4.7 Build Documentation
=======================
This step in the build process introduces some significant requirements
to the host system:
* GNU texinfo 4.8 or higher (