summaryrefslogtreecommitdiffstats
path: root/Help/cpack_gen/cygwin.rst
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2018-06-15 17:20:45 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2018-06-21 15:00:25 (GMT)
commit2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a (patch)
treedd2d8494ccbec274bb06d698f975cf7563d722e9 /Help/cpack_gen/cygwin.rst
parentbe6267808a6b02c4125054d2fbcb81651b63e9aa (diff)
downloadCMake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.zip
CMake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.tar.gz
CMake-2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a.tar.bz2
Help: Add new section for CPack generators
The documentation for CPack generators previously lived in their respective internal CMake modules. This setup was misleading, because it implied that you should include the modules in your own code, which is not the case. Moving the documentation into a separate section does a better job of hiding the internal modules, which are just an implementation detail. The generator documentation has also been modified to remove any references to the module name. The CPackIFW module is a special exception: since it has user-facing macros, the documentation for these macros has been kept in the module page, while all other documentation related to the IFW generator has been moved into the new section. To make it easier to find the new documentation, the old help pages for the CPack*.cmake modules have not been deleted, but have been replaced with a link to their respective help page in the new documentation section.
Diffstat (limited to 'Help/cpack_gen/cygwin.rst')
-rw-r--r--Help/cpack_gen/cygwin.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/Help/cpack_gen/cygwin.rst b/Help/cpack_gen/cygwin.rst
new file mode 100644
index 0000000..1c5f7af
--- /dev/null
+++ b/Help/cpack_gen/cygwin.rst
@@ -0,0 +1,23 @@
+CPack Cygwin Generator
+----------------------
+
+Cygwin CPack generator (Cygwin).
+
+Variables specific to CPack Cygwin generator
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The
+following variable is specific to installers build on and/or for
+Cygwin:
+
+.. variable:: CPACK_CYGWIN_PATCH_NUMBER
+
+ The Cygwin patch number. FIXME: This documentation is incomplete.
+
+.. variable:: CPACK_CYGWIN_PATCH_FILE
+
+ The Cygwin patch file. FIXME: This documentation is incomplete.
+
+.. variable:: CPACK_CYGWIN_BUILD_SCRIPT
+
+ The Cygwin build script. FIXME: This documentation is incomplete.