summaryrefslogtreecommitdiff
path: root/Help/prop_tgt/PDB_NAME.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-12-02 11:29:29 -0500
committerBrad King <brad.king@kitware.com>2013-12-02 11:32:41 -0500
commitc0897cfad0c8f1c7671ecc8b24bbfd189a9237de (patch)
tree6d21e290c724077ba6f7dd9c81a755444fc764c1 /Help/prop_tgt/PDB_NAME.rst
parent09c05f37cf6c0cba643492aa4a597d6d465a8f32 (diff)
downloadcmake-c0897cfad0c8f1c7671ecc8b24bbfd189a9237de.tar.gz
Help: Document PDB behavior w.r.t. static libraries explicitly (#14600)
Document PDB_NAME and PDB_OUTPUT_DIRECTORY as applying only to shared libraries and executables. Add an explicit note to explain why they do not work for static libraries.
Diffstat (limited to 'Help/prop_tgt/PDB_NAME.rst')
-rw-r--r--Help/prop_tgt/PDB_NAME.rst10
1 files changed, 6 insertions, 4 deletions
diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst
index fa3f2ec74e..e8fc3be522 100644
--- a/Help/prop_tgt/PDB_NAME.rst
+++ b/Help/prop_tgt/PDB_NAME.rst
@@ -1,11 +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.
+
+.. include:: PDB_NOTE.txt
This property is not implemented by the :generator:`Visual Studio 6`
generator.