doc/texi/building/chapter.via.xcode.texi

   1 @anchor{xcode}
   2 @chapter Building via Xcode
   3
   4 @c %**-------------------------------------------------------------------------
   5 @anchor{xcode.checkout}
   6 @section Checkout Sources
   7 @include building/method.checkout.texi
   8
   9 @c %**-------------------------------------------------------------------------
  10 @anchor{xcode.build}
  11 @section Build
  12 In Xcode perform the following steps to build the default configuration:
  13
  14 @itemize
  15 @item open @file{macosx/HandBrake.xcodeproj}
  16 @item select active configuration @b{standard}
  17 @item select active target @b{HandBrake}
  18 @item click @b{Build} or @b{Build and Go}
  19 @end itemize
  20
  21 The first build (on an empty @file{build} directory) will take a bit of time. You may use the Build Results window to observe progress. The most time-consuming part of the build is when the external build system (essentially the @b{terminal} method) is triggered by Xcode and a substantial amount of log transcript ensues. Much of that transcript are warnings and errors that are part of the normal build process for 3rd-party contributed modules so in general you need not do anything. However, if Xcode itself reports the build failed, then you must take corrective action.
  22
  23 Unfortunately, due to limitations of Xcode we do not have hooks in place to offer finer-grained control over per-module make actions for the (external) build system. Thus, you will have to use @b{terminal} to accomplish those tasks. Just @command{cd} into the build directory which is associated with your active configuration and perform any necessary @command{make} commands. @b{Be careful not to issue commands from the terminal simultaneously with Xcode tasks} as that will confuse both Xcode and make and likely corrupt your build directory.
  24
  25 When you click @b{clean} in Xcode it will not perform an external build clean. Basically @b{HandBrakeCLI} and @b{HandBrake.app} are the only products which have full Xcode iterative development flexibility.
  26
  27 Each configuration uses a different @file{build} directory. This makes it possible to build each configuration and switch between them without losing their respective build state. The description of each configuration and the name convention for build directories are as follows:
  28
  29 @table @samp
  30 @item standard
  31 This configuration will build to the host native architecture. Build directory is @file{build.standard} .
  32 The standard variant produces optimized code without debug information.
  33
  34 @item debug
  35 This configuration will build to the host native architecture. Build directory is @file{build.standard} .
  36 The debug variant produces unoptimized code with debug information.
  37
  38 @item standard.i386
  39 This configuration is used to build for the i386 architecture. Build directory is @file{build.standard.i386} .
  40
  41 @item standard.x86_64
  42 This configuration is used to build for the x86_64 architecture. Build directory is @file{build.standard.x86_64} .
  43
  44 @item standard.ppc
  45 This configuration is used to build for the ppc architecture. Build directory is @file{build.standard.ppc} .
  46
  47 @item standard.ppc64
  48 This configuration is used to build for the ppc64 architecture. Build directory is @file{build.standard.ppc64} .
  49 @end table
  50
  51 @c %**-------------------------------------------------------------------------
  52 @anchor{xcode.extenal}
  53 @section External Targets
  54 The following external targets appear in the Xcode project and perform @b{build} and @b{clean} actions.
  55
  56 @table @samp
  57 @item external
  58 Target maps to @command{make build} and @command{make clean} for everything Xcode products depend upon from the external build system.
  59
  60 @item libhb
  61 Target maps to @command{make libhb.build} and @command{make libhb.clean}.
  62
  63 @item contrib
  64 Target maps to @command{make contrib.build} and @command{make contrib.xclean}.
  65
  66 @end table
  67
  68 @c %**-------------------------------------------------------------------------
  69 @anchor{xcode.userdefined}
  70 @section User-Defined Settings
  71 The following user defined settings are used in Xcode project for the external build system:
  72
  73 @table @samp
  74 @item EXTERNAL_BUILD
  75 Specifies the build (scratch) directory for each configuration.
  76
  77 @item EXTERNAL_JOBS
  78 Specifies the concurrency factor for the external build system when builds are launched from within Xcode.
  79 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.
  80
  81 @item EXTERNAL_METHOD
  82 Do not modify; Used for internal/external build coordination and must always be @samp{xcode}.
  83
  84 @item EXTERNAL_SRC
  85 Specifies the top-level source directory for @value{HB.name}.
  86
  87 @end table