diff options
| author | Brad King <brad.king@kitware.com> | 2013-12-02 16:11:40 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-12-02 16:11:40 (GMT) |
| commit | 09c05f37cf6c0cba643492aa4a597d6d465a8f32 (patch) | |
| tree | 7dc4af9836d32eb51cbc4d03ed355390cae45e1a | |
| parent | cb7b90726c013b4376b221484bea4a4494c0be32 (diff) | |
| download | CMake-09c05f37cf6c0cba643492aa4a597d6d465a8f32.zip CMake-09c05f37cf6c0cba643492aa4a597d6d465a8f32.tar.gz CMake-09c05f37cf6c0cba643492aa4a597d6d465a8f32.tar.bz2 | |
Help: Format PDB_NAME and PDB_OUTPUT_DIRECTORY documentation
Add reStructuredText inline markup.
| -rw-r--r-- | Help/prop_tgt/PDB_NAME.rst | 5 | ||||
| -rw-r--r-- | Help/prop_tgt/PDB_NAME_CONFIG.rst | 7 | ||||
| -rw-r--r-- | Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst | 9 | ||||
| -rw-r--r-- | Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst | 15 | ||||
| -rw-r--r-- | Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst | 4 |
5 files changed, 22 insertions, 18 deletions
diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst index fe059e0..fa3f2ec 100644 --- a/Help/prop_tgt/PDB_NAME.rst +++ b/Help/prop_tgt/PDB_NAME.rst @@ -1,10 +1,11 @@ PDB_NAME -------- -Output name for MS debug symbols .pdb file from linker. +Output name for MS debug symbols ``.pdb`` file from linker. Set the base name for debug symbols file created for an executable or shared library target. If not set, the logical target name is used by default. -This property is not implemented by the Visual Studio 6 generator. +This property is not implemented by the :generator:`Visual Studio 6` +generator. diff --git a/Help/prop_tgt/PDB_NAME_CONFIG.rst b/Help/prop_tgt/PDB_NAME_CONFIG.rst index 50c3aa2..571f16d 100644 --- a/Help/prop_tgt/PDB_NAME_CONFIG.rst +++ b/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -1,8 +1,9 @@ PDB_NAME_<CONFIG> ----------------- -Per-configuration name for MS debug symbols .pdb file. +Per-configuration name for MS debug symbols ``.pdb`` file. -This is the configuration-specific version of PDB_NAME. +This is the configuration-specific version of :prop_tgt:`PDB_NAME`. -This property is not implemented by the Visual Studio 6 generator. +This property is not implemented by the :generator:`Visual Studio 6` +generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst index d973e90d..3cc075e 100644 --- a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -1,11 +1,12 @@ PDB_OUTPUT_DIRECTORY -------------------- -Output directory for MS debug symbols .pdb file from linker. +Output directory for MS debug symbols ``.pdb`` file from linker. This property specifies the directory into which the MS debug symbols will be placed by the linker. This property is initialized by the -value of the variable CMAKE_PDB_OUTPUT_DIRECTORY if it is set when a -target is created. +value of the :variable:`CMAKE_PDB_OUTPUT_DIRECTORY` variable if it is +set when a target is created. -This property is not implemented by the Visual Studio 6 generator. +This property is not implemented by the :generator:`Visual Studio 6` +generator. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst index 25ab944..0244646 100644 --- a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,13 +1,14 @@ PDB_OUTPUT_DIRECTORY_<CONFIG> ----------------------------- -Per-configuration output directory for MS debug symbols .pdb files. +Per-configuration output directory for MS debug symbols ``.pdb`` files. -This is a per-configuration version of PDB_OUTPUT_DIRECTORY, but -multi-configuration generators (VS, Xcode) do NOT append a +This is a per-configuration version of :prop_tgt:`PDB_OUTPUT_DIRECTORY`, +but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory. This -property is initialized by the value of the variable -CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> if it is set when a target is -created. +property is initialized by the value of the +:variable:`CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG>` variable if it is +set when a target is created. -This property is not implemented by the Visual Studio 6 generator. +This property is not implemented by the :generator:`Visual Studio 6` +generator. diff --git a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst index 938d159..b38f0ec 100644 --- a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst +++ b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst @@ -3,6 +3,6 @@ CMAKE_PDB_OUTPUT_DIRECTORY Where to put all the MS debug symbol files from linker. -This variable is used to initialize the PDB_OUTPUT_DIRECTORY property -on all the targets. See that target property for additional +This variable is used to initialize the :prop_tgt:`PDB_OUTPUT_DIRECTORY` +property on all the targets. See that target property for additional information. |