From 12deb051b368afcec39f58f9e3beb1c702051e74 Mon Sep 17 00:00:00 2001 From: Craig Scott Date: Sun, 4 Nov 2018 10:02:05 +1100 Subject: Help: Use correct CPack generator names CPack generator names were not used consistently throughout the documentation, resulting in ambiguity about what the correct name was for use with the `cpack -G` option. With the changes in this commit, the cpack-generators(7) page of the manual now shows the correct names and other help pages no longer use inconsistent or incorrect names. --- Help/cpack_gen/deb.rst | 24 ++++++++++++------------ Help/cpack_gen/dmg.rst | 6 +++--- Help/cpack_gen/freebsd.rst | 2 +- Help/cpack_gen/wix.rst | 16 ++++++++-------- Help/module/CPackDMG.rst | 2 +- Help/module/CPackDeb.rst | 2 +- Help/module/CPackWIX.rst | 2 +- Help/release/3.1.rst | 4 ++-- Help/release/3.10.rst | 8 ++++---- Help/release/3.13.rst | 4 ++-- Help/release/3.3.rst | 4 ++-- Help/release/3.4.rst | 6 +++--- Help/release/3.5.rst | 8 ++++---- Help/release/3.6.rst | 16 ++++++++-------- Help/release/3.7.rst | 10 +++++----- Help/release/3.9.rst | 4 ++-- 16 files changed, 59 insertions(+), 59 deletions(-) diff --git a/Help/cpack_gen/deb.rst b/Help/cpack_gen/deb.rst index 26021cc..fdde654 100644 --- a/Help/cpack_gen/deb.rst +++ b/Help/cpack_gen/deb.rst @@ -1,20 +1,20 @@ -CPack Deb Generator +CPack DEB Generator ------------------- -The built in (binary) CPack Deb generator (Unix only) +The built in (binary) CPack DEB generator (Unix only) Variables specific to CPack Debian (DEB) generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The CPack Deb generator may be used to create Deb package using :module:`CPack`. -The CPack Deb generator is a :module:`CPack` generator thus it uses the +The CPack DEB generator may be used to create DEB package using :module:`CPack`. +The CPack DEB generator is a :module:`CPack` generator thus it uses the ``CPACK_XXX`` variables used by :module:`CPack`. -The CPack Deb generator should work on any Linux host but it will produce +The CPack DEB generator should work on any Linux host but it will produce 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 +The CPack DEB generator has specific features which are controlled by the specifics :code:`CPACK_DEBIAN_XXX` variables. :code:`CPACK_DEBIAN__XXXX` variables may be used in order to have @@ -22,13 +22,13 @@ specifics :code:`CPACK_DEBIAN_XXX` variables. the **grouping name** written in upper case. It may be either a component name or a component GROUP name. -Here are some CPack Deb generator wiki resources that are here for historic +Here are some CPack DEB generator wiki resources that are here for historic reasons and are no longer maintained but may still prove useful: - https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/Configuration - https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/PackageGenerators#deb-unix-only -List of CPack Deb generator specific variables: +List of CPack DEB generator specific variables: .. variable:: CPACK_DEB_COMPONENT_INSTALL @@ -64,7 +64,7 @@ List of CPack Deb generator specific variables: * Mandatory : YES * Default : ``[-].deb`` - This may be set to ``DEB-DEFAULT`` to allow the CPack Deb generator to generate + This may be set to ``DEB-DEFAULT`` to allow the CPack DEB generator to generate package file name by itself in deb format:: _-_.deb @@ -75,7 +75,7 @@ List of CPack Deb generator specific variables: .. note:: Preferred setting of this variable is ``DEB-DEFAULT`` but for backward - compatibility with the CPack Deb generator in CMake prior to version 3.6 this + compatibility with the CPack DEB generator in CMake prior to version 3.6 this feature is disabled by default. .. note:: @@ -279,7 +279,7 @@ List of CPack Deb generator specific variables: .. variable:: CPACK_DEBIAN_PACKAGE_DEBUG May be set when invoking cpack in order to trace debug information - during the CPack Deb generator run. + during the CPack DEB generator run. * Mandatory : NO * Default : - @@ -553,5 +553,5 @@ Reproducible packages The environment variable ``SOURCE_DATE_EPOCH`` may be set to a UNIX timestamp, defined as the number of seconds, excluding leap seconds, -since 01 Jan 1970 00:00:00 UTC. If set, the CPack Deb generator will +since 01 Jan 1970 00:00:00 UTC. If set, the CPack DEB generator will use its value for timestamps in the package. diff --git a/Help/cpack_gen/dmg.rst b/Help/cpack_gen/dmg.rst index b7b3a0a..1e37889 100644 --- a/Help/cpack_gen/dmg.rst +++ b/Help/cpack_gen/dmg.rst @@ -1,7 +1,7 @@ -CPack DMG Generator -------------------- +CPack DragNDrop Generator +------------------------- -DragNDrop CPack generator (macOS). +The DragNDrop CPack generator (macOS) creates a DMG image. Variables specific to CPack DragNDrop generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/Help/cpack_gen/freebsd.rst b/Help/cpack_gen/freebsd.rst index 2419057..b22ea9a 100644 --- a/Help/cpack_gen/freebsd.rst +++ b/Help/cpack_gen/freebsd.rst @@ -13,7 +13,7 @@ depending on the installed package-management tools -- using :module:`CPack`. The CPack FreeBSD generator is a :module:`CPack` generator and uses the ``CPACK_XXX`` variables used by :module:`CPack`. It tries to re-use packaging information that may already be specified for Debian packages for the -:cpack_gen:`CPack Deb Generator`. It also tries to re-use RPM packaging +:cpack_gen:`CPack DEB Generator`. It also tries to re-use RPM packaging information when Debian does not specify. The CPack FreeBSD generator should work on any host with libpkg installed. The diff --git a/Help/cpack_gen/wix.rst b/Help/cpack_gen/wix.rst index fc8a098..dde4943 100644 --- a/Help/cpack_gen/wix.rst +++ b/Help/cpack_gen/wix.rst @@ -1,9 +1,9 @@ -CPack WiX Generator +CPack WIX Generator ------------------- -CPack WiX generator specific options +CPack WIX generator specific options -Variables specific to CPack WiX generator +Variables specific to CPack WIX generator ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The following variables are specific to the installers built on @@ -50,11 +50,11 @@ Windows using WiX. If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is. If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly - converted to RTF by the WiX Generator. + converted to RTF by the WIX Generator. The expected encoding of the .txt file is UTF-8. With CPACK_WIX_LICENSE_RTF you can override the license file used by the - WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported + WIX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported format or the .txt -> .rtf conversion does not work as expected. .. variable:: CPACK_WIX_PRODUCT_ICON @@ -122,10 +122,10 @@ Windows using WiX. generated WiX sources This optional variable can be used to specify an XML file that the - WiX generator will use to inject fragments into its generated + WIX generator will use to inject fragments into its generated source files. - Patch files understood by the CPack WiX generator + Patch files understood by the CPack WIX generator roughly follow this RELAX NG compact schema: .. code-block:: none @@ -155,7 +155,7 @@ Windows using WiX. The following example illustrates how this works. - Given that the WiX generator creates the following XML element: + Given that the WIX generator creates the following XML element: .. code-block:: xml diff --git a/Help/module/CPackDMG.rst b/Help/module/CPackDMG.rst index a597002..e59dcbb 100644 --- a/Help/module/CPackDMG.rst +++ b/Help/module/CPackDMG.rst @@ -1,4 +1,4 @@ CPackDMG -------- -The documentation for the CPack DMG generator has moved here: :cpack_gen:`CPack DMG Generator` +The documentation for the CPack DragNDrop generator has moved here: :cpack_gen:`CPack DragNDrop Generator` diff --git a/Help/module/CPackDeb.rst b/Help/module/CPackDeb.rst index 73e59a2..cd7e5f3 100644 --- a/Help/module/CPackDeb.rst +++ b/Help/module/CPackDeb.rst @@ -1,4 +1,4 @@ CPackDeb -------- -The documentation for the CPack Deb generator has moved here: :cpack_gen:`CPack Deb Generator` +The documentation for the CPack DEB generator has moved here: :cpack_gen:`CPack DEB Generator` diff --git a/Help/module/CPackWIX.rst b/Help/module/CPackWIX.rst index e1d4a03..c88c723 100644 --- a/Help/module/CPackWIX.rst +++ b/Help/module/CPackWIX.rst @@ -1,4 +1,4 @@ CPackWIX -------- -The documentation for the CPack WiX generator has moved here: :cpack_gen:`CPack WiX Generator` +The documentation for the CPack WIX generator has moved here: :cpack_gen:`CPack WIX Generator` diff --git a/Help/release/3.1.rst b/Help/release/3.1.rst index 8278353..8bea28f 100644 --- a/Help/release/3.1.rst +++ b/Help/release/3.1.rst @@ -294,11 +294,11 @@ CPack * :manual:`cpack(1)` gained ``7Z`` and ``TXZ`` generators supporting lzma-compressed archives. -* The :cpack_gen:`CPack Deb Generator` learned a new +* The :cpack_gen:`CPack DEB Generator` learned a new :variable:`CPACK_DEBIAN_COMPRESSION_TYPE` variable to set the tarball compression type. -* The :manual:`cpack(1)` ``WiX`` generator learned to support +* The :cpack_gen:`CPack WIX Generator` learned to support a :prop_inst:`CPACK_WIX_ACL` installed file property to specify an Access Control List. diff --git a/Help/release/3.10.rst b/Help/release/3.10.rst index 66a1d09..03eda36 100644 --- a/Help/release/3.10.rst +++ b/Help/release/3.10.rst @@ -186,15 +186,15 @@ CPack * A :cpack_gen:`CPack FreeBSD Generator` was added for FreeBSD ``pkg(8)``. -* The :cpack_gen:`CPack Deb Generator` was enabled on Windows. While not +* The :cpack_gen:`CPack DEB Generator` was enabled on Windows. While not fully featured (due to the lack of external UNIX tools) this will allow building basic cross-platform Debian packages. -* The :cpack_gen:`CPack Deb Generator` learned to set package release +* The :cpack_gen:`CPack DEB Generator` learned to set package release version in ``Version`` info property. See the :variable:`CPACK_DEBIAN_PACKAGE_RELEASE` variable. -* The :cpack_gen:`CPack Deb Generator` learned more strict package +* The :cpack_gen:`CPack DEB Generator` learned more strict package version checking that complies with Debian rules. * The :module:`CPackIFW` module :command:`cpack_ifw_configure_component` and @@ -211,7 +211,7 @@ CPack repack dependent components. This feature is only available when using QtIFW 3.1 or later. -* The :cpack_gen:`CPack RPM Generator` and :cpack_gen:`CPack Deb Generator` +* The :cpack_gen:`CPack RPM Generator` and :cpack_gen:`CPack DEB Generator` learned to set the package epoch version. See :variable:`CPACK_RPM_PACKAGE_EPOCH` and :variable:`CPACK_DEBIAN_PACKAGE_EPOCH` variables. diff --git a/Help/release/3.13.rst b/Help/release/3.13.rst index f547556..989eaa5 100644 --- a/Help/release/3.13.rst +++ b/Help/release/3.13.rst @@ -178,11 +178,11 @@ CTest CPack ----- -* The :cpack_gen:`CPack Deb Generator` learned to split debug symbols into +* The :cpack_gen:`CPack DEB Generator` learned to split debug symbols into a corresponding .ddeb package when ``CPACK_DEBIAN_DEBUGINFO_PACKAGE`` is set. -* The :cpack_gen:`CPack Deb Generator` learned to honor the ``SOURCE_DATE_EPOCH`` +* The :cpack_gen:`CPack DEB Generator` learned to honor the ``SOURCE_DATE_EPOCH`` environment variable when packaging files. This is useful for generating reproducible packages. diff --git a/Help/release/3.3.rst b/Help/release/3.3.rst index 11f0c60..6657e8d 100644 --- a/Help/release/3.3.rst +++ b/Help/release/3.3.rst @@ -172,11 +172,11 @@ CPack * The :cpack_gen:`CPack IFW Generator` learned to support Qt Framework Installer 2.0 tools. -* The :cpack_gen:`CPack Deb Generator` learned a new +* The :cpack_gen:`CPack DEB Generator` learned a new :variable:`CPACK_DEBIAN__PACKAGE_SHLIBDEPS` variable to specify per-component use of ``dpkg-shlibdeps``. -* The :cpack_gen:`CPack Deb Generator` learned a new +* The :cpack_gen:`CPack DEB Generator` learned a new :variable:`CPACK_DEBIAN__PACKAGE_DEPENDS` option to specify per-component dependencies. diff --git a/Help/release/3.4.rst b/Help/release/3.4.rst index 0a0e6df..943d267 100644 --- a/Help/release/3.4.rst +++ b/Help/release/3.4.rst @@ -197,7 +197,7 @@ CTest CPack ----- -* The :cpack_gen:`CPack Deb Generator` learned to set package dependencies +* The :cpack_gen:`CPack DEB Generator` learned to set package dependencies per component. See variables: * :variable:`CPACK_DEBIAN__PACKAGE_BREAKS` @@ -249,10 +249,10 @@ Other Changes :module:`CheckSymbolExists`, and :module:`FindThreads` modules learned to work in environments where only CXX is enabled. -* The :cpack_gen:`CPack Deb Generator` now correctly excludes symlinks +* The :cpack_gen:`CPack DEB Generator` now correctly excludes symlinks during package checksum calculation. -* The :cpack_gen:`CPack Deb Generator` no longer uses fakeroot and +* The :cpack_gen:`CPack DEB Generator` no longer uses fakeroot and system tar program for packaging. * The :module:`CPack` module no longer mangles settings with CMake-special diff --git a/Help/release/3.5.rst b/Help/release/3.5.rst index f988908..58a5d4e 100644 --- a/Help/release/3.5.rst +++ b/Help/release/3.5.rst @@ -120,23 +120,23 @@ Platforms CPack ----- -* The :cpack_gen:`CPack DMG Generator` learned new variable to +* The :cpack_gen:`CPack DragNDrop Generator` learned new variable to specify AppleScript file run to customize appearance of ``DragNDrop`` installer folder, including background image setting using supplied PNG or multi-resolution TIFF file. See the :variable:`CPACK_DMG_DS_STORE_SETUP_SCRIPT` and :variable:`CPACK_DMG_BACKGROUND_IMAGE` variables. -* The :cpack_gen:`CPack Deb Generator` learned to set the optional config +* The :cpack_gen:`CPack DEB Generator` learned to set the optional config file ``Source`` field using a monolithic or per-component variable. See :variable:`CPACK_DEBIAN_PACKAGE_SOURCE`. -* The :cpack_gen:`CPack Deb Generator` learned to set Package, Section +* The :cpack_gen:`CPack DEB Generator` learned to set Package, Section and Priority control fields per-component. See variables :variable:`CPACK_DEBIAN__PACKAGE_SECTION` and :variable:`CPACK_DEBIAN__PACKAGE_PRIORITY`. -* The :cpack_gen:`CPack DMG Generator` learned to add +* The :cpack_gen:`CPack DragNDrop Generator` learned to add multi-lingual SLAs to a DMG which is presented to the user when they try to mount the DMG. See the :variable:`CPACK_DMG_SLA_LANGUAGES` and :variable:`CPACK_DMG_SLA_DIR` variables for details. diff --git a/Help/release/3.6.rst b/Help/release/3.6.rst index c796d70..74dac1c 100644 --- a/Help/release/3.6.rst +++ b/Help/release/3.6.rst @@ -165,24 +165,24 @@ CTest CPack ----- -* The :cpack_gen:`CPack Deb Generator` learned how to handle ``$ORIGIN`` +* The :cpack_gen:`CPack DEB Generator` learned how to handle ``$ORIGIN`` in ``CMAKE_INSTALL_RPATH`` when :variable:`CPACK_DEBIAN_PACKAGE_SHLIBDEPS` is used for dependency auto detection. -* The :cpack_gen:`CPack Deb Generator` learned how to generate +* The :cpack_gen:`CPack DEB Generator` learned how to generate ``DEBIAN/shlibs`` contorl file when package contains shared libraries. -* The :cpack_gen:`CPack Deb Generator` learned how to generate +* The :cpack_gen:`CPack DEB Generator` learned how to generate ``DEBIAN/postinst`` and ``DEBIAN/postrm`` files if the package installs libraries in ldconfig-controlled locations (e.g. ``/lib/``, ``/usr/lib/``). -* The :cpack_gen:`CPack Deb Generator` learned how to generate dependencies +* The :cpack_gen:`CPack DEB Generator` learned how to generate dependencies between Debian packages if multi-component setup is used and :variable:`CPACK_COMPONENT__DEPENDS` variables are set. For backward compatibility this feature is disabled by default. See :variable:`CPACK_DEBIAN_ENABLE_COMPONENT_DEPENDS`. -* The :cpack_gen:`CPack Deb Generator` learned how to set custom package +* The :cpack_gen:`CPack DEB Generator` learned how to set custom package file names including how to generate properly-named Debian packages:: _-_.deb @@ -191,17 +191,17 @@ CPack :variable:`CPACK_DEBIAN_FILE_NAME` and :variable:`CPACK_DEBIAN__FILE_NAME`. -* The :cpack_gen:`CPack Deb Generator` learned how to set the package +* The :cpack_gen:`CPack DEB Generator` learned how to set the package release number (``DebianRevisionNumber`` in package file name when used in combination with ``DEB-DEFAULT`` value set by :variable:`CPACK_DEBIAN_FILE_NAME`). See :variable:`CPACK_DEBIAN_PACKAGE_RELEASE`. -* The :cpack_gen:`CPack Deb Generator` learned how to set the package +* The :cpack_gen:`CPack DEB Generator` learned how to set the package architecture per-component. See :variable:`CPACK_DEBIAN__PACKAGE_ARCHITECTURE`. -* The :cpack_gen:`CPack DMG Generator` learned a new option to skip the +* The :cpack_gen:`CPack DragNDrop Generator` learned a new option to skip the ``/Applications`` symlink. See the :variable:`CPACK_DMG_DISABLE_APPLICATIONS_SYMLINK` variable. diff --git a/Help/release/3.7.rst b/Help/release/3.7.rst index fae10f5..345c056 100644 --- a/Help/release/3.7.rst +++ b/Help/release/3.7.rst @@ -226,7 +226,7 @@ CPack * CPack gained a new :variable:`CPACK_PACKAGE_CHECKSUM` variable to enable generation of a checksum file for each package file. -* The :cpack_gen:`CPack Deb Generator` learned to support long file names +* The :cpack_gen:`CPack DEB Generator` learned to support long file names when archive format is set to GNU tar. See :variable:`CPACK_DEBIAN_ARCHIVE_TYPE` @@ -252,19 +252,19 @@ CPack :variable:`CPACK_NSIS__INSTALL_DIRECTORY`. This can be used to set component specific installation directories. -* The :cpack_gen:`CPack WiX Generator` now supports +* The :cpack_gen:`CPack WIX Generator` now supports :variable:`CPACK_WIX_SKIP_PROGRAM_FOLDER` to allow specification of a custom absolute installation prefix outside of the ProgramFiles folders. -* The :cpack_gen:`CPack WiX Generator` now supports +* The :cpack_gen:`CPack WIX Generator` now supports :variable:`CPACK_COMPONENT__DISABLED`. This can be used to deselect a component from being installed by default. -* The :cpack_gen:`CPack WiX Generator` now supports +* The :cpack_gen:`CPack WIX Generator` now supports :variable:`CPACK_WIX_PATCH_FILE` fragments for Feature elements. -* The :cpack_gen:`CPack WiX Generator` now supports +* The :cpack_gen:`CPack WIX Generator` now supports :variable:`CPACK_WIX_ROOT_FEATURE_TITLE` and :variable:`CPACK_WIX_ROOT_FEATURE_DESCRIPTION` to allow the specification of a custom title and description for the root feature element. diff --git a/Help/release/3.9.rst b/Help/release/3.9.rst index 5001e90..ffa95aa 100644 --- a/Help/release/3.9.rst +++ b/Help/release/3.9.rst @@ -232,12 +232,12 @@ CPack * The :cpack_gen:`CPack RPM Generator` learned to modify the ``debuginfo`` package name. See the :variable:`CPACK_RPM_DEBUGINFO_FILE_NAME` variable. -* The :cpack_gen:`CPack WiX Generator` patching system now has the +* The :cpack_gen:`CPack WIX Generator` patching system now has the ability to set additional attributes. This can be done by specifying attributes with the ``CPackWiXFragment`` XML tag after the ``Id`` attribute. See the :variable:`CPACK_WIX_PATCH_FILE` variable. -* The :cpack_gen:`CPack WiX Generator` implemented a new +* The :cpack_gen:`CPack WIX Generator` implemented a new :variable:`CPACK_WIX_ROOT_FOLDER_ID` variable which allows using a custom root folder ID instead of the default ``ProgramFilesFolder`` / ``ProgramFiles64Folder``. -- cgit v0.12