summaryrefslogtreecommitdiff
path: root/Source/cmInstallCommand.h
diff options
context:
space:
mode:
authorEric NOULARD <eric.noulard@gmail.com>2012-06-21 20:49:16 +0200
committerEric NOULARD <eric.noulard@gmail.com>2012-06-21 20:49:16 +0200
commitf7365f57759118494729ed8b8384ab77b27d4aeb (patch)
treebab6cb464090757393e4443bca065fe0331e274c /Source/cmInstallCommand.h
parentb0e5079ab55287e021e6ac37af0c3a83bc25d90e (diff)
downloadcmake-f7365f57759118494729ed8b8384ab77b27d4aeb.tar.gz
Enhance documentation of install command w.r.t. the "Undefined" component.
Inspired-By: Bill Lorensen on the mailing list.
Diffstat (limited to 'Source/cmInstallCommand.h')
-rw-r--r--Source/cmInstallCommand.h5
1 files changed, 4 insertions, 1 deletions
diff --git a/Source/cmInstallCommand.h b/Source/cmInstallCommand.h
index bf9fd9ed35..76e622e817 100644
--- a/Source/cmInstallCommand.h
+++ b/Source/cmInstallCommand.h
@@ -85,7 +85,10 @@ public:
"with which the install rule is associated, such as \"runtime\" or "
"\"development\". During component-specific installation only "
"install rules associated with the given component name will be "
- "executed. During a full installation all components are installed.\n"
+ "executed. During a full installation all components are installed."
+ " If COMPONENT is not provided a default component \"Unspecified\" is"
+ " created. The default component name may be controlled with the "
+ "CMAKE_INSTALL_DEFAULT_COMPONENT_NAME variable.\n"
"The RENAME argument specifies a name for an installed file that "
"may be different from the original file. Renaming is allowed only "
"when a single file is installed by the command.\n"