summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorRussell Greene <russell@churchillnavigation.com>2021-07-26 18:31:26 (GMT)
committerRussell Greene <russell@churchillnavigation.com>2021-07-29 17:38:56 (GMT)
commit008d55df7677ec69254cd480329dd713d103b20f (patch)
treefb9a90125979542a573bc1258a99a0fc72ad2e11 /Help
parent6c01bbe180df8771fa1e93776f0b716ac146218f (diff)
downloadCMake-008d55df7677ec69254cd480329dd713d103b20f.zip
CMake-008d55df7677ec69254cd480329dd713d103b20f.tar.gz
CMake-008d55df7677ec69254cd480329dd713d103b20f.tar.bz2
CPack/DEB+RPM: Update documentation on debug symbol package creation
Update documentation to elaborate on the behavior between `.ddeb` creation, CPACK_STRIP_FILES, and if the files are actually stripped. Closes: #22438
Diffstat (limited to 'Help')
-rw-r--r--Help/cpack_gen/deb.rst9
-rw-r--r--Help/cpack_gen/rpm.rst4
2 files changed, 13 insertions, 0 deletions
diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst
index d8d53ec..c0d9c3d 100644
--- a/Help/cpack_gen/deb.rst
+++ b/Help/cpack_gen/deb.rst
@@ -652,9 +652,18 @@ Dbgsym packaging has its own set of variables:
.. note::
+ Setting this also strips the ELF files in the generated non-dbgsym package,
+ which results in debuginfo only being available in the dbgsym package.
+
+.. note::
+
Binaries must contain debug symbols before packaging so use either ``Debug``
or ``RelWithDebInfo`` for :variable:`CMAKE_BUILD_TYPE` variable value.
+ Additionally, if :variable:`CPACK_STRIP_FILES` is set, the files will be stripped before
+ they get to the DEB generator, so will not contain debug symbols and
+ a dbgsym package will not get built. Do not use with :variable:`CPACK_STRIP_FILES`.
+
Building Debian packages on Windows
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst
index f6274f9..823594a 100644
--- a/Help/cpack_gen/rpm.rst
+++ b/Help/cpack_gen/rpm.rst
@@ -840,6 +840,10 @@ Debuginfo RPM packaging has its own set of variables:
Binaries must contain debug symbols before packaging so use either ``Debug``
or ``RelWithDebInfo`` for :variable:`CMAKE_BUILD_TYPE` variable value.
+ Additionally, if :variable:`CPACK_STRIP_FILES` is set, the files will be stripped before
+ they get to the RPM generator, so will not contain debug symbols and
+ a debuginfo package will not get built. Do not use with :variable:`CPACK_STRIP_FILES`.
+
.. note::
Packages generated from packages without binary files, with binary files but