summaryrefslogtreecommitdiffstats
path: root/Help/cpack_gen
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2018-11-03 23:02:05 (GMT)
committerCraig Scott <craig.scott@crascit.com>2018-11-06 05:42:38 (GMT)
commit12deb051b368afcec39f58f9e3beb1c702051e74 (patch)
tree93b0fc8b05a0d93eb5986d174a879a901c87887d /Help/cpack_gen
parent20d5e77a270639a124fea587bb68b2fb6a5356fc (diff)
downloadCMake-12deb051b368afcec39f58f9e3beb1c702051e74.zip
CMake-12deb051b368afcec39f58f9e3beb1c702051e74.tar.gz
CMake-12deb051b368afcec39f58f9e3beb1c702051e74.tar.bz2
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.
Diffstat (limited to 'Help/cpack_gen')
-rw-r--r--Help/cpack_gen/deb.rst24
-rw-r--r--Help/cpack_gen/dmg.rst6
-rw-r--r--Help/cpack_gen/freebsd.rst2
-rw-r--r--Help/cpack_gen/wix.rst16
4 files changed, 24 insertions, 24 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_<COMPONENT>_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 : ``<CPACK_PACKAGE_FILE_NAME>[-<component>].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::
<PackageName>_<VersionNumber>-<DebianRevisionNumber>_<DebianArchitecture>.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