kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge topic 'doc-pdb-not-for-static-libs' 

c0897cf Help: Document PDB behavior w.r.t. static libraries explicitly (#14600)
09c05f3 Help: Format PDB_NAME and PDB_OUTPUT_DIRECTORY documentation
cb7b907 Help: Document CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable
This commit is contained in:
Brad King 2013-12-02 12:07:50 -05:00 committed by CMake Topic Stage
parent fab69a3db9 c0897cfad0
commit 65fb49ba35
8 changed files with 54 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Help/manual/cmake-variables.7.rst
View File

@ -204,6 +204,7 @@ Variables that Control the Build
/variable/CMAKE_NO_BUILTIN_CHRPATH
/variable/CMAKE_NO_SYSTEM_FROM_IMPORTED
/variable/CMAKE_PDB_OUTPUT_DIRECTORY
/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG
/variable/CMAKE_POSITION_INDEPENDENT_CODE
/variable/CMAKE_RUNTIME_OUTPUT_DIRECTORY
/variable/CMAKE_SHARED_LINKER_FLAGS_CONFIG

13
Help/prop_tgt/PDB_NAME.rst
View File

@ -1,10 +1,13 @@
PDB_NAME
--------
Output name for MS debug symbols .pdb file from linker.
Output name for the MS debug symbol ``.pdb`` file generated by the
linker for an executable or shared library target.
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 specifies the base name for the debug symbols file.
If not set, the logical target name is used by default.
This property is not implemented by the Visual Studio 6 generator.
.. include:: PDB_NOTE.txt
This property is not implemented by the :generator:`Visual Studio 6`
generator.

8
Help/prop_tgt/PDB_NAME_CONFIG.rst
View File

@ -1,8 +1,10 @@
PDB_NAME_<CONFIG>
-----------------
Per-configuration name for MS debug symbols .pdb file.
Per-configuration output name for the MS debug symbol ``.pdb`` file
generated by the linker for an executable or shared library target.
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.

8
Help/prop_tgt/PDB_NOTE.txt Normal file
View File

@ -0,0 +1,8 @@
.. note::
This property does not apply to STATIC library targets because no linker
is invoked to produce them so they have no linker-generated ``.pdb`` file
containing debug symbols.
The compiler-generated program database files specified by the MSVC
``/Fd`` flag are not the same as linker-generated program database
files and so are not influenced by this property.

12
Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst
View File

@ -1,11 +1,15 @@
PDB_OUTPUT_DIRECTORY
--------------------
Output directory for MS debug symbols .pdb file from linker.
Output directory for the MS debug symbols ``.pdb`` file
generated by the linker for an executable or shared library target.
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.
.. include:: PDB_NOTE.txt
This property is not implemented by the :generator:`Visual Studio 6`
generator.

16
Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst
View File

@ -1,13 +1,15 @@
PDB_OUTPUT_DIRECTORY_<CONFIG>
-----------------------------
Per-configuration output directory for MS debug symbols .pdb files.
Per-configuration output directory for the MS debug symbol ``.pdb`` file
generated by the linker for an executable or shared library target.
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.

7
Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst
View File

@ -1,8 +1,9 @@
CMAKE_PDB_OUTPUT_DIRECTORY
--------------------------
Where to put all the MS debug symbol files from linker.
Output directory for MS debug symbol ``.pdb`` files generated by the
linker for executable and shared library targets.
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.

11
Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst Normal file
View File

@ -0,0 +1,11 @@
CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG>
-----------------------------------
Per-configuration output directory for MS debug symbol ``.pdb`` files
generated by the linker for executable and shared library targets.
This is a per-configuration version of :variable:`CMAKE_PDB_OUTPUT_DIRECTORY`.
This variable is used to initialize the
:prop_tgt:`PDB_OUTPUT_DIRECTORY_<CONFIG>`
property on all the targets. See that target property for additional
information.