diff options
| author | Kyle Edwards <kyle.edwards@kitware.com> | 2018-06-15 17:20:45 (GMT) |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2018-06-21 15:00:25 (GMT) |
| commit | 2a2829cc75be0f8a5d7b48ac79f1f3cd53d8a54a (patch) | |
| tree | dd2d8494ccbec274bb06d698f975cf7563d722e9 /Help/cpack_gen/packagemaker.rst | |
| parent | be6267808a6b02c4125054d2fbcb81651b63e9aa (diff) | |
| download | CMake-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/packagemaker.rst')
| -rw-r--r-- | Help/cpack_gen/packagemaker.rst | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/Help/cpack_gen/packagemaker.rst b/Help/cpack_gen/packagemaker.rst new file mode 100644 index 0000000..f9abdd8 --- /dev/null +++ b/Help/cpack_gen/packagemaker.rst @@ -0,0 +1,23 @@ +CPack PackageMaker Generator +---------------------------- + +PackageMaker CPack generator (Mac OS X). + +Variables specific to CPack PackageMaker generator +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following variable is specific to installers built on Mac +OS X using PackageMaker: + +.. variable:: CPACK_OSX_PACKAGE_VERSION + + The version of Mac OS X that the resulting PackageMaker archive should be + compatible with. Different versions of Mac OS X support different + features. For example, CPack can only build component-based installers for + Mac OS X 10.4 or newer, and can only build installers that download + component son-the-fly for Mac OS X 10.5 or newer. If left blank, this value + will be set to the minimum version of Mac OS X that supports the requested + features. Set this variable to some value (e.g., 10.4) only if you want to + guarantee that your installer will work on that version of Mac OS X, and + don't mind missing extra features available in the installer shipping with + later versions of Mac OS X. |