CMake/Help/variable/CPACK_INCLUDE_TOPLEVEL_DIRE...

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
: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.
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 19:17:36 +04:00			`CPACK_INCLUDE_TOPLEVEL_DIRECTORY`
			`--------------------------------`

			`Boolean toggle to include/exclude top level directory.`

			`When preparing a package CPack installs the item under the so-called`
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. 2015-08-18 08:34:01 +03:00			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``).
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 19:17:36 +04:00
			`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.`

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. 2015-08-18 08:34:01 +03:00			`There is a similar variable`
			:variable:`CPACK_COMPONENT_INCLUDE_TOPLEVEL_DIRECTORY` which may be used
			`to override the behavior for the component packaging`
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it. 2013-10-15 19:17:36 +04:00			`case which may have different default value for historical (now`
			`backward compatibility) reason.`