diff options
author | Brad King <brad.king@kitware.com> | 2013-09-27 20:58:09 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 13:22:38 (GMT) |
commit | 30b21860adaefa7493262c41f0b95b4065d46aa3 (patch) | |
tree | f41eb31021c165baada9b0f45c4862ba3ffa8ea9 | |
parent | bfe07aa97efdd0c9a5fb9eb7adc0a1a166149711 (diff) | |
download | CMake-30b21860adaefa7493262c41f0b95b4065d46aa3.zip CMake-30b21860adaefa7493262c41f0b95b4065d46aa3.tar.gz CMake-30b21860adaefa7493262c41f0b95b4065d46aa3.tar.bz2 |
Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
Portions of these documents contain duplicate content generated from
preprocessor macros in the original builtin documentation source.
Factor the common parts out into .txt files using reStructuredText
include directives and substitutions to avoid duplication.
-rw-r--r-- | Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst | 19 | ||||
-rw-r--r-- | Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst | 15 | ||||
-rw-r--r-- | Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst | 19 | ||||
-rw-r--r-- | Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst | 15 | ||||
-rw-r--r-- | Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst | 19 | ||||
-rw-r--r-- | Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst | 15 | ||||
-rw-r--r-- | Help/prop_tgt/TARGET_FILE_TYPES.txt | 9 | ||||
-rw-r--r-- | Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt | 10 | ||||
-rw-r--r-- | Help/prop_tgt/XXX_OUTPUT_NAME.txt | 6 |
9 files changed, 46 insertions, 81 deletions
diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst index f8efefb..df57dba 100644 --- a/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_DIRECTORY.rst @@ -1,18 +1,7 @@ ARCHIVE_OUTPUT_DIRECTORY ------------------------ -Output directory in which to build ARCHIVE target files. - -This property specifies the directory into which archive target files -should be built. Multi-configuration generators (VS, Xcode) append a -per-configuration subdirectory to the specified directory. There are -three kinds of target files that may be built: archive, library, and -runtime. Executables are always treated as runtime targets. Static -libraries are always treated as archive targets. Module libraries are -always treated as library targets. For non-DLL platforms shared -libraries are treated as library targets. For DLL platforms the DLL -part of a shared library is treated as a runtime target and the -corresponding import library is treated as an archive target. All -Windows-based systems including Cygwin are DLL platforms. This -property is initialized by the value of the variable -CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created. +.. |XXX| replace:: ARCHIVE +.. |xxx| replace:: archive +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_ARCHIVE_OUTPUT_DIRECTORY +.. include:: XXX_OUTPUT_DIRECTORY.txt diff --git a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst index 4784aff..a137bb8 100644 --- a/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst +++ b/Help/prop_tgt/ARCHIVE_OUTPUT_NAME.rst @@ -1,15 +1,6 @@ ARCHIVE_OUTPUT_NAME ------------------- -Output name for ARCHIVE target files. - -This property specifies the base name for archive target files. It -overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are -three kinds of target files that may be built: archive, library, and -runtime. Executables are always treated as runtime targets. Static -libraries are always treated as archive targets. Module libraries are -always treated as library targets. For non-DLL platforms shared -libraries are treated as library targets. For DLL platforms the DLL -part of a shared library is treated as a runtime target and the -corresponding import library is treated as an archive target. All -Windows-based systems including Cygwin are DLL platforms. +.. |XXX| replace:: ARCHIVE +.. |xxx| replace:: archive +.. include:: XXX_OUTPUT_NAME.txt diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst index a0ba619..e1d3a82 100644 --- a/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/LIBRARY_OUTPUT_DIRECTORY.rst @@ -1,18 +1,7 @@ LIBRARY_OUTPUT_DIRECTORY ------------------------ -Output directory in which to build LIBRARY target files. - -This property specifies the directory into which library target files -should be built. Multi-configuration generators (VS, Xcode) append a -per-configuration subdirectory to the specified directory. There are -three kinds of target files that may be built: archive, library, and -runtime. Executables are always treated as runtime targets. Static -libraries are always treated as archive targets. Module libraries are -always treated as library targets. For non-DLL platforms shared -libraries are treated as library targets. For DLL platforms the DLL -part of a shared library is treated as a runtime target and the -corresponding import library is treated as an archive target. All -Windows-based systems including Cygwin are DLL platforms. This -property is initialized by the value of the variable -CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created. +.. |XXX| replace:: LIBRARY +.. |xxx| replace:: library +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_LIBRARY_OUTPUT_DIRECTORY +.. include:: XXX_OUTPUT_DIRECTORY.txt diff --git a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst index 1330e0d..9e9d401 100644 --- a/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst +++ b/Help/prop_tgt/LIBRARY_OUTPUT_NAME.rst @@ -1,15 +1,6 @@ LIBRARY_OUTPUT_NAME ------------------- -Output name for LIBRARY target files. - -This property specifies the base name for library target files. It -overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are -three kinds of target files that may be built: archive, library, and -runtime. Executables are always treated as runtime targets. Static -libraries are always treated as archive targets. Module libraries are -always treated as library targets. For non-DLL platforms shared -libraries are treated as library targets. For DLL platforms the DLL -part of a shared library is treated as a runtime target and the -corresponding import library is treated as an archive target. All -Windows-based systems including Cygwin are DLL platforms. +.. |XXX| replace:: LIBRARY +.. |xxx| replace:: library +.. include:: XXX_OUTPUT_NAME.txt diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst index 2aff5eb..af5ef44 100644 --- a/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/RUNTIME_OUTPUT_DIRECTORY.rst @@ -1,18 +1,7 @@ RUNTIME_OUTPUT_DIRECTORY ------------------------ -Output directory in which to build RUNTIME target files. - -This property specifies the directory into which runtime target files -should be built. Multi-configuration generators (VS, Xcode) append a -per-configuration subdirectory to the specified directory. There are -three kinds of target files that may be built: archive, library, and -runtime. Executables are always treated as runtime targets. Static -libraries are always treated as archive targets. Module libraries are -always treated as library targets. For non-DLL platforms shared -libraries are treated as library targets. For DLL platforms the DLL -part of a shared library is treated as a runtime target and the -corresponding import library is treated as an archive target. All -Windows-based systems including Cygwin are DLL platforms. This -property is initialized by the value of the variable -CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created. +.. |XXX| replace:: RUNTIME +.. |xxx| replace:: runtime +.. |CMAKE_XXX_OUTPUT_DIRECTORY| replace:: CMAKE_RUNTIME_OUTPUT_DIRECTORY +.. include:: XXX_OUTPUT_DIRECTORY.txt diff --git a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst index b62d887..dc7dba4 100644 --- a/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst +++ b/Help/prop_tgt/RUNTIME_OUTPUT_NAME.rst @@ -1,15 +1,6 @@ RUNTIME_OUTPUT_NAME ------------------- -Output name for RUNTIME target files. - -This property specifies the base name for runtime target files. It -overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. There are -three kinds of target files that may be built: archive, library, and -runtime. Executables are always treated as runtime targets. Static -libraries are always treated as archive targets. Module libraries are -always treated as library targets. For non-DLL platforms shared -libraries are treated as library targets. For DLL platforms the DLL -part of a shared library is treated as a runtime target and the -corresponding import library is treated as an archive target. All -Windows-based systems including Cygwin are DLL platforms. +.. |XXX| replace:: RUNTIME +.. |xxx| replace:: runtime +.. include:: XXX_OUTPUT_NAME.txt diff --git a/Help/prop_tgt/TARGET_FILE_TYPES.txt b/Help/prop_tgt/TARGET_FILE_TYPES.txt new file mode 100644 index 0000000..18489c7 --- /dev/null +++ b/Help/prop_tgt/TARGET_FILE_TYPES.txt @@ -0,0 +1,9 @@ +There are three kinds of target files that may be built: archive, +library, and runtime. Executables are always treated as runtime +targets. Static libraries are always treated as archive targets. +Module libraries are always treated as library targets. For +non-DLL platforms shared libraries are treated as library +targets. For DLL platforms the DLL part of a shared library is +treated as a runtime target and the corresponding import library +is treated as an archive target. All Windows-based systems +including Cygwin are DLL platforms. diff --git a/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt b/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt new file mode 100644 index 0000000..65abbce --- /dev/null +++ b/Help/prop_tgt/XXX_OUTPUT_DIRECTORY.txt @@ -0,0 +1,10 @@ +Output directory in which to build |XXX| target files. + +This property specifies the directory into which |xxx| target files +should be built. Multi-configuration generators (VS, Xcode) append a +per-configuration subdirectory to the specified directory. + +.. include:: TARGET_FILE_TYPES.txt + +This property is initialized by the value of the variable +|CMAKE_XXX_OUTPUT_DIRECTORY| if it is set when a target is created. diff --git a/Help/prop_tgt/XXX_OUTPUT_NAME.txt b/Help/prop_tgt/XXX_OUTPUT_NAME.txt new file mode 100644 index 0000000..9c4fc7c --- /dev/null +++ b/Help/prop_tgt/XXX_OUTPUT_NAME.txt @@ -0,0 +1,6 @@ +Output name for |XXX| target files. + +This property specifies the base name for |xxx| target files. It +overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties. + +.. include:: TARGET_FILE_TYPES.txt |