Commit e2b1f058 authored by Matt McCormick's avatar Matt McCormick Committed by Brad King

try_run: Add support for LINK_LIBRARIES option.

Most functionality is already implemented in Source/cmCoreTryCompile.{h,cxx}.
Document and improve argument parsing.

This functionality is already being used by a number of modules, like
CheckCSourceCompiles.cmake, but it is not documented.
parent 07cbe364
......@@ -6,8 +6,9 @@ Try compiling and then running some code.
::
try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR
bindir srcfile [CMAKE_FLAGS <Flags>]
bindir srcfile [CMAKE_FLAGS <flags>]
[COMPILE_DEFINITIONS <flags>]
[LINK_LIBRARIES <libs>]
[COMPILE_OUTPUT_VARIABLE comp]
[RUN_OUTPUT_VARIABLE run]
[OUTPUT_VARIABLE var]
......@@ -22,6 +23,12 @@ where the output from the compile step goes. RUN_OUTPUT_VARIABLE
specifies the variable where the output from the running executable
goes.
The srcfile signature also accepts a LINK_LIBRARIES argument which may
contain a list of libraries or IMPORTED targets which will be linked
to in the generated project. If LINK_LIBRARIES is specified as a
parameter to try_run, then any LINK_LIBRARIES passed as
CMAKE_FLAGS will be ignored.
For compatibility reasons OUTPUT_VARIABLE is still supported, which
gives you the output from the compile and run step combined.
......
try-run-link-libraries
----------------------
* The :command:`try_run` command learned to honor the ``LINK_LIBRARIES``
option just as :command:`try_compile` already does.
......@@ -109,7 +109,7 @@ int cmCoreTryCompile::TryCompileCode(std::vector<std::string> const& argv)
}
default:
this->Makefile->IssueMessage(cmake::FATAL_ERROR,
"Only libraries may be used as try_compile IMPORTED "
"Only libraries may be used as try_compile or try_run IMPORTED "
"LINK_LIBRARIES. Got " + std::string(tgt->GetName()) + " of "
"type " + tgt->GetTargetTypeName(tgt->GetType()) + ".");
return -1;
......
......@@ -48,7 +48,8 @@ bool cmTryRunCommand
{
++i;
while (i < argv.size() && argv[i] != "COMPILE_DEFINITIONS" &&
argv[i] != "CMAKE_FLAGS")
argv[i] != "CMAKE_FLAGS" &&
argv[i] != "LINK_LIBRARIES")
{
runArgs += " ";
runArgs += argv[i];
......
CMake Error at BadLinkLibraries.cmake:2 \(try_compile\):
Only libraries may be used as try_compile IMPORTED LINK_LIBRARIES. Got
not_a_library of type UTILITY.
Only libraries may be used as try_compile or try_run IMPORTED
LINK_LIBRARIES. Got not_a_library of type UTILITY.
Call Stack \(most recent call first\):
CMakeLists.txt:3 \(include\)
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment