Merge topic 'cpack-deb-tar-format'

38e75bb3c6 CPack/Deb: Remove paxr as a supported tar format for a .deb
0fc6faf2dd Help: Replace use of :code:`` with plain reST syntax

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !2651

7 files changed, 34 insertions, 24 deletions

diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst
index fdde654..23f0515 100644
--- a/Help/cpack_gen/deb.rst
+++ b/Help/cpack_gen/deb.rst
@@ -15,9 +15,9 @@ better deb package when Debian specific tools ``dpkg-xxx`` are usable on
 the build system.
 
 The CPack DEB generator has specific features which are controlled by the
-specifics :code:`CPACK_DEBIAN_XXX` variables.
+specifics ``CPACK_DEBIAN_XXX`` variables.
 
-:code:`CPACK_DEBIAN_<COMPONENT>_XXXX` variables may be used in order to have
+``CPACK_DEBIAN_<COMPONENT>_XXXX`` variables may be used in order to have
 **component** specific values.  Note however that ``<COMPONENT>`` refers to
 the **grouping name** written in upper case. It may be either a component name
 or a component GROUP name.
@@ -133,8 +133,8 @@ List of CPack DEB generator specific variables:
  The Debian package architecture
 
  * Mandatory : YES
- * Default   : Output of :code:`dpkg --print-architecture` (or :code:`i386`
-   if :code:`dpkg` is not found)
+ * Default   : Output of ``dpkg --print-architecture`` (or ``i386``
+   if ``dpkg`` is not found)
 
 .. variable:: CPACK_DEBIAN_PACKAGE_DEPENDS
               CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS
@@ -176,7 +176,7 @@ List of CPack DEB generator specific variables:
  The Debian package maintainer
 
  * Mandatory : YES
- * Default   : :code:`CPACK_PACKAGE_CONTACT`
+ * Default   : ``CPACK_PACKAGE_CONTACT``
 
 .. variable:: CPACK_DEBIAN_PACKAGE_DESCRIPTION
               CPACK_COMPONENT_<COMPONENT>_DESCRIPTION
@@ -205,18 +205,18 @@ List of CPack DEB generator specific variables:
  The archive format used for creating the Debian package.
 
  * Mandatory : YES
- * Default   : "paxr"
+ * Default   : "gnutar"
 
- Possible values are:
+ Possible value is:
 
- - paxr
  - gnutar
 
  .. note::
 
-   Default pax archive format is the most portable format and generates
-   packages that do not treat sparse files specially.
-   GNU tar format on the other hand supports longer filenames.
+   This variable previously defaulted to the ``paxr`` value, but ``dpkg``
+   has never supported that tar format. For backwards compatibility the
+   ``paxr`` value will be mapped to ``gnutar`` and a deprecation message
+   will be emitted.
 
 .. variable:: CPACK_DEBIAN_COMPRESSION_TYPE
 
@@ -260,7 +260,7 @@ List of CPack DEB generator specific variables:
 .. variable:: CPACK_DEBIAN_PACKAGE_SHLIBDEPS
               CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS
 
- May be set to ON in order to use :code:`dpkg-shlibdeps` to generate
+ May be set to ON in order to use ``dpkg-shlibdeps`` to generate
  better package dependency list.
 
  * Mandatory : NO
@@ -272,7 +272,7 @@ List of CPack DEB generator specific variables:
  .. note::
 
    You may need set :variable:`CMAKE_INSTALL_RPATH` to an appropriate value
-   if you use this feature, because if you don't :code:`dpkg-shlibdeps`
+   if you use this feature, because if you don't ``dpkg-shlibdeps``
    may fail to find your own shared libs.
    See https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/RPATH-handling
 
@@ -289,7 +289,7 @@ List of CPack DEB generator specific variables:
 
  Sets the `Pre-Depends` field of the Debian package.
  Like :variable:`Depends <CPACK_DEBIAN_PACKAGE_DEPENDS>`, except that it
- also forces :code:`dpkg` to complete installation of the packages named
+ also forces ``dpkg`` to complete installation of the packages named
  before even starting the installation of the package which declares the
  pre-dependency.
 
@@ -324,7 +324,7 @@ List of CPack DEB generator specific variables:
 
  Sets the `Breaks` field of the Debian package.
  When a binary package (P) declares that it breaks other packages (B),
- :code:`dpkg` will not allow the package (P) which declares `Breaks` be
+ ``dpkg`` will not allow the package (P) which declares `Breaks` be
  **unpacked** unless the packages that will be broken (B) are deconfigured
  first.
  As long as the package (P) is configured, the previously deconfigured
@@ -344,7 +344,7 @@ List of CPack DEB generator specific variables:
 
  Sets the `Conflicts` field of the Debian package.
  When one binary package declares a conflict with another using a `Conflicts`
- field, :code:`dpkg` will not allow them to be unpacked on the system at
+ field, ``dpkg`` will not allow them to be unpacked on the system at
  the same time.
 
  * Mandatory : NO
diff --git a/Help/cpack_gen/freebsd.rst b/Help/cpack_gen/freebsd.rst
index b22ea9a..a8dd320 100644
--- a/Help/cpack_gen/freebsd.rst
+++ b/Help/cpack_gen/freebsd.rst
@@ -20,7 +20,7 @@ The CPack FreeBSD generator should work on any host with libpkg installed. The
 packages it produces are specific to the host architecture and ABI.
 
 The CPack FreeBSD generator sets package-metadata through
