Help: Format PDB_NAME and PDB_OUTPUT_DIRECTORY documentation

Add reStructuredText inline markup.
This commit is contained in:
Brad King 2013-12-02 11:11:40 -05:00
parent cb7b90726c
commit 09c05f37cf
5 changed files with 22 additions and 18 deletions

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.

View File

@ -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.