summaryrefslogtreecommitdiffstats
path: root/Help/variable
diff options
context:
space:
mode:
authorBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-04-01 13:14:27 (GMT)
committerBartosz Kosiorek <bartosz.kosiorek@tomtom.com>2019-04-04 13:13:58 (GMT)
commit456e0fb64f5c70191145c34104d6f25bd24b7b37 (patch)
treef728b6b9ea236c5d0bb84ba91a9e5dd7a04471bc /Help/variable
parent5ad73b608d4fc7cc6b30017159b800802a503b0c (diff)
downloadCMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.zip
CMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.tar.gz
CMake-456e0fb64f5c70191145c34104d6f25bd24b7b37.tar.bz2
Help: Improve documentation formating
Diffstat (limited to 'Help/variable')
-rw-r--r--Help/variable/CMAKE_CROSSCOMPILING.rst5
-rw-r--r--Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst2
-rw-r--r--Help/variable/XCODE_VERSION.rst4
3 files changed, 6 insertions, 5 deletions
diff --git a/Help/variable/CMAKE_CROSSCOMPILING.rst b/Help/variable/CMAKE_CROSSCOMPILING.rst
index 9e96769..7e6ec33 100644
--- a/Help/variable/CMAKE_CROSSCOMPILING.rst
+++ b/Help/variable/CMAKE_CROSSCOMPILING.rst
@@ -19,8 +19,9 @@ macOS are handled differently to other cross compiling scenarios. Rather than
relying on :variable:`CMAKE_SYSTEM_NAME` to select the target platform, Apple
device builds use :variable:`CMAKE_OSX_SYSROOT` to select the appropriate SDK,
which indirectly determines the target platform. Furthermore, when using the
-Xcode generator, developers can switch between device and simulator builds at
-build time rather than having a single choice at configure time, so the concept
+:generator:`Xcode` generator, developers can switch between device and
+simulator builds at build time rather than having a single
+choice at configure time, so the concept
of whether the build is cross compiling or not is more complex. Therefore, the
use of ``CMAKE_CROSSCOMPILING`` is not recommended for projects targeting Apple
devices.
diff --git a/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst b/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst
index 1fb84d7..5b1a003 100644
--- a/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst
+++ b/Help/variable/CMAKE_XCODE_GENERATE_SCHEME.rst
@@ -1,7 +1,7 @@
CMAKE_XCODE_GENERATE_SCHEME
---------------------------
-If enabled, the Xcode generator will generate schema files. These
+If enabled, the :generator:`Xcode` generator will generate schema files. These
are useful to invoke analyze, archive, build-for-testing and test
actions from the command line.
diff --git a/Help/variable/XCODE_VERSION.rst b/Help/variable/XCODE_VERSION.rst
index b85d41e..9caf19a 100644
--- a/Help/variable/XCODE_VERSION.rst
+++ b/Help/variable/XCODE_VERSION.rst
@@ -3,5 +3,5 @@ XCODE_VERSION
Version of Xcode (:generator:`Xcode` generator only).
-Under the Xcode generator, this is the version of Xcode as specified
-in ``Xcode.app/Contents/version.plist`` (such as ``3.1.2``).
+Under the :generator:`Xcode` generator, this is the version of Xcode
+as specified in ``Xcode.app/Contents/version.plist`` (such as ``3.1.2``).