diff options
author | jstebbins <[email protected]> | 2014-01-25 22:14:10 +0000 |
---|---|---|
committer | jstebbins <[email protected]> | 2014-01-25 22:14:10 +0000 |
commit | 3db701933facbed318f5edb6589903caa5f78c64 (patch) | |
tree | 4151c917dede2149d809f14fecc89c6dd3fc82fe /doc/texi/building | |
parent | c70a9eb8cd000862c0f31db19e800a312b2b296e (diff) |
documentation: fix compatibility with makeinfo 5.1
Variables can no longer have '.' or '_'.
This syntax is no longer valid "@value{@value{variable}}
git-svn-id: svn://svn.handbrake.fr/HandBrake/trunk@5992 b64f7644-9d1e-0410-96f1-a4d463321fa5
Diffstat (limited to 'doc/texi/building')
-rw-r--r-- | doc/texi/building/appendix.repo.texi | 14 | ||||
-rw-r--r-- | doc/texi/building/chapter.introduction.texi | 2 | ||||
-rw-r--r-- | doc/texi/building/chapter.quickstart.texi | 4 | ||||
-rw-r--r-- | doc/texi/building/chapter.troubleshooting.texi | 2 | ||||
-rw-r--r-- | doc/texi/building/chapter.via.terminal.texi | 10 | ||||
-rw-r--r-- | doc/texi/building/chapter.via.xcode.texi | 12 | ||||
-rw-r--r-- | doc/texi/building/command.texi | 6 | ||||
-rw-r--r-- | doc/texi/building/method.checkout.texi | 6 |
8 files changed, 28 insertions, 28 deletions
diff --git a/doc/texi/building/appendix.repo.texi b/doc/texi/building/appendix.repo.texi index 8d4ee0cc2..ea7bf2d8a 100644 --- a/doc/texi/building/appendix.repo.texi +++ b/doc/texi/building/appendix.repo.texi @@ -1,10 +1,10 @@ @appendix Project Repository Details @example -url: @value{HB.repo.url} -root: @value{HB.repo.root} -branch: @value{HB.repo.branch} -uuid: @value{HB.repo.uuid} -rev: @value{HB.repo.rev} -date: @value{HB.repo.date} -type: @value{HB.repo.type} +url: @value{HB-repo-url} +root: @value{HB-repo-root} +branch: @value{HB-repo-branch} +uuid: @value{HB-repo-uuid} +rev: @value{HB-repo-rev} +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 index 9c6053349..60cd82379 100644 --- a/doc/texi/building/chapter.introduction.texi +++ b/doc/texi/building/chapter.introduction.texi @@ -1,3 +1,3 @@ @anchor{introduction} @chapter Introduction -This guide documents the recommended process to build @value{HB.name} on @value{OS.@value{BG.platform}} hosts from the official source-code repository. @b{Building from any other source is not supported}. +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 index 6aee76b91..56b18b3c1 100644 --- a/doc/texi/building/chapter.quickstart.texi +++ b/doc/texi/building/chapter.quickstart.texi @@ -1,9 +1,9 @@ @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. +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 diff --git a/doc/texi/building/chapter.troubleshooting.texi b/doc/texi/building/chapter.troubleshooting.texi index 4d42e76a3..7796317b7 100644 --- a/doc/texi/building/chapter.troubleshooting.texi +++ b/doc/texi/building/chapter.troubleshooting.texi @@ -16,5 +16,5 @@ Record of verbose output from @b{configure}. 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. +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 index bdd665e23..a3a6929cc 100644 --- a/doc/texi/building/chapter.via.terminal.texi +++ b/doc/texi/building/chapter.via.terminal.texi @@ -24,7 +24,7 @@ The @command{configure} utility accepts many options. It is recommended that you List available options. @item --src=DIR -Specify top-level source directory for @value{HB.name} sources. +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{.} @@ -38,7 +38,7 @@ 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}. +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}. @@ -49,13 +49,13 @@ 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. +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. +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. +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: diff --git a/doc/texi/building/chapter.via.xcode.texi b/doc/texi/building/chapter.via.xcode.texi index 263390851..453a0e3c0 100644 --- a/doc/texi/building/chapter.via.xcode.texi +++ b/doc/texi/building/chapter.via.xcode.texi @@ -12,7 +12,7 @@ Perform the following steps to build: @itemize -@item Finder - navigate to @file{macosx/} in the @value{HB.name} source tree +@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 @@ -28,8 +28,8 @@ Under default Xcode.app options the products from a build are managed by the Xco @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 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 @@ -69,8 +69,8 @@ The following are some examples of using @command{make} from the terminal to eff @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 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 @@ -120,7 +120,7 @@ Specifies the concurrency factor for the external build system when builds are l 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. +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. diff --git a/doc/texi/building/command.texi b/doc/texi/building/command.texi index 3acddc3a0..fedb58188 100644 --- a/doc/texi/building/command.texi +++ b/doc/texi/building/command.texi @@ -1,4 +1,4 @@ -@macro COMMAND.checkout{} -svn checkout @value{HB.repo.url} @value{HB.acro.lower}-@value{HB.repo.branch} -cd @value{HB.acro.lower}-@value{HB.repo.branch} +@macro COMMAND-checkout{} +svn checkout @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 index 32f668635..007ae8a25 100644 --- a/doc/texi/building/method.checkout.texi +++ b/doc/texi/building/method.checkout.texi @@ -1,9 +1,9 @@ -Checkout @value{HB.name} from the official source-code repository. +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. +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. It is recommended to use Subversion 1.6.0 or higher. Lower versions should also work. |