mirrors/cmake
2
0
Fork 0
mirror of https://gitlab.kitware.com/cmake/cmake.git synced 2026-09-25 04:09:36 +03:00
Code Activity

install: Improve documentation, argument parsing

Browse Source 
Adjust documentation of `install(CODE|SCRIPT)` to more understandably
reflect how the subcommand actually operates. Adjust argument parsing of
the same to "accept" the `COMPONENT` argument being given more than
once, consistent with how single-valued arguments are usually parsed.
This commit is contained in:
Matthew Woehlke
2026-09-11 12:22:25 -04:00
parent 216cc54531
commit 2673161b67
3 changed files with 7 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Help/command/install.rst
+1 -1
View File
@@ -841,7 +841,7 @@ Signatures
.. code-block:: cmake
install([[SCRIPT <file>] [CODE <code>]]
install({ SCRIPT <file> | CODE <code> }...
[ALL_COMPONENTS | COMPONENT <component>]
[EXCLUDE_FROM_ALL])
Source/cmInstallCommand.cxx
+6 -19
View File
@@ -923,14 +923,8 @@ bool HandleScriptMode(std::vector<std::string> const& args,
return ArgumentParser::Continue::No;
}
ArgumentParser::Continue AddComponent(cm::string_view value)
{
this->Components.emplace_back(value);
return ArgumentParser::Continue::No;
}
std::vector<Script> Scripts;
std::vector<std::string> Components;
cm::optional<std::string> Component;
bool ExcludeFromAll = false;
bool AllComponents = false;
};
@@ -939,7 +933,7 @@ bool HandleScriptMode(std::vector<std::string> const& args,
cmArgumentParser<Arguments>{}
.Bind("SCRIPT"_s, &Arguments::AddScript)
.Bind("CODE"_s, &Arguments::AddScript)
.Bind("COMPONENT"_s, &Arguments::AddComponent)
.Bind("COMPONENT"_s, &Arguments::Component)
.Bind("EXCLUDE_FROM_ALL"_s, &Arguments::ExcludeFromAll)
.Bind("ALL_COMPONENTS"_s, &Arguments::AllComponents);
@@ -949,22 +943,15 @@ bool HandleScriptMode(std::vector<std::string> const& args,
return false;
}
if (arguments.Components.size() > 1) {
status.SetError("given more than one COMPONENT for the SCRIPT or CODE "
"signature of the INSTALL command. "
"Use multiple INSTALL commands with one COMPONENT each.");
return false;
}
if (arguments.AllComponents && !arguments.Components.empty()) {
if (arguments.AllComponents && arguments.Component.has_value()) {
status.SetError("ALL_COMPONENTS and COMPONENT are mutually exclusive");
return false;
}
Helper helper(status);
std::string const component = arguments.Components.empty()
? helper.DefaultComponentName
: arguments.Components.front();
std::string const component = arguments.Component.has_value()
? *arguments.Component
: helper.DefaultComponentName;
for (Arguments::Script& script : arguments.Scripts) {
if (!script.IsCode &&
Tests/RunCMake/install/SCRIPT-CODE-arguments-stderr.txt
-8
View File
@@ -36,14 +36,6 @@ Call Stack \(most recent call first\):
CMakeLists\.txt:[0-9]+ \(include\)
CMake Error at SCRIPT-CODE-arguments\.cmake:[0-9]+ \(install\):
install given more than one COMPONENT for the SCRIPT or CODE signature of
the INSTALL command\. Use multiple INSTALL commands with one COMPONENT
each\.
Call Stack \(most recent call first\):
CMakeLists\.txt:[0-9]+ \(include\)
CMake Error at SCRIPT-CODE-arguments\.cmake:[0-9]+ \(install\):
install ALL_COMPONENTS and COMPONENT are mutually exclusive
Call Stack \(most recent call first\):