Commit 30b21860 authored by Brad King's avatar Brad King
Browse files

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.
parent bfe07aa9
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
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
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
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
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
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
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.
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.
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
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment