kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

STYLE: extend documentation for RETURN() a bit 

ENH: add a test for calling RETURN() in an included file

Alex
This commit is contained in:
Alexander Neundorf 2008-08-16 18:06:17 -04:00
parent bf4b0bfdd7
commit 814b368725
3 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Source/cmReturnCommand.h
View File

@ -57,7 +57,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return "Return from a directory or function."; return "Return from a file, directory or function.";
} }
/** /**
@ -67,10 +67,14 @@ public:
{ {
return return
" return()\n" " return()\n"
"Returns from a directory or function. When this command is " "Returns from a file, directory or function. When this command is "
"encountered, it caused process of the current function or " "encountered in an included file (via include() or find_package()), "
"directory to stop and control is return to the caller of the " "it causes processing of the current file to stop and control is "
"function, or the parent directory if any. Note that a macro " "returned to the including file. If it is encountered in a file which "
"is not included by another file, e.g. a CMakeLists.txt, control is "
"returned to the parent directory if there is one. "
"If return is called in a function, control is returned to the caller "
"of the function. Note that a macro "
"is not a function and does not handle return like a function does."; "is not a function and does not handle return like a function does.";
} }

8
Tests/ReturnTest/CMakeLists.txt
View File

@ -84,6 +84,14 @@ else ("${subdirResult}" EQUAL 1)
failed ("subdir got: ${subdirResult}") failed ("subdir got: ${subdirResult}")
endif ("${subdirResult}" EQUAL 1) endif ("${subdirResult}" EQUAL 1)
# check return from a file
include(include_return.cmake)
if ("${include_returnResult}" EQUAL 1)
pass ("include_return")
else ("${include_returnResult}" EQUAL 1)
failed ("include_return got: ${include_returnResult}")
endif ("${include_returnResult}" EQUAL 1)
# check return from within a macro # check return from within a macro
macro (mymacro) macro (mymacro)
set (foo 1) set (foo 1)

3
Tests/ReturnTest/include_return.cmake Normal file
View File

@ -0,0 +1,3 @@
set(include_returnResult 1)
return()
set(include_returnResult 0)