-:code:`CPACK_FREEBSD_XXX` variables. The CPack FreeBSD generator, unlike the
+``CPACK_FREEBSD_XXX`` variables. The CPack FreeBSD generator, unlike the
 CPack Deb generator, does not specially support componentized packages; a
 single package is created from all the software artifacts created through
 CMake.
diff --git a/Help/cpack_gen/nuget.rst b/Help/cpack_gen/nuget.rst
index c8c481f..f8aa626 100644
--- a/Help/cpack_gen/nuget.rst
+++ b/Help/cpack_gen/nuget.rst
@@ -18,7 +18,7 @@ The CPack NuGet generator may be used to create NuGet packages using
 it uses the ``CPACK_XXX`` variables used by :module:`CPack`.
 
 The CPack NuGet generator has specific features which are controlled by the
-specifics :code:`CPACK_NUGET_XXX` variables. In the "one per group" mode
+specifics ``CPACK_NUGET_XXX`` variables. In the "one per group" mode
 (see :variable:`CPACK_COMPONENTS_GROUPING`), ``<compName>`` placeholder
 in the variables below would contain a group name (uppercased and turned into
 a "C" identifier).
diff --git a/Help/cpack_gen/rpm.rst b/Help/cpack_gen/rpm.rst
index 5c543ff..65009db 100644
--- a/Help/cpack_gen/rpm.rst
+++ b/Help/cpack_gen/rpm.rst
@@ -11,9 +11,9 @@ The CPack RPM generator is a :module:`CPack` generator thus it uses the
 ``CPACK_XXX`` variables used by :module:`CPack`.
 
 The CPack RPM generator has specific features which are controlled by the specifics
-:code:`CPACK_RPM_XXX` variables.
+``CPACK_RPM_XXX`` variables.
 
-:code:`CPACK_RPM_<COMPONENT>_XXXX` variables may be used in order to have
+``CPACK_RPM_<COMPONENT>_XXXX`` variables may be used in order to have
 **component** specific values.  Note however that ``<COMPONENT>`` refers to the
 **grouping name** written in upper case. It may be either a component name or
 a component GROUP name. Usually those variables correspond to RPM spec file
diff --git a/Help/release/dev/cpack-deb-tar-format.rst b/Help/release/dev/cpack-deb-tar-format.rst
new file mode 100644
index 0000000..9296ec6
--- /dev/null
+++ b/Help/release/dev/cpack-deb-tar-format.rst
@@ -0,0 +1,7 @@
+cpack-deb-tar-format
+--------------------
+
+* The :module:`CPack` module no longer defaults to the ``paxr`` value in the
+  :variable:`CPACK_DEBIAN_ARCHIVE_TYPE` variable, because ``dpkg`` has
+  never supported the PAX tar format. The ``paxr`` value will be mapped
+  to ``gnutar`` and a deprecation message emitted.
diff --git a/Modules/Internal/CPack/CPackDeb.cmake b/Modules/Internal/CPack/CPackDeb.cmake
index 3042a16..89dc6f0 100644
--- a/Modules/Internal/CPack/CPackDeb.cmake
+++ b/Modules/Internal/CPack/CPackDeb.cmake
@@ -482,13 +482,16 @@ function(cpack_deb_prepare_package_vars)
   endif()
 
   if(CPACK_DEBIAN_ARCHIVE_TYPE)
-    set(archive_types_ "paxr;gnutar")
-    if(NOT CPACK_DEBIAN_ARCHIVE_TYPE IN_LIST archive_types_)
+    if(CPACK_DEBIAN_ARCHIVE_TYPE STREQUAL "paxr")
+      message(DEPRECATION "CPACK_DEBIAN_ARCHIVE_TYPE set to old and invalid "
+        "type 'paxr', mapping to 'gnutar'")
+      set(CPACK_DEBIAN_ARCHIVE_TYPE "gnutar")
+    elseif(NOT CPACK_DEBIAN_ARCHIVE_TYPE STREQUAL "gnutar")
       message(FATAL_ERROR "CPACK_DEBIAN_ARCHIVE_TYPE set to unsupported"
         "type ${CPACK_DEBIAN_ARCHIVE_TYPE}")
     endif()
   else()
-    set(CPACK_DEBIAN_ARCHIVE_TYPE "paxr")
+    set(CPACK_DEBIAN_ARCHIVE_TYPE "gnutar")
   endif()
 
   # Compression: (recommended)
diff --git a/Source/CPack/cmCPackDebGenerator.cxx b/Source/CPack/cmCPackDebGenerator.cxx
index ea0ee58..29968af 100644
--- a/Source/CPack/cmCPackDebGenerator.cxx
+++ b/Source/CPack/cmCPackDebGenerator.cxx
@@ -80,7 +80,7 @@ DebGenerator::DebGenerator(
   , WorkDir(workDir)
   , TopLevelDir(topLevelDir)
   , TemporaryDir(temporaryDir)
-  , DebianArchiveType(debianArchiveType ? debianArchiveType : "paxr")
+  , DebianArchiveType(debianArchiveType ? debianArchiveType : "gnutar")
   , ControlValues(controlValues)
   , GenShLibs(genShLibs)
   , ShLibsFilename(shLibsFilename)