LinGui: make Help->Guide work on windows/mingw

[handbrake-jp/handbrake-jp-git.git] / doc / texi / building / chapter.via.xcode.texi

diff --git a/doc/texi/building/chapter.via.xcode.texi b/doc/texi/building/chapter.via.xcode.texi
index 9983c94..2b79a7b 100644 (file)
--- a/doc/texi/building/chapter.via.xcode.texi
+++ b/doc/texi/building/chapter.via.xcode.texi
@@ -1,5 +1,5 @@
 @anchor{xcode}
-@chapter Building via Xcode
+@chapter Building via Xcode.app
 
 @c %**-------------------------------------------------------------------------
 @anchor{xcode.checkout}
@@ -9,10 +9,15 @@
 @c %**-------------------------------------------------------------------------
 @anchor{xcode.build}
 @section Build
-In Xcode perform the following steps to build the default configuration:
+Open Xcode.app from a terminal by using the @command{open} command which passes your shell environment and its @samp{PATH} setting to Xcode. Do not attempt to launch Xcode.app from Finder or by using Finder to open @file{HandBrake.xcodeproj} -- doing so will defeat any custom path settings which contain required tools.
+
+@example
+open @file{macosx/HandBrake.xcodeproj}
+@end example
+
+Once the HandBrake Xcode project is open, perform the following steps to build the default configuration:
 
 @itemize
-@item open @file{macosx/HandBrake.xcodeproj}
 @item select active configuration @b{standard}
 @item select active target @b{HandBrake}
 @item click @b{Build} or @b{Build and Go}
@@ -28,24 +33,57 @@ Each configuration uses a different @file{build} directory. This makes it possib
 
 @table @samp
 @item standard
-This configuration will build to the host native architecture. Build directory is @file{build.standard} .
+This configuration will build @b{host native} architecture. Build directory is @file{build.standard} .
 The standard variant produces optimized code without debug information.
 
-@item debug
-This configuration will build to the host native architecture. Build directory is @file{build.standard} .
-The debug variant produces unoptimized code with debug information.
-
 @item standard.i386
-This configuration is used to build for the i386 architecture. Build directory is @file{build.standard.i386} .
+This configuration will build @b{i386} architecture. Build directory is @file{build.standard.i386} .
 
 @item standard.x86_64
-This configuration is used to build for the x86_64 architecture. Build directory is @file{build.standard.x86_64} .
+This configuration will build @b{x86_64} architecture. Build directory is @file{build.standard.x86_64} .
 
 @item standard.ppc
-This configuration is used to build for the ppc architecture. Build directory is @file{build.standard.ppc} .
+This configuration will build @b{ppc} architecture. Build directory is @file{build.standard.ppc} .
 
 @item standard.ppc64
-This configuration is used to build for the ppc64 architecture. Build directory is @file{build.standard.ppc64} .
+This configuration will build @b{ppc64} architecture. Build directory is @file{build.standard.ppc64} .
+
+@item debug
+This configuration will build @b{host native architecture}. Build directory is @file{build.debug} .
+The debug variant produces unoptimized code with debug information.
+
+@item debug.i386
+This configuration will build @b{i386} architecture. Build directory is @file{build.debug.i386} .
+The debug variant produces unoptimized code with debug information.
+
+@item debug.x86_64
+This configuration will build @b{x86_64} architecture. Build directory is @file{build.debug.x86_64} .
+The debug variant produces unoptimized code with debug information.
+
+@item debug.ppc
+This configuration will build @b{ppc} architecture. Build directory is @file{build.debug.ppc} .
+The debug variant produces unoptimized code with debug information.
+
+@item debug.ppc64
+This configuration will build @b{ppc64} architecture. Build directory is @file{build.debug.ppc64} .
+The debug variant produces unoptimized code with debug information.
+@end table
+
+@c %**-------------------------------------------------------------------------
+@anchor{xcode.extenal}
+@section External Targets
+The following external targets appear in the Xcode project and perform @b{build} and @b{clean} actions.
+
+@table @samp
+@item external
+Target maps to @command{make build} and @command{make clean} for everything Xcode products depend upon from the external build system.
+
+@item libhb
+Target maps to @command{make libhb.build} and @command{make libhb.clean}.
+
+@item contrib
+Target maps to @command{make contrib.build} and @command{make contrib.xclean}.
+
 @end table
 
 @c %**-------------------------------------------------------------------------
@@ -55,17 +93,16 @@ The following user defined settings are used in Xcode project for the external b
 
 @table @samp
 @item EXTERNAL_BUILD
-Specifies the build location for each configuration.
-It is highly recommended the locations always evaluate to a unique pathname when factoring the configuration name.
+Specifies the build (scratch) directory for each configuration.
 
 @item EXTERNAL_JOBS
 Specifies the concurrency factor for the external build system when builds are launched from within Xcode.
-This variable is meant to be customized by the developer for faster builds if the host supports it.
+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.
 
 @item EXTERNAL_METHOD
-This variable is used for internal/external build coordination and must always be @samp{xcode}.
+Do not modify; Used for internal/external build coordination and must always be @samp{xcode}.
 
-@item EXTERNAL_PROJECT
-Specifies the directory which is top of @value{HB.name} source tree.
+@item EXTERNAL_SRC
+Specifies the top-level source directory for @value{HB.name}.
 
 @end table