diff options
author | Bradley Sepos <[email protected]> | 2016-12-22 01:58:13 -0500 |
---|---|---|
committer | Bradley Sepos <[email protected]> | 2016-12-22 02:55:27 -0500 |
commit | d6e2e09ee7c00d9ed371d0a9b16ca87b6ee417e1 (patch) | |
tree | 93093f95fb9b0bce7258634cb7dcf10aedcaa900 | |
parent | 6ccbfa43e09d1c8c22c4a1c2749a5bf4b6e017e2 (diff) |
doc: Remove legacy documentation.
Superseded by https://handbrake.fr/docs
-rw-r--r-- | doc/BUILD-Linux | 527 | ||||
-rw-r--r-- | doc/BUILD-Mac | 629 | ||||
-rw-r--r-- | doc/BUILD-MinGW | 438 | ||||
-rw-r--r-- | doc/module.defs | 41 | ||||
-rw-r--r-- | doc/module.rules | 35 | ||||
-rw-r--r-- | doc/texi/Building.linux.texi | 158 | ||||
-rw-r--r-- | doc/texi/Building.mingw.texi | 62 | ||||
-rw-r--r-- | doc/texi/Building.osx.texi | 82 | ||||
-rw-r--r-- | doc/texi/base/article.texi | 6 | ||||
-rw-r--r-- | doc/texi/base/glossary.texi | 8 | ||||
-rw-r--r-- | doc/texi/base/handbrake.texi.m4 | 29 | ||||
-rw-r--r-- | doc/texi/building/appendix.repo.texi | 10 | ||||
-rw-r--r-- | doc/texi/building/chapter.introduction.texi | 3 | ||||
-rw-r--r-- | doc/texi/building/chapter.quickstart.texi | 21 | ||||
-rw-r--r-- | doc/texi/building/chapter.troubleshooting.texi | 20 | ||||
-rw-r--r-- | doc/texi/building/chapter.via.terminal.texi | 247 | ||||
-rw-r--r-- | doc/texi/building/chapter.via.xcode.texi | 128 | ||||
-rw-r--r-- | doc/texi/building/command.texi | 4 | ||||
-rw-r--r-- | doc/texi/building/method.checkout.texi | 9 | ||||
-rw-r--r-- | doc/texi/building/prerequisites.bundled.texi | 3 | ||||
-rw-r--r-- | doc/texi/building/prerequisites.common.texi | 10 | ||||
-rw-r--r-- | make/include/main.defs | 1 |
22 files changed, 0 insertions, 2471 deletions
diff --git a/doc/BUILD-Linux b/doc/BUILD-Linux deleted file mode 100644 index 99a32d64e..000000000 --- a/doc/BUILD-Linux +++ /dev/null @@ -1,527 +0,0 @@ -Guide to Building HandBrake 20161005085545-3fe7f1d-master (2016100901) on Linux -******************************************************************************* - -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 -6 Troubleshooting -Appendix A Project Repository Details - -1 Introduction -************** - -This guide documents the recommended process to build HandBrake on Linux -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 Linux; -but is not necessarily the only configuration that is possible: - - * Intel 32-bit or 64-bit kernel - * Ubuntu 14.04, gcc 4.8, yasm 1.3.x - * Ubuntu 16.04, gcc 5.3, yasm 1.3.x - * Fedora 20, gcc 4.8, yasm 1.3.x - * gcc 4.7 or higher is reported to work - - 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: - - * git - 2.4.3 - * python - Python 2.7.1 - * m4 - GNU M4 1.4.17 - * make - GNU Make 3.81 - * patch - Patch 2.5.8 - * tar - GNU tar 1.26 - -The GTK UI introduces some significant extra build requirements. GTK -version 3.10+ is required to build the GTK UI. If you intend to disable -building the GUI with 'configure --disable-gtk' you will not need many -of these packages installed: - -Ubuntu 14.04, 16.04 packages: - * git (cli/gui) - * cmake (cli/gui) - * yasm (cli/gui) - * build-essential (cli/gui) - * autoconf (cli/gui) - * libtool (cli/gui) - * zlib1g-dev (cli/gui) - * libbz2-dev (cli/gui) - * libxml2-dev (cli/gui) - * libogg-dev (cli/gui) - * libtheora-dev (cli/gui) - * libvorbis-dev (cli/gui) - * libopus-dev (cli/gui) - * libsamplerate-dev (cli/gui) - * libfribidi-dev (cli/gui) - * libfreetype6-dev (cli/gui) - * libfontconfig1-dev (cli/gui) - * libharfbuzz-dev (cli/gui) - * libass-dev (cli/gui) - * libmp3lame-dev (cli/gui) - * libx264-dev (cli/gui) - * libjansson-dev (cli/gui) - * intltool (gui) - * libglib2.0-dev (gui) - * libdbus-glib-1-dev (gui) - * libgtk-3-dev (gui) - * libgudev-1.0-dev (gui) - * libwebkitgtk-3.0-dev (gui) - * libnotify-dev (gui) - * libgstreamer1.0-dev (gui) - * libgstreamer-plugins-base1.0-dev (gui) - * libappindicator-dev (gui) - -To install these packages: - sudo apt-get install git cmake yasm build-essential autoconf libtool \ - zlib1g-dev libbz2-dev libogg-dev libtheora-dev libvorbis-dev libopus-dev \ - libsamplerate-dev libxml2-dev libfribidi-dev libfreetype6-dev \ - libfontconfig1-dev libass-dev libmp3lame-dev libx264-dev libjansson-dev \ - intltool libglib2.0-dev libdbus-glib-1-dev libgtk-3-dev libgudev-1.0-dev \ - libwebkitgtk-3.0-dev libnotify-dev libgstreamer1.0-dev \ - libgstreamer-plugins-base1.0-dev libappindicator-dev - -Additional Ubuntu 16.04 packages: - * libtool-bin (cli/gui) - -To install these packages: - sudo apt-get install libtool-bin - -Fedora 20 package groups: - * Development Tools - * Development Libraries - * X Software Development (gui) - * GNOME Software Development (gui) - -To install these package groups: - sudo yum groupinstall "Development Tools" "Development Libraries" \ - "X Software Development" "GNOME Software Development" - -Additional Fedora packages: - * patch (cli/gui) - * intltool (cli/gui) - * libtool (cli/gui) - * cmake (cli/gui) - * gcc-c++ (cli/gui) - * yasm (cli/gui) - * zlib-devel (cli/gui) - * bzip2-devel (cli/gui) - * libogg-devel (cli/gui) - * libtheora-devel (cli/gui) - * libvorbis-devel (cli/gui) - * opus-devel (cli/gui) - * libsamplerate-devel (cli/gui) - * libxml2-devel (cli/gui) - * fribidi-devel (cli/gui) - * freetype-devel (cli/gui) - * fontconfig-devel (cli/gui) - * harfbuzz-devel (cli/gui) - * libass-devel (cli/gui) - * lame-devel (cli/gui) - * x264-devel (cli/gui) - * jansson-devel (cli/gui) - * dbus-glib-devel (gui) - * libgudev1-devel (gui) - * webkitgtk3-devel (gui) - * libnotify-devel (gui) - * gstreamer1-devel (gui) - * gstreamer1-plugins-base-devel (gui) - -To install these packages: - sudo yum install patch intltool libtool cmake gcc-c++ yasm zlib-devel \ - bzip2-devel libogg-devel libtheora-devel libvorbis-devel opus-devel \ - libsamplerate-devel libxml2-devel fribidi-devel freetype-devel \ - fontconfig-devel libass-devel lame-devel x264-devel jansson-devel \ - dbus-glib-devel libgudev1-devel webkitgtk3-devel libnotify-devel \ - gstreamer1-devel gstreamer1-plugins-base-devel - -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 -seeking more than a minimalist build. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - ./configure --launch - -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' - * echo build output - * print elapsed time - * indicate if build ultimately succeeded or failed - -4 Overview -********** - -Linux builds are performed from a terminal. There is no support for -building from any IDEs. - -5 Building via Terminal -*********************** - -5.1 Checkout Sources -==================== - -Checkout HandBrake from the official source-code repository. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - -Sources are checked out from the 'master' 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. - -5.2 Configure -============= - -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 -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 -options are also documented here: - -'--help' - List available options. - -'--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 '.' - -'--prefix=DIR' - Specify destination directory for final product install. This - defaults to a reasonable platform-specific value. - -'--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. - -'--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'. - -'--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 - 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. - -'--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 -reason for requiring a scratch directory; to promote consistent, -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 - * git 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' -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. - -5.3 Build -========= - -Build main product. All necessary dependencies are also built if -required. - - make - -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 -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: - - make -j4 - -5.4 Make Targets -================ - -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 -period. - -5.4.1 Global ------------- - -'make' - Alias for 'make build'. - -'make build' - Build main product. All necessary dependencies are also built if - required. - -'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 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 - retained. - -'make doc' - Build auto-generated project documentation. Various articles are - produced and may be found in 'build/doc/articles'. - -'make doc.post' - Build auto-generated project documentation and post produced - articles directly to source tree. - -'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' - 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 -scoped targets: - -'make MODULE.build' - Build MODULE. - -'make MODULE.clean' - Clean build output for MODULE. - -5.4.3 Contrib Modules ---------------------- - -Contrib modules such as 'bzip2', 'ffmpeg', 'fontconfig', 'freetype', -'fribidi', 'lame', 'libass', 'libbluray', 'libdvdnav', 'libdvdread', -'libiconv', 'libogg', 'libsamplerate', 'libtheora', 'libvorbis', -'libxml2', 'x264', 'yasm' and 'zlib' have the following scoped targets: - -'make MODULE.fetch' - Download source tarball from the Internet and save to - 'TOP/downloads' directory. No check-summing is performed. - -'make MODULE.extract' - Extract source tarball into 'build' tree. - -'make MODULE.patch' - Apply appropriate patches (if any) to module sources. - -'make MODULE.configure' - Configure module sources. This usually invokes autotool configure. - -'make MODULE.build' - Build module. This usually invokes autotool build. - -'make MODULE.install' - Install module products such as headers and libraries into 'build' - tree. This usually invokes autotool install. - -'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.xclean' - Extra clean module; first invokes uninstall then recursively - removes the module build directory. - -5.4.4 Contrib Touch and Untouch -------------------------------- - -Also available are some very granular targets which help force builds -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 ------------------------- - -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: - -'_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'. - -'_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'. - -'_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: - - ## bump to gcc-4.6 in current path - GCC.gcc = /usr/bin/gcc-4.6 - - ## 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. - -6 Troubleshooting -***************** - -When troubleshooting build issues, the following files relative to the -'build/' directory may be especially useful: - -'GNUmakefile' - Top-level makefile which contains build settings generated via - configure. - -'log/config.info.txt' - Record of output from configure. - -'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/xcodemake.env.txt' - Environment (variables) dump as seen when Xcode forks 'make'. Mac - OS X only. - -Appendix A Project Repository Details -************************************* - - url: https://github.com/HandBrake/HandBrake.git - branch: master - tag: - rev: 7542 - hash: 3fe7f1de0362a38b36edae2a831cec450089d202 - date: 2016-10-05 08:55:45 - type: developer diff --git a/doc/BUILD-Mac b/doc/BUILD-Mac deleted file mode 100644 index 08264e048..000000000 --- a/doc/BUILD-Mac +++ /dev/null @@ -1,629 +0,0 @@ -Build Guide for HandBrake 20161005085545-3fe7f1d-master on Mac OS X -******************************************************************* - -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 -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 -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. - -2 Prerequisites -*************** - -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.9.4 or later - * Xcode 6.0.1 - * Xcode command-line tools (installed via Preferences > Downloads > - Components) or download via Appla Developer website. - * 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.3.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. -The following general tools are used on various platforms and it is -recommended you use these versions or similar: - - * git - 2.4.3 - * python - Python 2.7.1 - * m4 - GNU M4 1.4.17 - * make - GNU Make 3.81 - * patch - Patch 2.5.8 - * tar - GNU tar 1.26 - -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 -seeking more than a minimalist build. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - ./configure --launch - -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' - * 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 -the GUI. - -5 Building via Terminal -*********************** - -5.1 Checkout Sources -==================== - -Checkout HandBrake from the official source-code repository. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - -Sources are checked out from the 'master' 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. - -5.2 Configure -============= - -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 -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 -options are also documented here: - -'--help' - List available options. - -'--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 '.' - -'--prefix=DIR' - Specify destination directory for final product install. This - defaults to a reasonable platform-specific value. - -'--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. - -'--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'. - -'--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 - 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. - -'--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 -reason for requiring a scratch directory; to promote consistent, -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 - * git 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' -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. - -5.3 Build -========= - -Build main product. All necessary dependencies are also built if -required. - - make - -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 -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: - - make -j4 - -5.4 Make Targets -================ - -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 -period. - -5.4.1 Global ------------- - -'make' - Alias for 'make build'. - -'make build' - Build main product. All necessary dependencies are also built if - required. - -'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 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 - retained. - -'make doc' - Build auto-generated project documentation. Various articles are - produced and may be found in 'build/doc/articles'. - -'make doc.post' - Build auto-generated project documentation and post produced - articles directly to source tree. - -'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' - 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 -scoped targets: - -'make MODULE.build' - Build MODULE. - -'make MODULE.clean' - Clean build output for MODULE. - -5.4.3 Contrib Modules ---------------------- - -Contrib modules such as 'bzip2', 'ffmpeg', 'fontconfig', 'freetype', -'fribidi', 'lame', 'libass', 'libbluray', 'libdvdnav', 'libdvdread', -'libiconv', 'libogg', 'libsamplerate', 'libtheora', 'libvorbis', -'libxml2', 'x264', 'yasm' and 'zlib' have the following scoped targets: - -'make MODULE.fetch' - Download source tarball from the Internet and save to - 'TOP/downloads' directory. No check-summing is performed. - -'make MODULE.extract' - Extract source tarball into 'build' tree. - -'make MODULE.patch' - Apply appropriate patches (if any) to module sources. - -'make MODULE.configure' - Configure module sources. This usually invokes autotool configure. - -'make MODULE.build' - Build module. This usually invokes autotool build. - -'make MODULE.install' - Install module products such as headers and libraries into 'build' - tree. This usually invokes autotool install. - -'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.xclean' - Extra clean module; first invokes uninstall then recursively - removes the module build directory. - -5.4.4 Contrib Touch and Untouch -------------------------------- - -Also available are some very granular targets which help force builds -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 ------------------------- - -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: - -'_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'. - -'_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'. - -'_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: - - ## bump to gcc-4.6 in current path - GCC.gcc = /usr/bin/gcc-4.6 - - ## 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. - -5.6 Universal Binaries -====================== - -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. - -Create a dummy (container) build configuration and use it to launch a -nested-build for each architecture: - - ./configure --disable-xcode - cd build/ - make ub.build - make ub.combine - -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 -how to specify a different list of xcconfigs: - - ./configure --disable-xcode - cd build/ - make UB.xcconfigs="osx107.i386 osx107.x86_64" ub.build - make UB.xcconfigs="osx107.i386 osx107.x86_64" ub.combine - -6 Building via Xcode.app -************************ - -6.1 Checkout Sources -==================== - -Checkout HandBrake from the official source-code repository. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - -Sources are checked out from the 'master' 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. - -6.2 Build -========= - -Perform the following steps to build: - - * 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: - - * 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 - Xcode project is opened the Project view Derived Data is - 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 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 - 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 - brought forward from history. - - 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 - 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. - -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 -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 -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 -log; redo build sequentially: - - make xclean - make BUILD.jobs=1 - -Example; build external x264 module: - - make x264.clean - make x264 - -Example; extract, configure, build and install external x264 module: - - make x264.xclean - make x264.install - -Example; something in a big module is failing; redo build sequentially: - - make ffmpeg.clean - make BUILD.jobs=1 ffmpeg - -6.6 User-Defined Settings -========================= - -The following user defined settings are visible in Xcode project and are -used for the external build system. - -'EXTERNAL_BUILD' - Do not modify; used to specify the build (scratch) directory. - -'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' - 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 - inside xcconfig file. - -7 Troubleshooting -***************** - -When troubleshooting build issues, the following files relative to the -'build/' directory may be especially useful: - -'GNUmakefile' - Top-level makefile which contains build settings generated via - configure. - -'log/config.info.txt' - Record of output from configure. - -'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/xcodemake.env.txt' - Environment (variables) dump as seen when Xcode forks 'make'. Mac - OS X only. - -Appendix A Project Repository Details -************************************* - - url: https://github.com/HandBrake/HandBrake.git - branch: master - tag: - rev: 7542 - hash: 3fe7f1de0362a38b36edae2a831cec450089d202 - date: 2016-10-05 08:55:45 - type: developer diff --git a/doc/BUILD-MinGW b/doc/BUILD-MinGW deleted file mode 100644 index 2935dbe02..000000000 --- a/doc/BUILD-MinGW +++ /dev/null @@ -1,438 +0,0 @@ -Guide to Building HandBrake 20161005085545-3fe7f1d-master (2016100901) on MinGW-W64 -*********************************************************************************** - -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 -6 Troubleshooting -Appendix A Project Repository Details - -1 Introduction -************** - -This guide documents the recommended process to build HandBrake on -MinGW-W64 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-W64; but is not necessarily the only configuration that is -possible: - - * Intel 64-bit hardware - * MinGW-W64 on Fedora 20+, Ubuntu 14+ or Debian 7+ using gcc 4.7+ - * Official MinGW-w64 builds are recommended over those provided by - distributions. - * yasm 1.3 or newer - * Please be aware libfftw3-dev can cause build failures. You - currently need to remove this package if installed for HandBrake to - build. - - Note: We use MinGW-w64 from - http://sourceforge.net/projects/mingw-w64/files/?source=navbar - - Please see "Toolchains targetting Win64" -> "Automated Builds" and - choose the latest version. - - At the time of writing, - "mingw-w64-bin_x86_64-linux_20131228.tar.bz2" is used. - - Note2: You must set the -cross flag with configure to cross compile - with windows. See the Example below. Note that the cross compiler - name varies between distributions. - - The following is an example: - - ../configure --cross=x86_64-w64-mingw32 --launch - -The following general tools are used on various platforms and it is -recommended you use these versions or similar: - - * git - 2.4.3 - * python - Python 2.7.1 - * m4 - GNU M4 1.4.17 - * make - GNU Make 3.81 - * patch - Patch 2.5.8 - * tar - GNU tar 1.26 - -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 -seeking more than a minimalist build. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - ./configure --launch - -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' - * echo build output - * print elapsed time - * indicate if build ultimately succeeded or failed - -4 Overview -********** - -MinGW-W64 builds are performed from a terminal. There is no support for -building from any IDEs. - -5 Building via Terminal -*********************** - -5.1 Checkout Sources -==================== - -Checkout HandBrake from the official source-code repository. - - git clone https://github.com/HandBrake/HandBrake.git hb-master - cd hb-master - -Sources are checked out from the 'master' 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. - -5.2 Configure -============= - -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 -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 -options are also documented here: - -'--help' - List available options. - -'--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 '.' - -'--prefix=DIR' - Specify destination directory for final product install. This - defaults to a reasonable platform-specific value. - -'--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. - -'--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'. - -'--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 - 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. - -'--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 -reason for requiring a scratch directory; to promote consistent, -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 - * git 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' -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. - -5.3 Build -========= - -Build main product. All necessary dependencies are also built if -required. - - make - -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 -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: - - make -j4 - -5.4 Make Targets -================ - -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 -period. - -5.4.1 Global ------------- - -'make' - Alias for 'make build'. - -'make build' - Build main product. All necessary dependencies are also built if - required. - -'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 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 - retained. - -'make doc' - Build auto-generated project documentation. Various articles are - produced and may be found in 'build/doc/articles'. - -'make doc.post' - Build auto-generated project documentation and post produced - articles directly to source tree. - -'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' - 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 -scoped targets: - -'make MODULE.build' - Build MODULE. - -'make MODULE.clean' - Clean build output for MODULE. - -5.4.3 Contrib Modules ---------------------- - -Contrib modules such as 'bzip2', 'ffmpeg', 'fontconfig', 'freetype', -'fribidi', 'lame', 'libass', 'libbluray', 'libdvdnav', 'libdvdread', -'libiconv', 'libogg', 'libsamplerate', 'libtheora', 'libvorbis', -'libxml2', 'x264', 'yasm' and 'zlib' have the following scoped targets: - -'make MODULE.fetch' - Download source tarball from the Internet and save to - 'TOP/downloads' directory. No check-summing is performed. - -'make MODULE.extract' - Extract source tarball into 'build' tree. - -'make MODULE.patch' - Apply appropriate patches (if any) to module sources. - -'make MODULE.configure' - Configure module sources. This usually invokes autotool configure. - -'make MODULE.build' - Build module. This usually invokes autotool build. - -'make MODULE.install' - Install module products such as headers and libraries into 'build' - tree. This usually invokes autotool install. - -'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.xclean' - Extra clean module; first invokes uninstall then recursively - removes the module build directory. - -5.4.4 Contrib Touch and Untouch -------------------------------- - -Also available are some very granular targets which help force builds -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 ------------------------- - -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: - -'_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'. - -'_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'. - -'_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: - - ## bump to gcc-4.6 in current path - GCC.gcc = /usr/bin/gcc-4.6 - - ## 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. - -6 Troubleshooting -***************** - -When troubleshooting build issues, the following files relative to the -'build/' directory may be especially useful: - -'GNUmakefile' - Top-level makefile which contains build settings generated via - configure. - -'log/config.info.txt' - Record of output from configure. - -'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/xcodemake.env.txt' - Environment (variables) dump as seen when Xcode forks 'make'. Mac - OS X only. - -Appendix A Project Repository Details -************************************* - - url: https://github.com/HandBrake/HandBrake.git - branch: master - tag: - rev: 7542 - hash: 3fe7f1de0362a38b36edae2a831cec450089d202 - date: 2016-10-05 08:55:45 - type: developer diff --git a/doc/module.defs b/doc/module.defs deleted file mode 100644 index de427a3fe..000000000 --- a/doc/module.defs +++ /dev/null @@ -1,41 +0,0 @@ -$(eval $(call import.MODULE.defs,DOC,doc)) - -DOC.in/ = $(SRC/)doc/ -DOC.out/ = $(BUILD/)doc/ - -DOC.out.api/ = $(DOC.out/)api/ -DOC.out.articles/ = $(DOC.out/)articles/ - -############################################################################### - -DOC.m4.srcs = \ - texi/base/handbrake.texi.m4 - -DOC.m4.in = $(foreach n,$(DOC.m4.srcs),$(DOC.in/)$n) -DOC.m4.out = $(patsubst $(DOC.in/)%.m4,$(DOC.out/)%,$(DOC.m4.in)) - -DOC.texi.includes = $(wildcard $(DOC.in/)texi/*/*.texi) -DOC.texi.articles = $(wildcard $(DOC.in/)texi/*.texi) - -DOC.texi2html.out = $(patsubst $(DOC.in/)texi/%.texi,$(DOC.out.articles/)html/%.html,$(DOC.texi.articles)) -DOC.texi2txt.out = $(patsubst $(DOC.in/)texi/%.texi,$(DOC.out.articles/)txt/%.txt,$(DOC.texi.articles)) -DOC.texi2xml.out = $(patsubst $(DOC.in/)texi/%.texi,$(DOC.out.articles/)xml/%.xml,$(DOC.texi.articles)) - -BUILD.out += $(DOC.m4.out) -BUILD.out += $(DOC.texi2html.out) -BUILD.out += $(DOC.texi2txt.out) -BUILD.out += $(DOC.texi2xml.out) - -############################################################################### - -DOC.M4.exe = $(M4.exe) -DOC.M4.flags = -I$(BUILD/)project -DOC.M4.deps = $(BUILD/)project/handbrake.m4 -DOC.M4 = $(DOC.M4.exe) $(DOC.M4.flags) $(2) > $(1) - -MAKEINFO.exe = makeinfo -MAKEINFO.flags = -I$(DOC.out/)texi -I$(DOC.in/)texi -MAKEINFO.flags.html = --html --no-headers --no-split -MAKEINFO.flags.txt = --plaintext --no-headers -MAKEINFO.flags.xml = --xml --output-indent=4 -MAKEINFO = $(MAKEINFO.exe) $(MAKEINFO.flags) $(MAKEINFO.flags.$(1)) $(2) -o $(3) diff --git a/doc/module.rules b/doc/module.rules deleted file mode 100644 index 75b83174e..000000000 --- a/doc/module.rules +++ /dev/null @@ -1,35 +0,0 @@ -$(eval $(call import.MODULE.rules,DOC)) - -doc: doc.txt - -doc.post: doc.txt - $(CP.exe) $(DOC.out.articles/)txt/Building.osx.txt $(DOC.in/)BUILD-Mac - $(CP.exe) $(DOC.out.articles/)txt/Building.linux.txt $(DOC.in/)BUILD-Linux - $(CP.exe) $(DOC.out.articles/)txt/Building.mingw.txt $(DOC.in/)BUILD-MinGW - -doc.txt: $(DOC.texi2txt.out) -doc.xml: $(DOC.texi2xml.out) - -doc.clean: - $(RM.exe) -fr $(DOC.out/) - -$(DOC.texi2txt.out): | $(DOC.m4.out) -$(DOC.texi2txt.out): | $(dir $(DOC.texi2txt.out)) -$(DOC.texi2txt.out): $(DOC.texi.includes) -$(DOC.texi2txt.out): $(DOC.out.articles/)txt/%.txt: $(DOC.in/)texi/%.texi - $(call MAKEINFO,txt,$<,$@) - @echo $^ - -$(DOC.texi2xml.out): | $(DOC.m4.out) -$(DOC.texi2xml.out): | $(dir $(DOC.texi2xml.out)) -$(DOC.texi2xml.out): $(DOC.texi.includes) -$(DOC.texi2xml.out): $(DOC.out.articles/)xml/%.xml: $(DOC.in/)texi/%.texi - $(call MAKEINFO,xml,$<,$@) - @echo $^ - -$(DOC.m4.out): | $(dir $(DOC.m4.out)) -$(DOC.m4.out): $(DOC.M4.deps) -$(DOC.m4.out): $(DOC.out/)%: $(DOC.in/)%.m4 - $(call DOC.M4,$@,$<) - -clean: doc.clean diff --git a/doc/texi/Building.linux.texi b/doc/texi/Building.linux.texi deleted file mode 100644 index ef9fdbc0d..000000000 --- a/doc/texi/Building.linux.texi +++ /dev/null @@ -1,158 +0,0 @@ -\input texinfo @c -*- Texinfo -*- -@c %**start of header -@setfilename Building.linux.info -@include base/article.texi -@include building/command.texi -@paragraphindent none - -@set BG-platform @value{OS-linux} -@c %**end of header - -@majorheading Guide to Building @value{HB-title} on @value{BG-platform} -@contents -@sp 1 -@include building/chapter.introduction.texi - -@c %**------------------------------------------------------------------------- -@anchor{prerequisites} -@chapter Prerequisites -The following are the recommended specifications for building on @value{OS-linux}; but is not necessarily the only configuration that is possible: - -@itemize @bullet -@item Intel 32-bit or 64-bit kernel -@item Ubuntu 14.04, gcc 4.8, yasm 1.3.x -@item Ubuntu 16.04, gcc 5.3, yasm 1.3.x -@item Fedora 20, gcc 4.8, yasm 1.3.x -@item gcc 4.7 or higher is reported to work -@end itemize - -@include building/prerequisites.bundled.texi - -@include building/prerequisites.common.texi - -The @b{GTK UI} introduces some significant extra build requirements. GTK version 3.10+ is required to build the GTK UI. If you intend to disable building the GUI with @command{configure --disable-gtk} you will not need many of these packages installed: - -Ubuntu 14.04, 16.04 packages: -@itemize @bullet -@item git (cli/gui) -@item cmake (cli/gui) -@item yasm (cli/gui) -@item build-essential (cli/gui) -@item autoconf (cli/gui) -@item libtool (cli/gui) -@item zlib1g-dev (cli/gui) -@item libbz2-dev (cli/gui) -@item libxml2-dev (cli/gui) -@item libogg-dev (cli/gui) -@item libtheora-dev (cli/gui) -@item libvorbis-dev (cli/gui) -@item libopus-dev (cli/gui) -@item libsamplerate-dev (cli/gui) -@item libfribidi-dev (cli/gui) -@item libfreetype6-dev (cli/gui) -@item libfontconfig1-dev (cli/gui) -@item libharfbuzz-dev (cli/gui) -@item libass-dev (cli/gui) -@item libmp3lame-dev (cli/gui) -@item libx264-dev (cli/gui) -@item libjansson-dev (cli/gui) -@item intltool (gui) -@item libglib2.0-dev (gui) -@item libdbus-glib-1-dev (gui) -@item libgtk-3-dev (gui) -@item libgudev-1.0-dev (gui) -@item libwebkitgtk-3.0-dev (gui) -@item libnotify-dev (gui) -@item libgstreamer1.0-dev (gui) -@item libgstreamer-plugins-base1.0-dev (gui) -@item libappindicator-dev (gui) -@end itemize - -To install these packages: -@example -sudo apt-get install git cmake yasm build-essential autoconf libtool \ -zlib1g-dev libbz2-dev libogg-dev libtheora-dev libvorbis-dev libopus-dev \ -libsamplerate-dev libxml2-dev libfribidi-dev libfreetype6-dev \ -libfontconfig1-dev libass-dev libmp3lame-dev libx264-dev libjansson-dev \ -intltool libglib2.0-dev libdbus-glib-1-dev libgtk-3-dev libgudev-1.0-dev \ -libwebkitgtk-3.0-dev libnotify-dev libgstreamer1.0-dev \ -libgstreamer-plugins-base1.0-dev libappindicator-dev -@end example - -Additional Ubuntu 16.04 packages: -@itemize @bullet -@item libtool-bin (cli/gui) -@end itemize - -To install these packages: -@example -sudo apt-get install libtool-bin -@end example - -Fedora 20 package groups: -@itemize @bullet -@item Development Tools -@item Development Libraries -@item X Software Development (gui) -@item GNOME Software Development (gui) -@end itemize - -To install these package groups: -@example -sudo yum groupinstall "Development Tools" "Development Libraries" \ -"X Software Development" "GNOME Software Development" -@end example - -Additional Fedora packages: -@itemize @bullet -@item patch (cli/gui) -@item intltool (cli/gui) -@item libtool (cli/gui) -@item cmake (cli/gui) -@item gcc-c++ (cli/gui) -@item yasm (cli/gui) -@item zlib-devel (cli/gui) -@item bzip2-devel (cli/gui) -@item libogg-devel (cli/gui) -@item libtheora-devel (cli/gui) -@item libvorbis-devel (cli/gui) -@item opus-devel (cli/gui) -@item libsamplerate-devel (cli/gui) -@item libxml2-devel (cli/gui) -@item fribidi-devel (cli/gui) -@item freetype-devel (cli/gui) -@item fontconfig-devel (cli/gui) -@item harfbuzz-devel (cli/gui) -@item libass-devel (cli/gui) -@item lame-devel (cli/gui) -@item x264-devel (cli/gui) -@item jansson-devel (cli/gui) -@item dbus-glib-devel (gui) -@item libgudev1-devel (gui) -@item webkitgtk3-devel (gui) -@item libnotify-devel (gui) -@item gstreamer1-devel (gui) -@item gstreamer1-plugins-base-devel (gui) -@end itemize - -To install these packages: -@example -sudo yum install patch intltool libtool cmake gcc-c++ yasm zlib-devel \ -bzip2-devel libogg-devel libtheora-devel libvorbis-devel opus-devel \ -libsamplerate-devel libxml2-devel fribidi-devel freetype-devel \ -fontconfig-devel libass-devel lame-devel x264-devel jansson-devel \ -dbus-glib-devel libgudev1-devel webkitgtk3-devel libnotify-devel \ -gstreamer1-devel gstreamer1-plugins-base-devel -@end example - -@c %**------------------------------------------------------------------------- -@include building/chapter.quickstart.texi - -@anchor{overview} -@chapter Overview -@value{OS-linux} builds are performed from a @b{terminal}. There is no support for building from any IDEs. - -@c %**------------------------------------------------------------------------- -@include building/chapter.via.terminal.texi -@include building/chapter.troubleshooting.texi -@include building/appendix.repo.texi diff --git a/doc/texi/Building.mingw.texi b/doc/texi/Building.mingw.texi deleted file mode 100644 index 314436237..000000000 --- a/doc/texi/Building.mingw.texi +++ /dev/null @@ -1,62 +0,0 @@ -\input texinfo @c -*- Texinfo -*- -@c %**start of header -@setfilename Building.mingw.info -@include base/article.texi -@include building/command.texi -@paragraphindent none - -@set BG-platform @value{OS-mingw} -@c %**end of header - -@majorheading Guide to Building @value{HB-title} on @value{BG-platform} -@contents -@sp 1 -@include building/chapter.introduction.texi - -@c %**------------------------------------------------------------------------- -@anchor{prerequisites} -@chapter Prerequisites -The following are the recommended specifications for building on @value{OS-mingw}; but is not necessarily the only configuration that is possible: - -@itemize @bullet -@item Intel 64-bit hardware -@item @value{OS-mingw} on Fedora 20+, Ubuntu 14+ or Debian 7+ using gcc 4.7+ -@item Official MinGW-w64 builds are recommended over those provided by distributions. -@item yasm 1.3 or newer -@item Please be aware libfftw3-dev can cause build failures. You currently need to remove this package if installed for HandBrake to build. -@end itemize - - -@quotation Note -We use MinGW-w64 from http://sourceforge.net/projects/mingw-w64/files/?source=navbar - -Please see "Toolchains targetting Win64" -> "Automated Builds" and choose the latest version. - -At the time of writing, "mingw-w64-bin_x86_64-linux_20131228.tar.bz2" is used. - -@end quotation - -@quotation Note2 -You must set the --cross flag with configure to cross compile with windows. -See the Example below. Note that the cross compiler name varies between distributions. - -The following is an example: -@end quotation - -@example -../configure --cross=x86_64-w64-mingw32 --launch -@end example - -@include building/prerequisites.common.texi - -@c %**------------------------------------------------------------------------- -@include building/chapter.quickstart.texi - -@anchor{overview} -@chapter Overview -@value{OS-mingw} builds are performed from a @b{terminal}. There is no support for building from any IDEs. - -@c %**------------------------------------------------------------------------- -@include building/chapter.via.terminal.texi -@include building/chapter.troubleshooting.texi -@include building/appendix.repo.texi diff --git a/doc/texi/Building.osx.texi b/doc/texi/Building.osx.texi deleted file mode 100644 index bcaa4d3ac..000000000 --- a/doc/texi/Building.osx.texi +++ /dev/null @@ -1,82 +0,0 @@ -\input texinfo @c -*- Texinfo -*- -@c %**start of header -@setfilename Building.osx.info -@include base/article.texi -@include building/command.texi -@paragraphindent none - -@set BG-platform @value{OS-osx} -@c %**end of header - -@majorheading Build Guide for @value{HB-name} @value{HB-version} on @value{BG-platform} -@contents -@sp 1 -@include building/chapter.introduction.texi - -@c %**------------------------------------------------------------------------- -@anchor{prerequisites} -@chapter Prerequisites -Building on @value{OS-osx} is well supported. It is the reference platform for @value{HB-name}. The following are the recommended specifications for this platform; but is not necessarily the only configuration that is possible: - -@itemize @bullet -@item Mac Intel hardware -@item @value{OS-osx} 10.9.4 or later -@item Xcode 6.0.1 -@item Xcode command-line tools (installed via Preferences > Downloads > Components) or download via Appla Developer website. -@item XQuartz (http://xquartz.macosforge.org/landing/) -@end itemize - -The following tools are compiled during the build process if necessary, but you can speed up your build by installing them: - -@itemize @bullet -@item yasm 1.3.0 or later -@item autoconf -@item automake -@item libtool -@end itemize - -@include building/prerequisites.bundled.texi -@include building/prerequisites.common.texi - -@c %**------------------------------------------------------------------------- -@include building/chapter.quickstart.texi - -@c %**------------------------------------------------------------------------- -@anchor{overview} -@chapter Overview -The two general methods to build on @value{OS-osx} are from @b{terminal} or @b{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 @command{xcodebuild} to build the very same targets contained in the Xcode project. Think of it as building with Xcode but without the GUI. - -@c %**------------------------------------------------------------------------- -@include building/chapter.via.terminal.texi - -@c %**------------------------------------------------------------------------- -@anchor{terminal.ub} -@section Universal Binaries -This section outlines convenience procedures for creating Universal Binaries for all the architectures. - -@quotation Note -The dummy (container) build configuration uses @command{--disable-xcode}; but the nested architecture builds will all make full use of Xcode. -@end quotation - -Create a dummy (container) build configuration and use it to launch a nested-build for each architecture: - -@example -./configure --disable-xcode -cd build/ -make ub.build -make ub.combine -@end example - -The list of architectures is hard coded to @value{HB-name}'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 how to specify a different list of xcconfigs: - -@example -./configure --disable-xcode -cd build/ -make UB.xcconfigs="osx107.i386 osx107.x86_64" ub.build -make UB.xcconfigs="osx107.i386 osx107.x86_64" ub.combine -@end example - -@c %**------------------------------------------------------------------------- -@include building/chapter.via.xcode.texi -@include building/chapter.troubleshooting.texi -@include building/appendix.repo.texi diff --git a/doc/texi/base/article.texi b/doc/texi/base/article.texi deleted file mode 100644 index 7ff6c7480..000000000 --- a/doc/texi/base/article.texi +++ /dev/null @@ -1,6 +0,0 @@ -@ifhtml -@exampleindent 0 -@end ifhtml - -@include base/handbrake.texi -@include base/glossary.texi diff --git a/doc/texi/base/glossary.texi b/doc/texi/base/glossary.texi deleted file mode 100644 index 17229cf30..000000000 --- a/doc/texi/base/glossary.texi +++ /dev/null @@ -1,8 +0,0 @@ -@set OS-cygwin Cygwin -@set OS-freebsd FreeBSD -@set OS-linux Linux -@set OS-osx Mac OS X -@set OS-solaris Solaris -@set OS-unix unix -@set OS-windows Windows -@set OS-mingw MinGW-W64 diff --git a/doc/texi/base/handbrake.texi.m4 b/doc/texi/base/handbrake.texi.m4 deleted file mode 100644 index 099e7f78f..000000000 --- a/doc/texi/base/handbrake.texi.m4 +++ /dev/null @@ -1,29 +0,0 @@ -changequote(<<,>>)dnl -include(<<handbrake.m4>>)dnl -dnl -dnl -dnl -@set HB-title __HB_title -@set HB-name __HB_name -@set HB-name-lower __HB_name_lower -@set HB-name-upper __HB_name_upper -@set HB-acro-lower __HB_acro_lower -@set HB-acro-upper __HB_acro_upper -@set HB-url-website __HB_url_website -@set HB-url-community __HB_url_community -@set HB-url-irc __HB_url_irc -@set HB-url-appcast __HB_url_appcast -@set HB-version-major __HB_version_major -@set HB-version-minor __HB_version_minor -@set HB-version-point __HB_version_point -@set HB-version __HB_version -@set HB-version-hex __HB_version_hex -@set HB-build __HB_build -@set HB-repo-url __HB_repo_url -@set HB-repo-branch __HB_repo_branch -@set HB-repo-tag __HB_repo_tag -@set HB-repo-rev __HB_repo_rev -@set HB-repo-hash __HB_repo_hash -@set HB-repo-date __HB_repo_date -@set HB-repo-official __HB_repo_official -@set HB-repo-type __HB_repo_type diff --git a/doc/texi/building/appendix.repo.texi b/doc/texi/building/appendix.repo.texi deleted file mode 100644 index 59b501ed0..000000000 --- a/doc/texi/building/appendix.repo.texi +++ /dev/null @@ -1,10 +0,0 @@ -@appendix Project Repository Details -@example -url: @value{HB-repo-url} -branch: @value{HB-repo-branch} -tag: @value{HB-repo-tag} -rev: @value{HB-repo-rev} -hash: @value{HB-repo-hash} -date: @value{HB-repo-date} -type: @value{HB-repo-type} -@end example diff --git a/doc/texi/building/chapter.introduction.texi b/doc/texi/building/chapter.introduction.texi deleted file mode 100644 index 60cd82379..000000000 --- a/doc/texi/building/chapter.introduction.texi +++ /dev/null @@ -1,3 +0,0 @@ -@anchor{introduction} -@chapter Introduction -This guide documents the recommended process to build @value{HB-name} on @value{BG-platform} hosts from the official source-code repository. @b{Building from any other source is not supported}. diff --git a/doc/texi/building/chapter.quickstart.texi b/doc/texi/building/chapter.quickstart.texi deleted file mode 100644 index 56b18b3c1..000000000 --- a/doc/texi/building/chapter.quickstart.texi +++ /dev/null @@ -1,21 +0,0 @@ -@anchor{quickstart} -@chapter 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 @value{HB-name}. Further instructions are available beginning with @ref{overview} which describes procedures suitable for repeating builds. This chapter should be skipped by those seeking more than a minimalist build. - -@example -@COMMAND-checkout{} -./configure --launch -@end example - -The special option @command{--launch} selects launch mode and performs the following steps: - -@itemize -@item assert scratch directory @file{build/} does not exist -@item create scratch directory @file{build/} -@item change to directory @file{build/} -@item launch @command{make} -@item capture build output to @file{build/log/build.txt} -@item echo build output -@item print elapsed time -@item indicate if build ultimately succeeded or failed -@end itemize diff --git a/doc/texi/building/chapter.troubleshooting.texi b/doc/texi/building/chapter.troubleshooting.texi deleted file mode 100644 index 7796317b7..000000000 --- a/doc/texi/building/chapter.troubleshooting.texi +++ /dev/null @@ -1,20 +0,0 @@ -@anchor{troubleshooting} -@chapter Troubleshooting -When troubleshooting build issues, the following files relative to the @file{build/} directory may be especially useful: - -@table @file -@item GNUmakefile -Top-level makefile which contains build settings generated via @b{configure}. - -@item log/config.info.txt -Record of output from @b{configure}. - -@item log/config.verbose.txt -Record of verbose output from @b{configure}. - -@item log/build.txt -Record of output from @command{configure --launch}. Similar output may be recorded using @command{make} depending on which shell is in use, eg: @command{make >& log/build.txt} or @command{make > log/build.txt 2>&1}. - -@item log/xcodemake.env.txt -Environment (variables) dump as seen when Xcode forks @command{make}. @value{OS-osx} only. -@end table diff --git a/doc/texi/building/chapter.via.terminal.texi b/doc/texi/building/chapter.via.terminal.texi deleted file mode 100644 index b98301b66..000000000 --- a/doc/texi/building/chapter.via.terminal.texi +++ /dev/null @@ -1,247 +0,0 @@ -@anchor{terminal} -@chapter Building via Terminal - -@c %**------------------------------------------------------------------------- -@anchor{terminal.checkout} -@section Checkout Sources -@include building/method.checkout.texi - -@c %**------------------------------------------------------------------------- -@anchor{terminal.configure} -@section Configure -Configure the build system. - -@example -./configure -@end example - -Configure will automatically create a scratch build directory @file{build} unless you use GNU-style build procedures and first @command{cd} to a directory other than top-level source. Additionally you may use @command{--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 @b{not} checked into the repository. - -The @command{configure} utility accepts many options. It is recommended that you specify @command{--help} for the complete list of options. The following options are also documented here: - -@table @samp -@item --help -List available options. - -@item --src=DIR -Specify top-level source directory for @value{HB-name} sources. - -@item --build=DIR -Specify destination directory for final product install. The default is to use either @file{build} if in the top-level source directory, otherwise @file{.} - -@item --prefix=DIR -Specify destination directory for final product install. -This defaults to a reasonable platform-specific value. - -@item --launch -All-in-one option which launches the build and logs output automatically. -Useful for novices and quick-start procedures. - -@item --disable-gtk -Disable building the GTK GUI on applicable platforms such as @value{OS-linux}. - -@item --debug=MODE -Select debug mode. Must be one of @samp{none}, @samp{min}, @samp{std}, @samp{max}. -This generally maps to gcc options @samp{-g0}, @samp{-g1}, @samp{-g2}, @samp{-g3}. - -@item --optimize=MODE -Select optimize mode. Must be one of @samp{none}, @samp{speed}, @samp{size}. -This generally maps to gcc options @samp{-g0}, @samp{-O0}, @samp{-O3}, @samp{-Os}. - -@item --arch=MODE -Select build architecture. The available architectures vary by platform. Most platforms support exactly one architecture except @value{OS-osx} which has support for various universal binary architectures. The available choices are hard-coded per platform and no sanity checks for the required tools are performed. - -@item --disable-xcode -Disable shunting the build through @command{xcodebuild}. If this option is applied, @command{HandBrakeCLI} will be produced in a similar fashion as it is on other platforms; sans Xcode and the Cocoa application will not be produced. @value{OS-osx} only. - -@item --xcconfig=MODE -Select Xcode project configuration file. The available modes are the basenames of files located in @file{macosx/xcconfig/*.xcconfig} which direct Xcode to build using various architecture and @value{OS-osx} deployment options. @value{OS-osx} only. -@end table - -Clean-room procedures dictate that when certain factors change, old 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 some of the reasons why someone may choose to scrap an existing build: - -@itemize -@item configure with different options -@item git working dir is updated and you want configure to re-evaluate working dir metadata. -@item build corruption is suspected -@end itemize - -There are generally two methods for scrapping a build. The @file{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 @command{make xclean}. This is known to work well but will leave empty directories behind. However, the configuration is left intact. - -@c %**------------------------------------------------------------------------- -@anchor{terminal.build} -@section Build -Build main product. All necessary dependencies are also built if required. - -@example -make -@end example - -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 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: - -@example -make -j4 -@end example - -@c %**------------------------------------------------------------------------- -@anchor{terminal.targets} -@section Make Targets - -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 @command{make}. Global targets are one-word targets. Scoped targets are usually two-words separated by a period. - -@anchor{terminal.targets.global} -@subsection Global - -@table @samp -@item make -Alias for @samp{make build}. - -@item make build -Build main product. All necessary dependencies are also built if required. - -@item make clean -Clean all build output excluding contrib modules. Configuration is retained. - -@item make install -Perform final product(s) install. -This will install build products to a standard directory or one specified via @command{configure --prefix} option. - -@item make uninstall -Perform final product(s) uninstall. -This will uninstall any products which may have been previously installed. - -@item make xclean -Clean all build output including contrib modules. Configuration is retained. - -@item make doc -Build auto-generated project documentation. Various articles are produced and may be found in @file{build/doc/articles}. - -@item make doc.post -Build auto-generated project documentation and post produced articles directly to source tree. - -@item make report.help -Print list of available makefile vars report targets. -These reports detail var definitions and expanded values used by the build system. -@b{For experts only}. - -@item make report.all -Convenience target which aggregates all reports. -@b{For experts only}. -@end table - -@anchor{terminal.targets.general} -@subsection General Modules - -General modules such as @samp{libhb}, @samp{test} and @samp{gtk} have the following scoped targets: - -@table @samp -@item make @i{MODULE}.build -Build @i{MODULE}. - -@item make @i{MODULE}.clean -Clean build output for @i{MODULE}. -@end table - -@anchor{terminal.targets.contrib} -@subsection Contrib Modules - -Contrib modules such as @samp{bzip2}, @samp{ffmpeg}, @samp{fontconfig}, @samp{freetype}, @samp{fribidi}, @samp{lame}, @samp{libass}, @samp{libbluray}, @samp{libdvdnav}, @samp{libdvdread}, @samp{libiconv}, @samp{libogg}, @samp{libsamplerate}, @samp{libtheora}, @samp{libvorbis}, @samp{libxml2}, @samp{x264}, @samp{yasm} and @samp{zlib} have the following scoped targets: - -@table @samp -@item make @i{MODULE}.fetch -Download source tarball from the Internet and save to @file{TOP/downloads} directory. No check-summing is performed. - -@item make @i{MODULE}.extract -Extract source tarball into @file{build} tree. - -@item make @i{MODULE}.patch -Apply appropriate patches (if any) to module sources. - -@item make @i{MODULE}.configure -Configure module sources. -This usually invokes autotool configure. - -@item make @i{MODULE}.build -Build module. -This usually invokes autotool build. - -@item make @i{MODULE}.install -Install module products such as headers and libraries into @file{build} tree. -This usually invokes autotool install. - -@item make @i{MODULE}.uninstall -Uninstall module products; generally the reverse of install. -This usually invokes autotool uninstall. - -@item make @i{MODULE}.clean -Clean module; generally the reverse of build. -This usually invokes autotool clean. - -@item make @i{MODULE}.xclean -Extra clean module; first invokes uninstall then recursively removes the module build directory. -@end table - -@anchor{terminal.targets.contrib.touch} -@subsection Contrib Touch and Untouch -Also available are some very granular targets which help force builds 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: - -@itemize -@item make @i{MODULE}.extract.touch -@item make @i{MODULE}.extract.untouch -@item make @i{MODULE}.patch.touch -@item make @i{MODULE}.patch.untouch -@item make @i{MODULE}.configure.touch -@item make @i{MODULE}.configure.untouch -@item make @i{MODULE}.build.touch -@item make @i{MODULE}.build.untouch -@item make @i{MODULE}.install.touch -@item make @i{MODULE}.install.untouch -@end itemize - -@anchor{terminal.targets.contrib.aggregate} -@subsection Contrib Aggregates -For convenience, the following targets aggregate the all contrib modules' respective targets together: - -@itemize -@item make contrib.fetch -@item make contrib.extract -@item make contrib.patch -@item make contrib.configure -@item make contrib.build -@item make contrib.install -@item make contrib.uninstall -@item make contrib.clean -@item make contrib.xclean -@end itemize - -@c %**------------------------------------------------------------------------- -@anchor{terminal.customizing} -@section 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; @b{Do not check these files into the repository}: - -@table @file -@item _SRC_/custom.defs -Custom makevar definitions @i{outside} @file{build}. Suitable for settings which apply across all builds for a particular checkout; or which survives manual removal of @file{build}. - -@item _SRC_/custom.rules -Custom make rules @i{outside} @file{build}. Suitable for rules which apply across all builds for a particular checkout; or which survives manual removal of @file{build}. - -@item _BUILD_/GNUmakefile.custom.defs -Custom makevar definitions specific to a @file{build} directory. - -@item _BUILD_/GNUmakefile.custom.rules -Custom makevar rules specific to a @file{build} directory. - -@end table - -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 @command{configure} is invoked; ie: @command{configure} would overwrite @file{GNUmakefile} and any customizations contained therein would be lost. Here is a short example of what the contents of @file{_SRC_/custom.defs} might contain: - -@example -## bump to gcc-4.6 in current path -GCC.gcc = /usr/bin/gcc-4.6 - -## replace optimize for 'speed' with more aggressive settings -GCC.args.O.speed = -O3 -fomit-frame-pointer -msse4.2 -@end example - -See also @command{make report.help} which displays a set of reports used to dump makefile vars. diff --git a/doc/texi/building/chapter.via.xcode.texi b/doc/texi/building/chapter.via.xcode.texi deleted file mode 100644 index 453a0e3c0..000000000 --- a/doc/texi/building/chapter.via.xcode.texi +++ /dev/null @@ -1,128 +0,0 @@ -@anchor{xcode} -@chapter Building via Xcode.app - -@c %**------------------------------------------------------------------------- -@anchor{xcode.checkout} -@section Checkout Sources -@include building/method.checkout.texi - -@c %**------------------------------------------------------------------------- -@anchor{xcode.build} -@section Build -Perform the following steps to build: - -@itemize -@item Finder - navigate to @file{macosx/} in the @value{HB-name} source tree -@item Finder - open @file{HandBrake.xcodeproj} -@item Xcode workspace - select scheme @b{HandBrake [RELEASE]} -@item Xcode menu - select Product -> Build -@item Xcode workspace - Show the Log navigator -@item Xcode workspace Log navigator - select top Build item -@end itemize - -@c %**------------------------------------------------------------------------- -@anchor{xcode.note.products} -@section 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: - -@itemize -@item Xcode menu - select Window -> Organizer -@item Xcode organizer - select Projects tab -@item Xcode organizer Projects - select @value{HB-name} item -@item @value{HB-name} item - click Derived Data location arrow (immediately right of path) -@item Finder - navigate to Build -> Products -> release -@end itemize - -@quotation 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 reselecting Projects tab. -@end quotation - -@c %**------------------------------------------------------------------------- -@anchor{xcode.note.behaviors} -@section 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 show current log: - -@itemize -@item Xcode menu - select Behaviors -> Edit Behaviors -@item Xcode behaviors - select Build starts -@item navigator - enable, select Show, select Log Navigator -@item nagivate to - select current log -@end itemize - -@quotation Note -The Log navigator supports some possibly confusing options. It is recommended to only show results for the last build by selecting @b{Recent}. If @b{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 brought forward from history. -@end quotation - -@quotation 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 workspace status indicator for @b{Build Succeeded}. -@end quotation - -@c %**------------------------------------------------------------------------- -@anchor{xcode.note.external} -@section 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 @b{terminal} to accomplish those tasks after launching the build at least once or doing a clean from within Xcode. @b{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 allows the external build system configuration to accurately reflect Xcode project changes. - -The following are some examples of using @command{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 @b{release}: - -@itemize -@item Xcode menu - select Window -> Organizer -@item Xcode organizer - select Projects tab -@item Xcode organizer Projects - select @value{HB-name} item -@item @value{HB-name} item - click Derived Data location arrow (immediately right of path) -@item Finder - navigate to Build -> Products -> release -> external -@end itemize - -Example; external build failed but error is buried in a parallelized log; redo build sequentially: - -@example -make xclean -make BUILD.jobs=1 -@end example - -Example; build external x264 module: - -@example -make x264.clean -make x264 -@end example - -Example; extract, configure, build and install external x264 module: - -@example -make x264.xclean -make x264.install -@end example - -Example; something in a big module is failing; redo build sequentially: - -@example -make ffmpeg.clean -make BUILD.jobs=1 ffmpeg -@end example - -@c %**------------------------------------------------------------------------- -@anchor{xcode.userdefined} -@section User-Defined Settings -The following user defined settings are visible in Xcode project and are used -for the external build system. - -@table @samp -@item EXTERNAL_BUILD -Do not modify; used to specify the build (scratch) directory. - -@item EXTERNAL_DRIVER -Do not modify; used for internal/external build coordination and must always be @samp{xcode}. - -@item 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 @b{auto} sets the factor to the number of active CPUs on the host system. - -@item EXTERNAL_SRC -Do not modify; specifies the top-level source directory for @value{HB-name}, relative to Xcode project. - -@item EXTERNAL_XCCONFIG -Do not modify; specifies which xcconfig file is active. Defined inside xcconfig file. - -@end table diff --git a/doc/texi/building/command.texi b/doc/texi/building/command.texi deleted file mode 100644 index cd97764c0..000000000 --- a/doc/texi/building/command.texi +++ /dev/null @@ -1,4 +0,0 @@ -@macro COMMAND-checkout{} -git clone @value{HB-repo-url} @value{HB-acro-lower}-@value{HB-repo-branch} -cd @value{HB-acro-lower}-@value{HB-repo-branch} -@end macro diff --git a/doc/texi/building/method.checkout.texi b/doc/texi/building/method.checkout.texi deleted file mode 100644 index 7e3423273..000000000 --- a/doc/texi/building/method.checkout.texi +++ /dev/null @@ -1,9 +0,0 @@ -Checkout @value{HB-name} from the official source-code repository. - -@example -@COMMAND-checkout{} -@end example - -Sources are checked out from the @samp{@value{HB-repo-branch}} 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. diff --git a/doc/texi/building/prerequisites.bundled.texi b/doc/texi/building/prerequisites.bundled.texi deleted file mode 100644 index b9f5b7590..000000000 --- a/doc/texi/building/prerequisites.bundled.texi +++ /dev/null @@ -1,3 +0,0 @@ -@quotation 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. -@end quotation diff --git a/doc/texi/building/prerequisites.common.texi b/doc/texi/building/prerequisites.common.texi deleted file mode 100644 index 5cf576571..000000000 --- a/doc/texi/building/prerequisites.common.texi +++ /dev/null @@ -1,10 +0,0 @@ -The following general tools are used on various platforms and it is recommended you use these versions or similar: - -@itemize @bullet -@item git - 2.4.3 -@item python - Python 2.7.1 -@item m4 - GNU M4 1.4.17 -@item make - GNU Make 3.81 -@item patch - Patch 2.5.8 -@item tar - GNU tar 1.26 -@end itemize diff --git a/make/include/main.defs b/make/include/main.defs index e7f3a0980..9335bb19f 100644 --- a/make/include/main.defs +++ b/make/include/main.defs @@ -150,7 +150,6 @@ endif ############################################################################### -MODULES += doc MODULES += pkg ############################################################################### |