From cb7b90726c013b4376b221484bea4a4494c0be32 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Dec 2013 11:11:07 -0500 Subject: Help: Document CMAKE_PDB_OUTPUT_DIRECTORY_ variable --- Help/manual/cmake-variables.7.rst | 1 + Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst | 10 ++++++++++ 2 files changed, 11 insertions(+) create mode 100644 Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst index 4e24823..0f5f1ec 100644 --- a/Help/manual/cmake-variables.7.rst +++ b/Help/manual/cmake-variables.7.rst @@ -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 diff --git a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst new file mode 100644 index 0000000..2d7341d --- /dev/null +++ b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -0,0 +1,10 @@ +CMAKE_PDB_OUTPUT_DIRECTORY_ +----------------------------------- + +Per-configuration output directory for MS debug symbols ``.pdb`` files. + +This is a per-configuration version of :variable:`CMAKE_PDB_OUTPUT_DIRECTORY`. +This variable is used to initialize the +:prop_tgt:`PDB_OUTPUT_DIRECTORY_` +property on all the targets. See that target property for additional +information. -- cgit v0.12 From 09c05f37cf6c0cba643492aa4a597d6d465a8f32 Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Dec 2013 11:11:40 -0500 Subject: Help: Format PDB_NAME and PDB_OUTPUT_DIRECTORY documentation Add reStructuredText inline markup. --- Help/prop_tgt/PDB_NAME.rst | 5 +++-- Help/prop_tgt/PDB_NAME_CONFIG.rst | 7 ++++--- Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst | 9 +++++---- Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst | 15 ++++++++------- 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_ ----------------- -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_ ----------------------------- -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_ if it is set when a target is -created. +property is initialized by the 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/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. -- cgit v0.12 From c0897cfad0c8f1c7671ecc8b24bbfd189a9237de Mon Sep 17 00:00:00 2001 From: Brad King Date: Mon, 2 Dec 2013 11:29:29 -0500 Subject: 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. --- Help/prop_tgt/PDB_NAME.rst | 10 ++++++---- Help/prop_tgt/PDB_NAME_CONFIG.rst | 3 ++- Help/prop_tgt/PDB_NOTE.txt | 8 ++++++++ Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst | 5 ++++- Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst | 3 ++- Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst | 3 ++- Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst | 3 ++- 7 files changed, 26 insertions(+), 9 deletions(-) create mode 100644 Help/prop_tgt/PDB_NOTE.txt diff --git a/Help/prop_tgt/PDB_NAME.rst b/Help/prop_tgt/PDB_NAME.rst index fa3f2ec..e8fc3be 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. diff --git a/Help/prop_tgt/PDB_NAME_CONFIG.rst b/Help/prop_tgt/PDB_NAME_CONFIG.rst index 571f16d..c846b57 100644 --- a/Help/prop_tgt/PDB_NAME_CONFIG.rst +++ b/Help/prop_tgt/PDB_NAME_CONFIG.rst @@ -1,7 +1,8 @@ PDB_NAME_ ----------------- -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 :prop_tgt:`PDB_NAME`. diff --git a/Help/prop_tgt/PDB_NOTE.txt b/Help/prop_tgt/PDB_NOTE.txt new file mode 100644 index 0000000..e55aba2 --- /dev/null +++ b/Help/prop_tgt/PDB_NOTE.txt @@ -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. diff --git a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst index 3cc075e..9a863a1 100644 --- a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY.rst @@ -1,12 +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` variable if it is set when a target is created. +.. include:: PDB_NOTE.txt + 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 0244646..caec2de 100644 --- a/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,7 +1,8 @@ PDB_OUTPUT_DIRECTORY_ ----------------------------- -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 :prop_tgt:`PDB_OUTPUT_DIRECTORY`, but multi-configuration generators (VS, Xcode) do NOT append a diff --git a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst index b38f0ec..763bcb3 100644 --- a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst +++ b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY.rst @@ -1,7 +1,8 @@ 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 :prop_tgt:`PDB_OUTPUT_DIRECTORY` property on all the targets. See that target property for additional diff --git a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst index 2d7341d..4d18eec 100644 --- a/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst +++ b/Help/variable/CMAKE_PDB_OUTPUT_DIRECTORY_CONFIG.rst @@ -1,7 +1,8 @@ CMAKE_PDB_OUTPUT_DIRECTORY_ ----------------------------------- -Per-configuration output directory for MS debug symbols ``.pdb`` files. +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 -- cgit v0.12