Browse Source

Add documentation for the OS X and iOS deployment target build options.

Yao Wei Tjong 姚伟忠 11 years ago
parent
commit
47fb292a3a
2 changed files with 6 additions and 0 deletions
  1. 2 0
      Docs/GettingStarted.dox
  2. 4 0
      Readme.txt

+ 2 - 0
Docs/GettingStarted.dox

@@ -171,6 +171,8 @@ A number of build options can be defined explicitly when invoking the above cmak
 |URHO3D_LIB_TYPE      |*|Specify Urho3D library type, possible values are STATIC (\*default) and SHARED|
 |URHO3D_LIB_TYPE      |*|Specify Urho3D library type, possible values are STATIC (\*default) and SHARED|
 |URHO3D_SCP_TO_TARGET |-|Use scp to transfer executables to target system (non-Android cross-compiling build only), SSH digital key must be setup first for this to work, typical value has a pattern of usr@tgt:remote-loc|
 |URHO3D_SCP_TO_TARGET |-|Use scp to transfer executables to target system (non-Android cross-compiling build only), SSH digital key must be setup first for this to work, typical value has a pattern of usr@tgt:remote-loc|
 |CMAKE_BUILD_TYPE     |*|Specify CMake build configuration to be generated (Makefile generator only), possible values are Release (\*default), Debug, and RelWithDebInfo|
 |CMAKE_BUILD_TYPE     |*|Specify CMake build configuration to be generated (Makefile generator only), possible values are Release (\*default), Debug, and RelWithDebInfo|
+|CMAKE_OSX_DEPLOYMENT_TARGET|-|Specify Mac OS X deployment target (OSX build only); default to current running OS X if not specified|
+|IPHONEOS_DEPLOYMENT_TARGET|-|Specify iPhone OS deployment target (iOS build only); default to latest installed iOS SDK if not specified|
 |ANDROID_ABI          |*|Specify target ABI (Android build only), possible values are armeabi-v7a (\*default) and armeabi|
 |ANDROID_ABI          |*|Specify target ABI (Android build only), possible values are armeabi-v7a (\*default) and armeabi|
 
 
 Note that build option values specified via command line are cached by CMake. The cached values will be used by CMake in the subsequent invocation. That is, the same build options are not required to be specified again and again. Once a non-default build option value is being cached, it can only be reverted back to its default value by explicitly setting it via command line. That is, simply by NOT passing the corresponding build option would not work. One way to revert all the build options to their default values is by clearing the CMake cache by calling cmake_clean.bat or cmake_clean.sh.
 Note that build option values specified via command line are cached by CMake. The cached values will be used by CMake in the subsequent invocation. That is, the same build options are not required to be specified again and again. Once a non-default build option value is being cached, it can only be reverted back to its default value by explicitly setting it via command line. That is, simply by NOT passing the corresponding build option would not work. One way to revert all the build options to their default values is by clearing the CMake cache by calling cmake_clean.bat or cmake_clean.sh.

+ 4 - 0
Readme.txt

@@ -478,6 +478,10 @@ cmake_xxxx batch files or shell scripts.
 |CMAKE_BUILD_TYPE     |*|Specify CMake build configuration to be generated     |
 |CMAKE_BUILD_TYPE     |*|Specify CMake build configuration to be generated     |
 |                     | | (Makefile generator only), possible values are       |
 |                     | | (Makefile generator only), possible values are       |
 |                     | | Release (*default), Debug, and RelWithDebInfo        |
 |                     | | Release (*default), Debug, and RelWithDebInfo        |
+|CMAKE_OSX_           |-|Specify Mac OS X deployment target (OSX build only);  |
+| DEPLOYMENT_TARGET   | | default to current running OS X if not specified     |
+|IPHONEOS_            |-|Specify iPhone OS deployment target (iOS build only); |
+| DEPLOYMENT_TARGET   | | default to latest installed iOS SDK if not specified |
 |ANDROID_ABI          |*|Specify target ABI (Android build only), possible     |
 |ANDROID_ABI          |*|Specify target ABI (Android build only), possible     |
 |                     | | values are armeabi-v7a (*default) and armeabi        |
 |                     | | values are armeabi-v7a (*default) and armeabi        |
 |---------------------|-|------------------------------------------------------|
 |---------------------|-|------------------------------------------------------|