diff options
| author | James Johnston <johnstonj.public@codenest.com> | 2015-08-18 05:34:01 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-08-21 13:32:08 (GMT) |
| commit | 3bb707f0a1408dc0381ecbf4ec934e9f14d8927c (patch) | |
| tree | 1e6c4f6a4ad78a3d1635070207aa281bbd0e9493 /Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst | |
| parent | 404d16e7bc1b18027f719cd8642d0a90c679c396 (diff) | |
| download | CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.zip CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.gz CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.bz2 | |
Help: Improve formatting of variable documentation
Improve formatting, primarily by:
* Adding links to relevant commands, properties, generators, and so on.
* Converting code, symbols, paths, and so on to fixed-width fonts.
* Hard wrapping lines to 80 characters or less.
Diffstat (limited to 'Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst')
| -rw-r--r-- | Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst index 4f96bff..b8e9105 100644 --- a/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst +++ b/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRECTORY.rst @@ -4,16 +4,17 @@ 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). +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 +There is a similar variable +: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. |