diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-16 13:28:12 (GMT) |
|---|---|---|
| committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-10-16 13:28:12 (GMT) |
| commit | c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch) | |
| tree | 96102c69673467ce7b922697cd5f378511249201 /Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst | |
| parent | 5029da5eac08171653a92b961c341f7ffcca3640 (diff) | |
| parent | 7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff) | |
| download | CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2 | |
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation
a77e308 CPack: Replace #<type> markup with reStructuredText equivalent
e7ca48f Help: Factor out cmake-generator-expressions manual page
97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
8982161 Help: Factor out find_* command duplication
30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication
bfe07aa Build Help documentation during CMake build using Sphinx
53ded59 Drop unused builtin documentation APIs
0c39a75 Drop the 'Full' field from cmDocumentationEntry
e33d8d2 Drop builtin command documentation
399e9c4 Drop builtin property documentation
6035c04 get_property: Drop test for builtin property documentation
80a3273 Drop all documentation formatters except Usage
b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents
ec6df36 Teach --help-* options to load documentation from .rst files
25f2877 Add class cmRST to do basic reStructuredText processing
...
Diffstat (limited to 'Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst')
| -rw-r--r-- | Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst new file mode 100644 index 0000000..4f96bff --- /dev/null +++ b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst @@ -0,0 +1,19 @@ +CPACK_INCLUDE_TOPLEVEL_DIRECTORY +-------------------------------- + +Boolean toggle to include/exclude top level directory. + +When preparing a package CPack installs the item under the so-called +top level directory. The purpose of is to include (set to 1 or ON or +TRUE) the top level directory in the package or not (set to 0 or OFF +or FALSE). + +Each CPack generator has a built-in default value for this variable. +E.g. Archive generators (ZIP, TGZ, ...) includes the top level +whereas RPM or DEB don't. The user may override the default value by +setting this variable. + +There is a similar variable CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY +which may be used to override the behavior for the component packaging +case which may have different default value for historical (now +backward compatibility) reason. |