summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_CFG_INTDIR.rst
diff options
context:
space:
mode:
authorJames Johnston <johnstonj.public@codenest.com>2015-08-18 05:34:01 (GMT)
committerBrad King <brad.king@kitware.com>2015-08-21 13:32:08 (GMT)
commit3bb707f0a1408dc0381ecbf4ec934e9f14d8927c (patch)
tree1e6c4f6a4ad78a3d1635070207aa281bbd0e9493 /Help/variable/CMAKE_CFG_INTDIR.rst
parent404d16e7bc1b18027f719cd8642d0a90c679c396 (diff)
downloadCMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.zip
CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.gz
CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.bz2
Help: Improve formatting of variable documentation
Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
Diffstat (limited to 'Help/variable/CMAKE_CFG_INTDIR.rst')
-rw-r--r--Help/variable/CMAKE_CFG_INTDIR.rst21
1 files changed, 11 insertions, 10 deletions
diff --git a/Help/variable/CMAKE_CFG_INTDIR.rst b/Help/variable/CMAKE_CFG_INTDIR.rst
index 55f7b01..dcc1aed 100644
--- a/Help/variable/CMAKE_CFG_INTDIR.rst
+++ b/Help/variable/CMAKE_CFG_INTDIR.rst
@@ -4,11 +4,11 @@ CMAKE_CFG_INTDIR
Build-time reference to per-configuration output subdirectory.
For native build systems supporting multiple configurations in the
-build tree (such as Visual Studio and Xcode), the value is a reference
-to a build-time variable specifying the name of the per-configuration
-output subdirectory. On Makefile generators this evaluates to "."
-because there is only one configuration in a build tree. Example
-values:
+build tree (such as :ref:`Visual Studio Generators` and :generator:`Xcode`),
+the value is a reference to a build-time variable specifying the name
+of the per-configuration output subdirectory. On :ref:`Makefile Generators`
+this evaluates to `.` because there is only one configuration in a build tree.
+Example values:
::
@@ -33,13 +33,14 @@ evaluated at build time. Example of intended usage:
)
add_custom_target(drive ALL DEPENDS out.txt)
-Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but
+Note that ``CMAKE_CFG_INTDIR`` is no longer necessary for this purpose but
has been left for compatibility with existing projects. Instead
-add_custom_command() recognizes executable target names in its COMMAND
-option, so "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool"
-can be replaced by just "mytool".
+:command:`add_custom_command` recognizes executable target names in its
+``COMMAND`` option, so
+``${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool`` can be replaced
+by just ``mytool``.
This variable is read-only. Setting it is undefined behavior. In
multi-configuration build systems the value of this variable is passed
-as the value of preprocessor symbol "CMAKE_INTDIR" to the compilation
+as the value of preprocessor symbol ``CMAKE_INTDIR`` to the compilation
of all source files.