summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorjstebbins <[email protected]>2014-04-14 16:33:44 +0000
committerjstebbins <[email protected]>2014-04-14 16:33:44 +0000
commitc973315226c1009f2cadc8a14e5219c1ef5d69c2 (patch)
treeb15e52e998ec246a2fbbe8f0916c3d08147f8127
parent6db1a1e531ad62ba977f4587fb9011b0fd0b3416 (diff)
doc: fix duplicate libdvdread entry in lib list.
git-svn-id: svn://svn.handbrake.fr/HandBrake/trunk@6164 b64f7644-9d1e-0410-96f1-a4d463321fa5
-rw-r--r--doc/BUILD-Linux10
-rw-r--r--doc/BUILD-Mac505
-rw-r--r--doc/BUILD-MinGW384
-rw-r--r--doc/texi/building/chapter.via.terminal.texi2
4 files changed, 394 insertions, 507 deletions
diff --git a/doc/BUILD-Linux b/doc/BUILD-Linux
index 2a9f239f5..9bfd47700 100644
--- a/doc/BUILD-Linux
+++ b/doc/BUILD-Linux
@@ -1,4 +1,4 @@
-Guide to Building HandBrake svn6092 (2014030201) on Linux
+Guide to Building HandBrake svn6163 (2014041401) on Linux
*********************************************************
1 Introduction
@@ -357,8 +357,8 @@ scoped targets:
Contrib modules such as 'a52dec', 'bzip2', 'faac', 'faad2', 'ffmpeg',
'fontconfig', 'freetype', 'fribidi', 'lame', 'libass', 'libbluray',
-'libdca', 'libdvdnav', 'libdvdread', 'libdvdread', 'libiconv', 'libmkv',
-'libogg', 'libsamplerate', 'libtheora', 'libvorbis', 'libxml2', 'mp4v2',
+'libdca', 'libdvdnav', 'libdvdread', 'libiconv', 'libmkv', 'libogg',
+'libsamplerate', 'libtheora', 'libvorbis', 'libxml2', 'mp4v2',
'mpeg2dec', 'x264', 'yasm' and 'zlib' have the following scoped targets:
'make MODULE.fetch'
@@ -501,6 +501,6 @@ Appendix A Project Repository Details
root: svn://svn.handbrake.fr/HandBrake
branch: trunk
uuid: b64f7644-9d1e-0410-96f1-a4d463321fa5
- rev: 6092
- date: 2014-03-02 06:18:36 -0700
+ rev: 6163
+ date: 2014-04-13 09:22:16 -0700
type: developer
diff --git a/doc/BUILD-Mac b/doc/BUILD-Mac
index 9e8227d9a..0c4e4b0b8 100644
--- a/doc/BUILD-Mac
+++ b/doc/BUILD-Mac
@@ -1,145 +1,118 @@
-Build Guide for HandBrake 5388svn on Mac OS X
+Build Guide for HandBrake 6163svn on Mac OS X
*********************************************
-Table of Contents
-*****************
-
1 Introduction
2 Prerequisites
3 QuickStart
4 Overview
5 Building via Terminal
- 5.1 Checkout Sources
- 5.2 Configure
- 5.3 Build
- 5.4 Make Targets
- 5.4.1 Global
- 5.4.2 General Modules
- 5.4.3 Contrib Modules
- 5.4.4 Contrib Touch and Untouch
- 5.4.5 Contrib Aggregates
- 5.5 Customizing Make
- 5.6 Universal Binaries
+5.1 Checkout Sources
+5.2 Configure
+5.3 Build
+5.4 Make Targets
+ 5.4.1 Global
+ 5.4.2 General Modules
+ 5.4.3 Contrib Modules
+ 5.4.4 Contrib Touch and Untouch
+ 5.4.5 Contrib Aggregates
+5.5 Customizing Make
+5.6 Universal Binaries
6 Building via Xcode.app
- 6.1 Checkout Sources
- 6.2 Build
- 6.3 Note: Finding Built Products
- 6.4 Note: Workspace Log Behaviors
- 6.5 External Target
- 6.6 User-Defined Settings
+6.1 Checkout Sources
+6.2 Build
+6.3 Note: Finding Built Products
+6.4 Note: Workspace Log Behaviors
+6.5 External Target
+6.6 User-Defined Settings
7 Troubleshooting
Appendix A Project Repository Details
-
1 Introduction
**************
-This guide documents the recommended process to build HandBrake on
-Mac OS X hosts from the official source-code repository. Building from
-any other source is not supported.
+This guide documents the recommended process to build HandBrake on Mac
+OS X hosts from the official source-code repository. Building from any
+other source is not supported.
2 Prerequisites
***************
-Building on Mac OS X is well supported. It is the reference platform
-for HandBrake. The following are the recommended specifications for
+Building on Mac OS X is well supported. It is the reference platform
+for HandBrake. The following are the recommended specifications for
this platform; but is not necessarily the only configuration that is
possible:
* Mac Intel hardware
-
* Mac OS X 10.7.5 or Mac OS X 10.8.3
-
* Xcode 4.6.1 (4H512)
-
- * llvm-gcc-4.2 version 4.2.1 (Based on Apple Inc. build 5658) (LLVM
+ * llvm-gcc-4.2 version 4.2.1 (Based on Apple Inc. build 5658) (LLVM
build 2336.11.00)
-
* Xcode command-line tools (installed via Preferences > Downloads >
Components)
-
* XQuartz (http://xquartz.macosforge.org/landing/)
The following tools are compiled during the build process if necessary,
but you can speed up your build by installing them:
* yasm 1.2.0 or later
-
* autoconf
-
* automake
-
* libtool
- Note: It is recommended to use the platform distribution's
- standard compiler for maximum C++ compatibility. If you build with
- a custom compiler it will likely introduce non-standard runtime
- requirements and have new/delete, exception and RTTI
- incompatibilities. There are of course many valid reasons to build
- with unbundled compilers, but be aware it is generally unsupported
- and left as an exercise to the reader.
-
+ Note: It is recommended to use the platform distribution's standard
+ compiler for maximum C++ compatibility. If you build with a custom
+ compiler it will likely introduce non-standard runtime requirements
+ and have new/delete, exception and RTTI incompatibilities. There
+ are of course many valid reasons to build with unbundled compilers,
+ but be aware it is generally unsupported and left as an exercise to
+ the reader.
The following general tools are used on various platforms and it is
recommended you use these versions or similar:
* subversion - 1.6.16
-
* python - Python 2.7.1
-
* curl - curl 7.21.4 (or wget)
-
* m4 - GNU M4 1.4.6
-
* make - GNU Make 3.81
-
* patch - Patch 2.5.8
-
* tar - GNU tar 1.26
-
* wget - GNU Wget 1.13.4 (or curl)
3 QuickStart
************
-This chapter is for building from a terminal/shell environment in as
-few commands as possible. Upon completion of the following commands you
-should have a fresh build of HandBrake. Further instructions are
-available beginning with *Note overview:: which describes procedures
-suitable for repeating builds. This chapter should be skipped by those
+This chapter is for building from a terminal/shell environment in as few
+commands as possible. Upon completion of the following commands you
+should have a fresh build of HandBrake. Further instructions are
+available beginning with *note overview:: which describes procedures
+suitable for repeating builds. This chapter should be skipped by those
seeking more than a minimalist build.
svn checkout svn://svn.handbrake.fr/HandBrake/trunk hb-trunk
cd hb-trunk
./configure --launch
-The special option `--launch' selects launch mode and performs the
+The special option '--launch' selects launch mode and performs the
following steps:
- * assert scratch directory `build/' does not exist
-
- * create scratch directory `build/'
-
- * change to directory `build/'
-
- * launch `make'
-
- * capture build output to `build/log/build.txt'
-
+ * assert scratch directory 'build/' does not exist
+ * create scratch directory 'build/'
+ * change to directory 'build/'
+ * launch 'make'
+ * capture build output to 'build/log/build.txt'
* echo build output
-
* print elapsed time
-
* indicate if build ultimately succeeded or failed
4 Overview
**********
The two general methods to build on Mac OS X are from terminal or
-Xcode.app. The preferred method for automated and repeatable builds is
-to use the terminal. Otherwise the choice is generally up to the
-individual. To be extra clear, building from the terminal by default
-actually invokes `xcodebuild' to build the very same targets contained
-in the Xcode project. Think of it as building with Xcode but without
+Xcode.app. The preferred method for automated and repeatable builds is
+to use the terminal. Otherwise the choice is generally up to the
+individual. To be extra clear, building from the terminal by default
+actually invokes 'xcodebuild' to build the very same targets contained
+in the Xcode project. Think of it as building with Xcode but without
the GUI.
5 Building via Terminal
@@ -153,13 +126,13 @@ Checkout HandBrake from the official source-code repository.
svn checkout svn://svn.handbrake.fr/HandBrake/trunk hb-trunk
cd hb-trunk
-Sources are checked out from the `trunk' branch. This document was
+Sources are checked out from the 'trunk' branch. This document was
generated from that very branch, and for example purposes, we will use
exactly the same branch.
If you have write-access to the repository, then you may add the
-appropriate login/password information as needed. It is recommended to
-use Subversion 1.6.0 or higher. Lower versions should also work.
+appropriate login/password information as needed. It is recommended to
+use Subversion 1.6.0 or higher. Lower versions should also work.
5.2 Configure
=============
@@ -168,101 +141,98 @@ Configure the build system.
./configure
-Configure will automatically create a scratch build directory `build'
-unless you use GNU-style build procedures and first `cd' to a directory
-other than top-level source. Additionally you may use `--build' to
-specify the directory. The name of the directory is arbitrary but it is
+Configure will automatically create a scratch build directory 'build'
+unless you use GNU-style build procedures and first 'cd' to a directory
+other than top-level source. Additionally you may use '--build' to
+specify the directory. The name of the directory is arbitrary but it is
recommended to use something which indicates transient files which are
not checked into the repository.
-The `configure' utility accepts many options. It is recommended that
-you specify `--help' for the complete list of options. The following
+The 'configure' utility accepts many options. It is recommended that
+you specify '--help' for the complete list of options. The following
options are also documented here:
-`--help'
+'--help'
List available options.
-`--src=DIR'
+'--src=DIR'
Specify top-level source directory for HandBrake sources.
-`--build=DIR'
- Specify destination directory for final product install. The
- default is to use either `build' if in the top-level source
- directory, otherwise `.'
+'--build=DIR'
+ Specify destination directory for final product install. The
+ default is to use either 'build' if in the top-level source
+ directory, otherwise '.'
-`--prefix=DIR'
+'--prefix=DIR'
Specify destination directory for final product install. This
defaults to a reasonable platform-specific value.
-`--launch'
+'--launch'
All-in-one option which launches the build and logs output
automatically. Useful for novices and quick-start procedures.
-`--disable-gtk'
- Disable building the GTK GUI on applicable platforms such as
- Linux.
+'--disable-gtk'
+ Disable building the GTK GUI on applicable platforms such as Linux.
-`--debug=MODE'
- Select debug mode. Must be one of `none', `min', `std', `max'.
- This generally maps to gcc options `-g0', `-g1', `-g2', `-g3'.
+'--debug=MODE'
+ Select debug mode. Must be one of 'none', 'min', 'std', 'max'.
+ This generally maps to gcc options '-g0', '-g1', '-g2', '-g3'.
-`--optimize=MODE'
- Select optimize mode. Must be one of `none', `speed', `size'.
- This generally maps to gcc options `-g0', `-O0', `-O3', `-Os'.
+'--optimize=MODE'
+ Select optimize mode. Must be one of 'none', 'speed', 'size'.
+ This generally maps to gcc options '-g0', '-O0', '-O3', '-Os'.
-`--arch=MODE'
- Select build architecture. The available architectures vary by
- platform. Most platforms support exactly one architecture except
+'--arch=MODE'
+ Select build architecture. The available architectures vary by
+ platform. Most platforms support exactly one architecture except
Mac OS X which has support for various universal binary
- architectures. The available choices are hard-coded per platform
+ architectures. The available choices are hard-coded per platform
and no sanity checks for the required tools are performed.
-`--disable-xcode'
- Disable shunting the build through `xcodebuild'. If this option is
- applied, `HandBrakeCLI' will be produced in a similar fashion as
- it is on other platforms; sans Xcode and the Cocoa application
- will not be produced. Mac OS X only.
+'--disable-xcode'
+ Disable shunting the build through 'xcodebuild'. If this option is
+ applied, 'HandBrakeCLI' will be produced in a similar fashion as it
+ is on other platforms; sans Xcode and the Cocoa application will
+ not be produced. Mac OS X only.
-`--xcconfig=MODE'
- Select Xcode project configuration file. The available modes are
- the basenames of files located in `macosx/xcconfig/*.xcconfig'
- which direct Xcode to build using various architecture and Mac OS
- X deployment options. Mac OS X only.
+'--xcconfig=MODE'
+ Select Xcode project configuration file. The available modes are
+ the basenames of files located in 'macosx/xcconfig/*.xcconfig'
+ which direct Xcode to build using various architecture and Mac OS X
+ deployment options. Mac OS X only.
Clean-room procedures dictate that when certain factors change, old
-builds should be scrapped and new builds configured. This is the main
+builds should be scrapped and new builds configured. This is the main
reason for requiring a scratch directory; to promote consistent,
-reliable and clean software builds. The following is a short list of
+reliable and clean software builds. The following is a short list of
some of the reasons why someone may choose to scrap an existing build:
* configure with different options
-
* subversion working dir is updated and you want configure to
re-evaluate working dir metadata.
-
* build corruption is suspected
-There are generally two methods for scrapping a build. The `build'
+There are generally two methods for scrapping a build. The 'build'
directory can be recursively removed which has the effect of loosing
your existing configuration but does guarantee no residuals are left
-behind. The other method is to ask the build system to perform an `make
-xclean'. This is known to work well but will leave empty directories
-behind. However, the configuration is left intact.
+behind. The other method is to ask the build system to perform an 'make
+xclean'. This is known to work well but will leave empty directories
+behind. However, the configuration is left intact.
5.3 Build
=========
-Build main product. All necessary dependencies are also built if
+Build main product. All necessary dependencies are also built if
required.
make
-Parallel builds may optionally be enabled. Be aware that while a
+Parallel builds may optionally be enabled. Be aware that while a
parallel build may save time on systems with additional cores, the
output is often mixed, overlapped and sometimes even corrupted with
-binary characters. Thus if you experience a build issue, you should
+binary characters. Thus if you experience a build issue, you should
clean and redo the build in default serial mode to produce a readable
-log. The following command allows for up to 4 concurrent jobs via make:
+log. The following command allows for up to 4 concurrent jobs via make:
make -j4
@@ -270,105 +240,104 @@ log. The following command allows for up to 4 concurrent jobs via make:
================
The build system supports passing many kinds of targets some of which
-become very useful in normal development cycles. The targets by
-convention are lower-case words passed to `make'. Global targets are
-one-word targets. Scoped targets are usually two-words separated by a
+become very useful in normal development cycles. The targets by
+convention are lower-case words passed to 'make'. Global targets are
+one-word targets. Scoped targets are usually two-words separated by a
period.
5.4.1 Global
------------
-`make'
- Alias for `make build'.
+'make'
+ Alias for 'make build'.
-`make build'
- Build main product. All necessary dependencies are also built if
+'make build'
+ Build main product. All necessary dependencies are also built if
required.
-`make clean'
- Clean all build output excluding contrib modules. Configuration is
+'make clean'
+ Clean all build output excluding contrib modules. Configuration is
retained.
-`make install'
- Perform final product(s) install. This will install build
- products to a standard directory or one specified via `configure
- --prefix' option.
+'make install'
+ Perform final product(s) install. This will install build products
+ to a standard directory or one specified via 'configure --prefix'
+ option.
-`make uninstall'
+'make uninstall'
Perform final product(s) uninstall. This will uninstall any
products which may have been previously installed.
-`make xclean'
- Clean all build output including contrib modules. Configuration is
+'make xclean'
+ Clean all build output including contrib modules. Configuration is
retained.
-`make doc'
- Build auto-generated project documentation. Various articles are
- produced and may be found in `build/doc/articles'.
+'make doc'
+ Build auto-generated project documentation. Various articles are
+ produced and may be found in 'build/doc/articles'.
-`make doc.post'
+'make doc.post'
Build auto-generated project documentation and post produced
articles directly to source tree.
-`make report.help'
+'make report.help'
Print list of available makefile vars report targets. These
reports detail var definitions and expanded values used by the
build system. For experts only.
-`make report.all'
+'make report.all'
Convenience target which aggregates all reports. For experts only.
5.4.2 General Modules
---------------------
-General modules such as `libhb', `test' and `gtk' have the following
+General modules such as 'libhb', 'test' and 'gtk' have the following
scoped targets:
-`make MODULE.build'
+'make MODULE.build'
Build MODULE.
-`make MODULE.clean'
+'make MODULE.clean'
Clean build output for MODULE.
5.4.3 Contrib Modules
---------------------
-Contrib modules such as `a52dec', `bzip2', `faac', `faad2', `ffmpeg',
-`fontconfig', `freetype', `fribidi', `lame', `libass', `libbluray',
-`libdca', `libdvdnav', `libdvdread', `libdvdread', `libiconv',
-`libmkv', `libogg', `libsamplerate', `libtheora', `libvorbis',
-`libxml2', `mp4v2', `mpeg2dec', `x264', `yasm' and `zlib' have the
-following scoped targets:
+Contrib modules such as 'a52dec', 'bzip2', 'faac', 'faad2', 'ffmpeg',
+'fontconfig', 'freetype', 'fribidi', 'lame', 'libass', 'libbluray',
+'libdca', 'libdvdnav', 'libdvdread', 'libiconv', 'libmkv', 'libogg',
+'libsamplerate', 'libtheora', 'libvorbis', 'libxml2', 'mp4v2',
+'mpeg2dec', 'x264', 'yasm' and 'zlib' have the following scoped targets:
-`make MODULE.fetch'
+'make MODULE.fetch'
Download source tarball from the Internet and save to
- `TOP/downloads' directory. No check-summing is performed.
+ 'TOP/downloads' directory. No check-summing is performed.
-`make MODULE.extract'
- Extract source tarball into `build' tree.
+'make MODULE.extract'
+ Extract source tarball into 'build' tree.
-`make MODULE.patch'
+'make MODULE.patch'
Apply appropriate patches (if any) to module sources.
-`make MODULE.configure'
+'make MODULE.configure'
Configure module sources. This usually invokes autotool configure.
-`make MODULE.build'
+'make MODULE.build'
Build module. This usually invokes autotool build.
-`make MODULE.install'
- Install module products such as headers and libraries into `build'
+'make MODULE.install'
+ Install module products such as headers and libraries into 'build'
tree. This usually invokes autotool install.
-`make MODULE.uninstall'
+'make MODULE.uninstall'
Uninstall module products; generally the reverse of install. This
usually invokes autotool uninstall.
-`make MODULE.clean'
- Clean module; generally the reverse of build. This usually
- invokes autotool clean.
+'make MODULE.clean'
+ Clean module; generally the reverse of build. This usually invokes
+ autotool clean.
-`make MODULE.xclean'
+'make MODULE.xclean'
Extra clean module; first invokes uninstall then recursively
removes the module build directory.
@@ -376,29 +345,20 @@ following scoped targets:
-------------------------------
Also available are some very granular targets which help force builds
-from specific cycle points. The following targets are available to
+from specific cycle points. The following targets are available to
touch and untouch the respective module target; this will force the
build system to treat the target as satisfied after a touch or
unsatisfied after an untouch:
* make MODULE.extract.touch
-
* make MODULE.extract.untouch
-
* make MODULE.patch.touch
-
* make MODULE.patch.untouch
-
* make MODULE.configure.touch
-
* make MODULE.configure.untouch
-
* make MODULE.build.touch
-
* make MODULE.build.untouch
-
* make MODULE.install.touch
-
* make MODULE.install.untouch
5.4.5 Contrib Aggregates
@@ -408,55 +368,45 @@ For convenience, the following targets aggregate the all contrib
modules' respective targets together:
* make contrib.fetch
-
* make contrib.extract
-
* make contrib.patch
-
* make contrib.configure
-
* make contrib.build
-
* make contrib.install
-
* make contrib.uninstall
-
* make contrib.clean
-
* make contrib.xclean
5.5 Customizing Make
====================
-If the need arises to override settings in the build system
-(essentially gnu-make variables) the recommended method is to create
-optional include files which are automatically included if present and
-follow this naming convention; Do not check these files into the
-repository:
+If the need arises to override settings in the build system (essentially
+gnu-make variables) the recommended method is to create optional include
+files which are automatically included if present and follow this naming
+convention; Do not check these files into the repository:
-`_SRC_/custom.defs'
- Custom makevar definitions outside `build'. Suitable for settings
+'_SRC_/custom.defs'
+ Custom makevar definitions outside 'build'. Suitable for settings
which apply across all builds for a particular checkout; or which
- survives manual removal of `build'.
+ survives manual removal of 'build'.
-`_SRC_/custom.rules'
- Custom make rules outside `build'. Suitable for rules which apply
+'_SRC_/custom.rules'
+ Custom make rules outside 'build'. Suitable for rules which apply
across all builds for a particular checkout; or which survives
- manual removal of `build'.
+ manual removal of 'build'.
-`_BUILD_/GNUmakefile.custom.defs'
- Custom makevar definitions specific to a `build' directory.
-
-`_BUILD_/GNUmakefile.custom.rules'
- Custom makevar rules specific to a `build' directory.
+'_BUILD_/GNUmakefile.custom.defs'
+ Custom makevar definitions specific to a 'build' directory.
+'_BUILD_/GNUmakefile.custom.rules'
+ Custom makevar rules specific to a 'build' directory.
The purpose is to allow a place to store local build settings for
testing, tweaking, and experimenting with build configuration without
-losing your settings if `configure' is invoked; ie: `configure' would
-overwrite `GNUmakefile' and any customizations contained therein would
-be lost. Here is a short example of what the contents of
-`_SRC_/custom.defs' might contain:
+losing your settings if 'configure' is invoked; ie: 'configure' would
+overwrite 'GNUmakefile' and any customizations contained therein would
+be lost. Here is a short example of what the contents of
+'_SRC_/custom.defs' might contain:
## bump to gcc-4.6 in current path
GCC.gcc = /usr/bin/gcc-4.6
@@ -464,8 +414,8 @@ be lost. Here is a short example of what the contents of
## replace optimize for 'speed' with more aggressive settings
GCC.args.O.speed = -O3 -fomit-frame-pointer -msse4.2
-See also `make report.help' which displays a set of reports used to
-dump makefile vars.
+See also 'make report.help' which displays a set of reports used to dump
+makefile vars.
5.6 Universal Binaries
======================
@@ -474,8 +424,8 @@ This section outlines convenience procedures for creating Universal
Binaries for all the architectures.
Note: The dummy (container) build configuration uses
- `--disable-xcode'; but the nested architecture builds will all
- make full use of Xcode.
+ '--disable-xcode'; but the nested architecture builds will all make
+ full use of Xcode.
Create a dummy (container) build configuration and use it to launch a
nested-build for each architecture:
@@ -487,7 +437,7 @@ nested-build for each architecture:
The list of architectures is hard coded to HandBrake's desired product
and currently is composed of combining the binaries produced from two
-xcconfigs: osx106.i386 and osx106.x86_64. The following example shows
+xcconfigs: osx106.i386 and osx106.x86_64. The following example shows
how to specify a different list of xcconfigs:
./configure --disable-xcode
@@ -506,72 +456,60 @@ Checkout HandBrake from the official source-code repository.
svn checkout svn://svn.handbrake.fr/HandBrake/trunk hb-trunk
cd hb-trunk
-Sources are checked out from the `trunk' branch. This document was
+Sources are checked out from the 'trunk' branch. This document was
generated from that very branch, and for example purposes, we will use
exactly the same branch.
If you have write-access to the repository, then you may add the
-appropriate login/password information as needed. It is recommended to
-use Subversion 1.6.0 or higher. Lower versions should also work.
+appropriate login/password information as needed. It is recommended to
+use Subversion 1.6.0 or higher. Lower versions should also work.
6.2 Build
=========
Perform the following steps to build:
- * Finder - navigate to `macosx/' in the HandBrake source tree
-
- * Finder - open `HandBrake.xcodeproj'
-
+ * Finder - navigate to 'macosx/' in the HandBrake source tree
+ * Finder - open 'HandBrake.xcodeproj'
* Xcode workspace - select scheme HandBrake [RELEASE]
-
* Xcode menu - select Product -> Build
-
* Xcode workspace - Show the Log navigator
-
* Xcode workspace Log navigator - select top Build item
6.3 Note: Finding Built Products
================================
-Under default Xcode.app options the products from a build are managed
-by the Xcode Organizer. Perform the following steps to open Finder at
-top of build tree and navigate to release products:
+Under default Xcode.app options the products from a build are managed by
+the Xcode Organizer. Perform the following steps to open Finder at top
+of build tree and navigate to release products:
* Xcode menu - select Window -> Organizer
-
* Xcode organizer - select Projects tab
-
* Xcode organizer Projects - select HandBrake item
-
* HandBrake item - click Derived Data location arrow (immediately
right of path)
-
* Finder - navigate to Build -> Products -> release
- Note: There is a bug with Xcode Organizer. The very first time an
+ Note: There is a bug with Xcode Organizer. The very first time an
Xcode project is opened the Project view Derived Data is
- greyed-out. Workaround glitch by selecting any other tab and then
+ greyed-out. Workaround glitch by selecting any other tab and then
reselecting Projects tab.
6.4 Note: Workspace Log Behaviors
=================================
The default Workspace behavior does not display latest Build log in the
-navigator and quickly becomes tedious. To automatically switch to Log
+navigator and quickly becomes tedious. To automatically switch to Log
navigator and show current log:
* Xcode menu - select Behaviors -> Edit Behaviors
-
* Xcode behaviors - select Build starts
-
* navigator - enable, select Show, select Log Navigator
-
* nagivate to - select current log
Note: The Log navigator supports some possibly confusing options.
It is recommended to only show results for the last build by
- selecting Recent. If All is selected then it will look as though
+ selecting Recent. If All is selected then it will look as though
Xcode is performing a build, but in reality it is bringing forward
log output from prior builds and it becomes impossible to tell if
any single log entry represents actual work performed or if it was
@@ -579,39 +517,35 @@ navigator and show current log:
Note: When building external target, many 3rd-party contributed
modules have warnings and errors which may safely be ignored and
- are ignored by the external build system. Ultimately, look to the
+ are ignored by the external build system. Ultimately, look to the
workspace status indicator for Build Succeeded.
6.5 External Target
===================
The external target mechanism is used to launch a full terminal-based
-build from within Xcode. Unfortunately, we do not have hooks in place
-to offer finer-grained control over per-module make actions. However,
-you can still use terminal to accomplish those tasks after launching
-the build at least once or doing a clean from within Xcode. Be careful
-to not issue terminal commands simultaneously with Xcode tasks.
+build from within Xcode. Unfortunately, we do not have hooks in place
+to offer finer-grained control over per-module make actions. However,
+you can still use terminal to accomplish those tasks after launching the
+build at least once or doing a clean from within Xcode. Be careful to
+not issue terminal commands simultaneously with Xcode tasks.
Invoking a clean from Xcode always destroys the entire external build
-tree and subsequently configures it. Changing settings in Xcode such as
-selecting xcconfig files should always be followed by a clean. This
+tree and subsequently configures it. Changing settings in Xcode such as
+selecting xcconfig files should always be followed by a clean. This
allows the external build system configuration to accurately reflect
Xcode project changes.
-The following are some examples of using `make' from the terminal to
-effect various components of the external build. But first, you must
-open a terminal at the top of the external build output tree. Here we
+The following are some examples of using 'make' from the terminal to
+effect various components of the external build. But first, you must
+open a terminal at the top of the external build output tree. Here we
navigate to external build configured for release:
* Xcode menu - select Window -> Organizer
-
* Xcode organizer - select Projects tab
-
* Xcode organizer Projects - select HandBrake item
-
* HandBrake item - click Derived Data location arrow (immediately
right of path)
-
* Finder - navigate to Build -> Products -> release -> external
Example; external build failed but error is buried in a parallelized
@@ -638,59 +572,57 @@ Example; something in a big module is failing; redo build sequentially:
6.6 User-Defined Settings
=========================
-The following user defined settings are visible in Xcode project and
-are used for the external build system.
+The following user defined settings are visible in Xcode project and are
+used for the external build system.
-`EXTERNAL_BUILD'
+'EXTERNAL_BUILD'
Do not modify; used to specify the build (scratch) directory.
-`EXTERNAL_DRIVER'
+'EXTERNAL_DRIVER'
Do not modify; used for internal/external build coordination and
- must always be `xcode'.
-
-`EXTERNAL_JOBS'
- Specifies the concurrency factor for the external build system
- when builds are launched from within Xcode. Modify for faster
- external builds if your system has the horsepower and resources.
- Specifying a value greater than the number of CPU cores (or
- virtual cores) in your system is unlikely to produce gains and
- will needlessly consume extra resources. A special string value of
- auto sets the factor to the number of active CPUs on the host
- system.
-
-`EXTERNAL_SRC'
+ must always be 'xcode'.
+
+'EXTERNAL_JOBS'
+ Specifies the concurrency factor for the external build system when
+ builds are launched from within Xcode. Modify for faster external
+ builds if your system has the horsepower and resources. Specifying
+ a value greater than the number of CPU cores (or virtual cores) in
+ your system is unlikely to produce gains and will needlessly
+ consume extra resources. A special string value of auto sets the
+ factor to the number of active CPUs on the host system.
+
+'EXTERNAL_SRC'
Do not modify; specifies the top-level source directory for
HandBrake, relative to Xcode project.
-`EXTERNAL_XCCONFIG'
- Do not modify; specifies which xcconfig file is active. Defined
+'EXTERNAL_XCCONFIG'
+ Do not modify; specifies which xcconfig file is active. Defined
inside xcconfig file.
-
7 Troubleshooting
*****************
When troubleshooting build issues, the following files relative to the
-`build/' directory may be especially useful:
+'build/' directory may be especially useful:
-`GNUmakefile'
+'GNUmakefile'
Top-level makefile which contains build settings generated via
configure.
-`log/config.info.txt'
+'log/config.info.txt'
Record of output from configure.
-`log/config.verbose.txt'
+'log/config.verbose.txt'
Record of verbose output from configure.
-`log/build.txt'
- Record of output from `configure --launch'. Similar output may be
- recorded using `make' depending on which shell is in use, eg:
- `make >& log/build.txt' or `make > log/build.txt 2>&1'.
+'log/build.txt'
+ Record of output from 'configure --launch'. Similar output may be
+ recorded using 'make' depending on which shell is in use, eg: 'make
+ >& log/build.txt' or 'make > log/build.txt 2>&1'.
-`log/xcodemake.env.txt'
- Environment (variables) dump as seen when Xcode forks `make'.
- Mac OS X only.
+'log/xcodemake.env.txt'
+ Environment (variables) dump as seen when Xcode forks 'make'. Mac
+ OS X only.
Appendix A Project Repository Details
*************************************
@@ -699,7 +631,6 @@ Appendix A Project Repository Details
root: svn://svn.handbrake.fr/HandBrake
branch: trunk
uuid: b64f7644-9d1e-0410-96f1-a4d463321fa5
- rev: 5388
- date: 2013-04-09 14:21:38 +0200
+ rev: 6163
+ date: 2014-04-13 09:22:16 -0700
type: developer
-
diff --git a/doc/BUILD-MinGW b/doc/BUILD-MinGW
index f4b0ed98c..9f69caf76 100644
--- a/doc/BUILD-MinGW
+++ b/doc/BUILD-MinGW
@@ -1,66 +1,60 @@
-Guide to Building HandBrake svn5208 (2013012701) on MinGW
+Guide to Building HandBrake svn6163 (2014041401) on MinGW
*********************************************************
-Table of Contents
-*****************
-
1 Introduction
2 Prerequisites
3 QuickStart
4 Overview
5 Building via Terminal
- 5.1 Checkout Sources
- 5.2 Configure
- 5.3 Build
- 5.4 Make Targets
- 5.4.1 Global
- 5.4.2 General Modules
- 5.4.3 Contrib Modules
- 5.4.4 Contrib Touch and Untouch
- 5.4.5 Contrib Aggregates
- 5.5 Customizing Make
+5.1 Checkout Sources
+5.2 Configure
+5.3 Build
+5.4 Make Targets
+ 5.4.1 Global
+ 5.4.2 General Modules
+ 5.4.3 Contrib Modules
+ 5.4.4 Contrib Touch and Untouch
+ 5.4.5 Contrib Aggregates
+5.5 Customizing Make
6 Troubleshooting
Appendix A Project Repository Details
-
1 Introduction
**************
-This guide documents the recommended process to build HandBrake on
-MinGW hosts from the official source-code repository. Building from any
-other source is not supported.
+This guide documents the recommended process to build HandBrake on MinGW
+hosts from the official source-code repository. Building from any other
+source is not supported.
2 Prerequisites
***************
-The following are the recommended specifications for building on
-MinGW; but is not necessarily the only configuration that is possible:
+The following are the recommended specifications for building on MinGW;
+but is not necessarily the only configuration that is possible:
* Intel 32-bit or 64-bit hardware
-
- * MinGW on Fedora 17+, Ubuntu 12+ or Debian, gcc 4.5+
-
+ * MinGW on Fedora 17+, Ubuntu 12+ or Debian, gcc 4.6+
* yasm 1.2.x (for i386 or x86_64 architectures)
- Note: It is recommended to use the platform distribution's
- standard compiler for maximum C++ compatibility. If you build with
- a custom compiler it will likely introduce non-standard runtime
- requirements and have new/delete, exception and RTTI
- incompatibilities. There are of course many valid reasons to build
- with unbundled compilers, but be aware it is generally unsupported
- and left as an exercise to the reader.
+ Note: It is recommended to use the platform distribution's standard
+ compiler for maximum C++ compatibility. If you build with a custom
+ compiler it will likely introduce non-standard runtime requirements
+ and have new/delete, exception and RTTI incompatibilities. There
+ are of course many valid reasons to build with unbundled compilers,
+ but be aware it is generally unsupported and left as an exercise to
+ the reader.
Note: You must set the -cross flag with configure to cross compile
- with windows. See the Example below. Note that the cross compiler
+ with windows. See the Example below. Note that the cross compiler
name varies between distributions.
As of this writing, MinGW has available to it several versions of
- gcc; only one of which may be found and used in the path as `gcc'
- and `g++'. Configure will thus find what is probably the older
- version of gcc in a typical MinGW environment. If you desire to
- build with the newer gcc, it is found in the path as `gcc-4' and
- `g++-4' respectively and you must indicate to configure the
- desired versions. The following syntax should do the trick:
+ gcc; only one of which may be found and used in the path as 'gcc'
+ and 'g++'. Configure will thus find what is probably the older
+ version of gcc in a typical MinGW environment. If you desire to
+ build with the newer gcc, it is found in the path as 'gcc-4' and
+ 'g++-4' respectively and you must indicate to configure the desired
+ versions. The following syntax should do the trick:
../configure --cross=i686-w64-mingw32 --gcc=gcc-4
@@ -68,58 +62,44 @@ The following general tools are used on various platforms and it is
recommended you use these versions or similar:
* subversion - 1.6.16
-
* python - Python 2.7.1
-
* curl - curl 7.21.4 (or wget)
-
* m4 - GNU M4 1.4.6
-
* make - GNU Make 3.81
-
* patch - Patch 2.5.8
-
* tar - GNU tar 1.26
-
* wget - GNU Wget 1.13.4 (or curl)
3 QuickStart
************
-This chapter is for building from a terminal/shell environment in as
-few commands as possible. Upon completion of the following commands you
-should have a fresh build of HandBrake. Further instructions are
-available beginning with *Note overview:: which describes procedures
-suitable for repeating builds. This chapter should be skipped by those
+This chapter is for building from a terminal/shell environment in as few
+commands as possible. Upon completion of the following commands you
+should have a fresh build of HandBrake. Further instructions are
+available beginning with *note overview:: which describes procedures
+suitable for repeating builds. This chapter should be skipped by those
seeking more than a minimalist build.
svn checkout svn://svn.handbrake.fr/HandBrake/trunk hb-trunk
cd hb-trunk
./configure --launch
-The special option `--launch' selects launch mode and performs the
+The special option '--launch' selects launch mode and performs the
following steps:
- * assert scratch directory `build/' does not exist
-
- * create scratch directory `build/'
-
- * change to directory `build/'
-
- * launch `make'
-
- * capture build output to `build/log/build.txt'
-
+ * assert scratch directory 'build/' does not exist
+ * create scratch directory 'build/'
+ * change to directory 'build/'
+ * launch 'make'
+ * capture build output to 'build/log/build.txt'
* echo build output
-
* print elapsed time
-
* indicate if build ultimately succeeded or failed
4 Overview
**********
-MinGW builds are performed from a terminal. There is no support for
+MinGW builds are performed from a terminal. There is no support for
building from any IDEs.
5 Building via Terminal
@@ -133,13 +113,13 @@ Checkout HandBrake from the official source-code repository.
svn checkout svn://svn.handbrake.fr/HandBrake/trunk hb-trunk
cd hb-trunk
-Sources are checked out from the `trunk' branch. This document was
+Sources are checked out from the 'trunk' branch. This document was
generated from that very branch, and for example purposes, we will use
exactly the same branch.
If you have write-access to the repository, then you may add the
-appropriate login/password information as needed. It is recommended to
-use Subversion 1.6.0 or higher. Lower versions should also work.
+appropriate login/password information as needed. It is recommended to
+use Subversion 1.6.0 or higher. Lower versions should also work.
5.2 Configure
=============
@@ -148,101 +128,98 @@ Configure the build system.
./configure
-Configure will automatically create a scratch build directory `build'
-unless you use GNU-style build procedures and first `cd' to a directory
-other than top-level source. Additionally you may use `--build' to
-specify the directory. The name of the directory is arbitrary but it is
+Configure will automatically create a scratch build directory 'build'
+unless you use GNU-style build procedures and first 'cd' to a directory
+other than top-level source. Additionally you may use '--build' to
+specify the directory. The name of the directory is arbitrary but it is
recommended to use something which indicates transient files which are
not checked into the repository.
-The `configure' utility accepts many options. It is recommended that
-you specify `--help' for the complete list of options. The following
+The 'configure' utility accepts many options. It is recommended that
+you specify '--help' for the complete list of options. The following
options are also documented here:
-`--help'
+'--help'
List available options.
-`--src=DIR'
+'--src=DIR'
Specify top-level source directory for HandBrake sources.
-`--build=DIR'
- Specify destination directory for final product install. The
- default is to use either `build' if in the top-level source
- directory, otherwise `.'
+'--build=DIR'
+ Specify destination directory for final product install. The
+ default is to use either 'build' if in the top-level source
+ directory, otherwise '.'
-`--prefix=DIR'
+'--prefix=DIR'
Specify destination directory for final product install. This
defaults to a reasonable platform-specific value.
-`--launch'
+'--launch'
All-in-one option which launches the build and logs output
automatically. Useful for novices and quick-start procedures.
-`--disable-gtk'
- Disable building the GTK GUI on applicable platforms such as
- Linux.
+'--disable-gtk'
+ Disable building the GTK GUI on applicable platforms such as Linux.
-`--debug=MODE'
- Select debug mode. Must be one of `none', `min', `std', `max'.
- This generally maps to gcc options `-g0', `-g1', `-g2', `-g3'.
+'--debug=MODE'
+ Select debug mode. Must be one of 'none', 'min', 'std', 'max'.
+ This generally maps to gcc options '-g0', '-g1', '-g2', '-g3'.
-`--optimize=MODE'
- Select optimize mode. Must be one of `none', `speed', `size'.
- This generally maps to gcc options `-g0', `-O0', `-O3', `-Os'.
+'--optimize=MODE'
+ Select optimize mode. Must be one of 'none', 'speed', 'size'.
+ This generally maps to gcc options '-g0', '-O0', '-O3', '-Os'.
-`--arch=MODE'
- Select build architecture. The available architectures vary by
- platform. Most platforms support exactly one architecture except
+'--arch=MODE'
+ Select build architecture. The available architectures vary by
+ platform. Most platforms support exactly one architecture except
Mac OS X which has support for various universal binary
- architectures. The available choices are hard-coded per platform
+ architectures. The available choices are hard-coded per platform
and no sanity checks for the required tools are performed.
-`--disable-xcode'
- Disable shunting the build through `xcodebuild'. If this option is
- applied, `HandBrakeCLI' will be produced in a similar fashion as
- it is on other platforms; sans Xcode and the Cocoa application
- will not be produced. Mac OS X only.
+'--disable-xcode'
+ Disable shunting the build through 'xcodebuild'. If this option is
+ applied, 'HandBrakeCLI' will be produced in a similar fashion as it
+ is on other platforms; sans Xcode and the Cocoa application will
+ not be produced. Mac OS X only.
-`--xcconfig=MODE'
- Select Xcode project configuration file. The available modes are
- the basenames of files located in `macosx/xcconfig/*.xcconfig'
- which direct Xcode to build using various architecture and Mac OS
- X deployment options. Mac OS X only.
+'--xcconfig=MODE'
+ Select Xcode project configuration file. The available modes are
+ the basenames of files located in 'macosx/xcconfig/*.xcconfig'
+ which direct Xcode to build using various architecture and Mac OS X
+ deployment options. Mac OS X only.
Clean-room procedures dictate that when certain factors change, old
-builds should be scrapped and new builds configured. This is the main
+builds should be scrapped and new builds configured. This is the main
reason for requiring a scratch directory; to promote consistent,
-reliable and clean software builds. The following is a short list of
+reliable and clean software builds. The following is a short list of
some of the reasons why someone may choose to scrap an existing build:
* configure with different options
-
* subversion working dir is updated and you want configure to
re-evaluate working dir metadata.
-
* build corruption is suspected
-There are generally two methods for scrapping a build. The `build'
+There are generally two methods for scrapping a build. The 'build'
directory can be recursively removed which has the effect of loosing
your existing configuration but does guarantee no residuals are left
-behind. The other method is to ask the build system to perform an `make
-xclean'. This is known to work well but will leave empty directories
-behind. However, the configuration is left intact.
+behind. The other method is to ask the build system to perform an 'make
+xclean'. This is known to work well but will leave empty directories
+behind. However, the configuration is left intact.
5.3 Build
=========
-Build main product. All necessary dependencies are also built if
+Build main product. All necessary dependencies are also built if
required.
make
-Parallel builds may optionally be enabled. Be aware that while a
+Parallel builds may optionally be enabled. Be aware that while a
parallel build may save time on systems with additional cores, the
output is often mixed, overlapped and sometimes even corrupted with
-binary characters. Thus if you experience a build issue, you should
+binary characters. Thus if you experience a build issue, you should
clean and redo the build in default serial mode to produce a readable
-log. The following command allows for up to 4 concurrent jobs via make:
+log. The following command allows for up to 4 concurrent jobs via make:
make -j4
@@ -250,105 +227,104 @@ log. The following command allows for up to 4 concurrent jobs via make:
================
The build system supports passing many kinds of targets some of which
-become very useful in normal development cycles. The targets by
-convention are lower-case words passed to `make'. Global targets are
-one-word targets. Scoped targets are usually two-words separated by a
+become very useful in normal development cycles. The targets by
+convention are lower-case words passed to 'make'. Global targets are
+one-word targets. Scoped targets are usually two-words separated by a
period.
5.4.1 Global
------------
-`make'
- Alias for `make build'.
+'make'
+ Alias for 'make build'.
-`make build'
- Build main product. All necessary dependencies are also built if
+'make build'
+ Build main product. All necessary dependencies are also built if
required.
-`make clean'
- Clean all build output excluding contrib modules. Configuration is
+'make clean'
+ Clean all build output excluding contrib modules. Configuration is
retained.
-`make install'
- Perform final product(s) install. This will install build
- products to a standard directory or one specified via `configure
- --prefix' option.
+'make install'
+ Perform final product(s) install. This will install build products
+ to a standard directory or one specified via 'configure --prefix'
+ option.
-`make uninstall'
+'make uninstall'
Perform final product(s) uninstall. This will uninstall any
products which may have been previously installed.
-`make xclean'
- Clean all build output including contrib modules. Configuration is
+'make xclean'
+ Clean all build output including contrib modules. Configuration is
retained.
-`make doc'
- Build auto-generated project documentation. Various articles are
- produced and may be found in `build/doc/articles'.
+'make doc'
+ Build auto-generated project documentation. Various articles are
+ produced and may be found in 'build/doc/articles'.
-`make doc.post'
+'make doc.post'
Build auto-generated project documentation and post produced
articles directly to source tree.
-`make report.help'
+'make report.help'
Print list of available makefile vars report targets. These
reports detail var definitions and expanded values used by the
build system. For experts only.
-`make report.all'
+'make report.all'
Convenience target which aggregates all reports. For experts only.
5.4.2 General Modules
---------------------
-General modules such as `libhb', `test' and `gtk' have the following
+General modules such as 'libhb', 'test' and 'gtk' have the following
scoped targets:
-`make MODULE.build'
+'make MODULE.build'
Build MODULE.
-`make MODULE.clean'
+'make MODULE.clean'
Clean build output for MODULE.
5.4.3 Contrib Modules
---------------------
-Contrib modules such as `a52dec', `bzip2', `faac', `faad2', `ffmpeg',
-`fontconfig', `freetype', `fribidi', `lame', `libass', `libbluray',
-`libdca', `libdvdnav', `libdvdread', `libdvdread', `libiconv',
-`libmkv', `libogg', `libsamplerate', `libtheora', `libvorbis',
-`libxml2', `mp4v2', `mpeg2dec', `x264', `yasm' and `zlib' have the
-following scoped targets:
+Contrib modules such as 'a52dec', 'bzip2', 'faac', 'faad2', 'ffmpeg',
+'fontconfig', 'freetype', 'fribidi', 'lame', 'libass', 'libbluray',
+'libdca', 'libdvdnav', 'libdvdread', 'libiconv', 'libmkv', 'libogg',
+'libsamplerate', 'libtheora', 'libvorbis', 'libxml2', 'mp4v2',
+'mpeg2dec', 'x264', 'yasm' and 'zlib' have the following scoped targets:
-`make MODULE.fetch'
+'make MODULE.fetch'
Download source tarball from the Internet and save to
- `TOP/downloads' directory. No check-summing is performed.
+ 'TOP/downloads' directory. No check-summing is performed.
-`make MODULE.extract'
- Extract source tarball into `build' tree.
+'make MODULE.extract'
+ Extract source tarball into 'build' tree.
-`make MODULE.patch'
+'make MODULE.patch'
Apply appropriate patches (if any) to module sources.
-`make MODULE.configure'
+'make MODULE.configure'
Configure module sources. This usually invokes autotool configure.
-`make MODULE.build'
+'make MODULE.build'
Build module. This usually invokes autotool build.
-`make MODULE.install'
- Install module products such as headers and libraries into `build'
+'make MODULE.install'
+ Install module products such as headers and libraries into 'build'
tree. This usually invokes autotool install.
-`make MODULE.uninstall'
+'make MODULE.uninstall'
Uninstall module products; generally the reverse of install. This
usually invokes autotool uninstall.
-`make MODULE.clean'
- Clean module; generally the reverse of build. This usually
- invokes autotool clean.
+'make MODULE.clean'
+ Clean module; generally the reverse of build. This usually invokes
+ autotool clean.
-`make MODULE.xclean'
+'make MODULE.xclean'
Extra clean module; first invokes uninstall then recursively
removes the module build directory.
@@ -356,29 +332,20 @@ following scoped targets:
-------------------------------
Also available are some very granular targets which help force builds
-from specific cycle points. The following targets are available to
+from specific cycle points. The following targets are available to
touch and untouch the respective module target; this will force the
build system to treat the target as satisfied after a touch or
unsatisfied after an untouch:
* make MODULE.extract.touch
-
* make MODULE.extract.untouch
-
* make MODULE.patch.touch
-
* make MODULE.patch.untouch
-
* make MODULE.configure.touch
-
* make MODULE.configure.untouch
-
* make MODULE.build.touch
-
* make MODULE.build.untouch
-
* make MODULE.install.touch
-
* make MODULE.install.untouch
5.4.5 Contrib Aggregates
@@ -388,55 +355,45 @@ For convenience, the following targets aggregate the all contrib
modules' respective targets together:
* make contrib.fetch
-
* make contrib.extract
-
* make contrib.patch
-
* make contrib.configure
-
* make contrib.build
-
* make contrib.install
-
* make contrib.uninstall
-
* make contrib.clean
-
* make contrib.xclean
5.5 Customizing Make
====================
-If the need arises to override settings in the build system
-(essentially gnu-make variables) the recommended method is to create
-optional include files which are automatically included if present and
-follow this naming convention; Do not check these files into the
-repository:
+If the need arises to override settings in the build system (essentially
+gnu-make variables) the recommended method is to create optional include
+files which are automatically included if present and follow this naming
+convention; Do not check these files into the repository:
-`_SRC_/custom.defs'
- Custom makevar definitions outside `build'. Suitable for settings
+'_SRC_/custom.defs'
+ Custom makevar definitions outside 'build'. Suitable for settings
which apply across all builds for a particular checkout; or which
- survives manual removal of `build'.
+ survives manual removal of 'build'.
-`_SRC_/custom.rules'
- Custom make rules outside `build'. Suitable for rules which apply
+'_SRC_/custom.rules'
+ Custom make rules outside 'build'. Suitable for rules which apply
across all builds for a particular checkout; or which survives
- manual removal of `build'.
+ manual removal of 'build'.
-`_BUILD_/GNUmakefile.custom.defs'
- Custom makevar definitions specific to a `build' directory.
-
-`_BUILD_/GNUmakefile.custom.rules'
- Custom makevar rules specific to a `build' directory.
+'_BUILD_/GNUmakefile.custom.defs'
+ Custom makevar definitions specific to a 'build' directory.
+'_BUILD_/GNUmakefile.custom.rules'
+ Custom makevar rules specific to a 'build' directory.
The purpose is to allow a place to store local build settings for
testing, tweaking, and experimenting with build configuration without
-losing your settings if `configure' is invoked; ie: `configure' would
-overwrite `GNUmakefile' and any customizations contained therein would
-be lost. Here is a short example of what the contents of
-`_SRC_/custom.defs' might contain:
+losing your settings if 'configure' is invoked; ie: 'configure' would
+overwrite 'GNUmakefile' and any customizations contained therein would
+be lost. Here is a short example of what the contents of
+'_SRC_/custom.defs' might contain:
## bump to gcc-4.6 in current path
GCC.gcc = /usr/bin/gcc-4.6
@@ -444,33 +401,33 @@ be lost. Here is a short example of what the contents of
## replace optimize for 'speed' with more aggressive settings
GCC.args.O.speed = -O3 -fomit-frame-pointer -msse4.2
-See also `make report.help' which displays a set of reports used to
-dump makefile vars.
+See also 'make report.help' which displays a set of reports used to dump
+makefile vars.
6 Troubleshooting
*****************
When troubleshooting build issues, the following files relative to the
-`build/' directory may be especially useful:
+'build/' directory may be especially useful:
-`GNUmakefile'
+'GNUmakefile'
Top-level makefile which contains build settings generated via
configure.
-`log/config.info.txt'
+'log/config.info.txt'
Record of output from configure.
-`log/config.verbose.txt'
+'log/config.verbose.txt'
Record of verbose output from configure.
-`log/build.txt'
- Record of output from `configure --launch'. Similar output may be
- recorded using `make' depending on which shell is in use, eg:
- `make >& log/build.txt' or `make > log/build.txt 2>&1'.
+'log/build.txt'
+ Record of output from 'configure --launch'. Similar output may be
+ recorded using 'make' depending on which shell is in use, eg: 'make
+ >& log/build.txt' or 'make > log/build.txt 2>&1'.
-`log/xcodemake.env.txt'
- Environment (variables) dump as seen when Xcode forks `make'.
- Mac OS X only.
+'log/xcodemake.env.txt'
+ Environment (variables) dump as seen when Xcode forks 'make'. Mac
+ OS X only.
Appendix A Project Repository Details
*************************************
@@ -479,7 +436,6 @@ Appendix A Project Repository Details
root: svn://svn.handbrake.fr/HandBrake
branch: trunk
uuid: b64f7644-9d1e-0410-96f1-a4d463321fa5
- rev: 5208
- date: 2013-01-26 18:47:13 +0000
+ rev: 6163
+ date: 2014-04-13 09:22:16 -0700
type: developer
-
diff --git a/doc/texi/building/chapter.via.terminal.texi b/doc/texi/building/chapter.via.terminal.texi
index a3a6929cc..e7190a450 100644
--- a/doc/texi/building/chapter.via.terminal.texi
+++ b/doc/texi/building/chapter.via.terminal.texi
@@ -145,7 +145,7 @@ Clean build output for @i{MODULE}.
@anchor{terminal.targets.contrib}
@subsection Contrib Modules
-Contrib modules such as @samp{a52dec}, @samp{bzip2}, @samp{faac}, @samp{faad2}, @samp{ffmpeg}, @samp{fontconfig}, @samp{freetype}, @samp{fribidi}, @samp{lame}, @samp{libass}, @samp{libbluray}, @samp{libdca}, @samp{libdvdnav}, @samp{libdvdread}, @samp{libdvdread}, @samp{libiconv}, @samp{libmkv}, @samp{libogg}, @samp{libsamplerate}, @samp{libtheora}, @samp{libvorbis}, @samp{libxml2}, @samp{mp4v2}, @samp{mpeg2dec}, @samp{x264}, @samp{yasm} and @samp{zlib} have the following scoped targets:
+Contrib modules such as @samp{a52dec}, @samp{bzip2}, @samp{faac}, @samp{faad2}, @samp{ffmpeg}, @samp{fontconfig}, @samp{freetype}, @samp{fribidi}, @samp{lame}, @samp{libass}, @samp{libbluray}, @samp{libdca}, @samp{libdvdnav}, @samp{libdvdread}, @samp{libiconv}, @samp{libmkv}, @samp{libogg}, @samp{libsamplerate}, @samp{libtheora}, @samp{libvorbis}, @samp{libxml2}, @samp{mp4v2}, @samp{mpeg2dec}, @samp{x264}, @samp{yasm} and @samp{zlib} have the following scoped targets:
@table @samp
@item make @i{MODULE}.fetch