Ver código fonte

Help: CPack Archive Generator page use field lists

Alex Turbov 2 anos atrás
pai
commit
2c46fe7c96
1 arquivos alterados com 33 adições e 23 exclusões
  1. 33 23
      Help/cpack_gen/archive.rst

+ 33 - 23
Help/cpack_gen/archive.rst

@@ -4,19 +4,19 @@ CPack Archive Generator
 CPack generator for packaging files into an archive, which can have
 any of the following formats:
 
-  - 7Z - 7zip - (.7z)
-  - TBZ2 (.tar.bz2)
-  - TGZ (.tar.gz)
-  - TXZ (.tar.xz)
-  - TZ (.tar.Z)
-  - TZST (.tar.zst)
-  - ZIP (.zip)
+  - 7Z - 7zip - (``.7z``)
+  - TBZ2 (``.tar.bz2``)
+  - TGZ (``.tar.gz``)
+  - TXZ (``.tar.xz``)
+  - TZ (``.tar.Z``)
+  - TZST (``.tar.zst``)
+  - ZIP (``.zip``)
 
 .. versionadded:: 3.1
-  ``7Z`` and ``TXZ`` formats support.
+  7Z and TXZ formats support.
 
 .. versionadded:: 3.16
-  ``TZST`` format support.
+  TZST format support.
 
 When this generator is called from ``CPackSourceConfig.cmake`` (or through
 the ``package_source`` target), then the generated archive will contain all
@@ -47,27 +47,34 @@ Variables specific to CPack Archive generator
 .. variable:: CPACK_ARCHIVE_FILE_NAME
               CPACK_ARCHIVE_<component>_FILE_NAME
 
-  Package file name without extension. The extension is determined from the
-  archive format (see list above) and automatically appended to the file name.
-  Note that ``<component>`` is all uppercase in the variable name.
+  Package file name without extension.
 
-  The default is ``<CPACK_PACKAGE_FILE_NAME>[-<component>]``, with spaces
-  replaced by '-'.
+  :Default: The default is ``<CPACK_PACKAGE_FILE_NAME>[-<component>]``, with spaces
+   replaced by '-'.
+
+  The extension is determined from the archive format (see list above) and
+  automatically appended to the file name. Note that ``<component>`` is all
+  uppercase in the variable name.
 
   .. versionadded:: 3.9
-    Per-component ``CPACK_ARCHIVE_<component>_FILE_NAME`` variables.
+    Per-component :variable:`!CPACK_ARCHIVE_<component>_FILE_NAME` variables.
 
 .. variable:: CPACK_ARCHIVE_FILE_EXTENSION
 
   .. versionadded:: 3.25
 
-  Package file extension. Default values are given in the list above.
+  Package file extension.
+
+  :Default: Default values are given in the list above.
 
 .. variable:: CPACK_ARCHIVE_COMPONENT_INSTALL
 
-  Enable component packaging. If enabled (ON), then the archive generator
-  creates  multiple packages. The default is OFF, which means that a single
-  package containing files of all components is generated.
+  Enable component packaging.
+
+  :Default: ``OFF``
+
+  If enabled (``ON``) multiple packages are generated. By default a single package
+  containing files of all components is generated.
 
 Variables used by CPack Archive generator
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -75,15 +82,18 @@ Variables used by CPack Archive generator
 These variables are used by the Archive generator, but are also available to
 CPack generators which are essentially archives at their core. These include:
 
-  - :cpack_gen:`CPack Cygwin Generator`
-  - :cpack_gen:`CPack FreeBSD Generator`
+- :cpack_gen:`CPack Cygwin Generator`
+- :cpack_gen:`CPack FreeBSD Generator`
 
 .. variable:: CPACK_ARCHIVE_THREADS
 
+  The number of threads to use when performing the compression.
+
   .. versionadded:: 3.18
 
-  The number of threads to use when performing the compression. If set to
-  ``0``, the number of available cores on the machine will be used instead.
+  :Default: ``1``
+
+  If set to ``0``, the number of available cores on the machine will be used instead.
   The default is ``1`` which limits compression to a single thread. Note that
   not all compression modes support threading in all environments. Currently,
   only the XZ compression may support it.