summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Neundorf <neundorf@kde.org>2010-05-08 07:27:48 (GMT)
committerAlex Neundorf <neundorf@kde.org>2010-05-08 07:27:48 (GMT)
commitd1b3ceb88c3fd37441fa504059f4b3bd84a0c322 (patch)
tree2a9efd838df0d998623780b0da18b43949c5be52
parent555b8fcab50ebbf17b46dbbb8722a5f1d0d3567f (diff)
downloadCMake-d1b3ceb88c3fd37441fa504059f4b3bd84a0c322.zip
CMake-d1b3ceb88c3fd37441fa504059f4b3bd84a0c322.tar.gz
CMake-d1b3ceb88c3fd37441fa504059f4b3bd84a0c322.tar.bz2
-minor doc fixes
Use <VAR> instead of VarName in get_filename_component (as is used in most other command documentations), and fix the name of the generated project in include_external_msproject(#9743, the comment there seems to be correct: http://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=3d1c12b802c3dd3a0284f5f10aec3b98ab6d3a78#patch9 ) Alex
-rw-r--r--Source/cmGetFilenameComponentCommand.h12
-rw-r--r--Source/cmIncludeExternalMSProjectCommand.h5
2 files changed, 8 insertions, 9 deletions
diff --git a/Source/cmGetFilenameComponentCommand.h b/Source/cmGetFilenameComponentCommand.h
index c85b296..aff4d7e 100644
--- a/Source/cmGetFilenameComponentCommand.h
+++ b/Source/cmGetFilenameComponentCommand.h
@@ -62,10 +62,10 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " get_filename_component(VarName FileName\n"
+ " get_filename_component(<VAR> FileName\n"
" PATH|ABSOLUTE|NAME|EXT|NAME_WE|REALPATH\n"
" [CACHE])\n"
- "Set VarName to be the path (PATH), file name (NAME), file "
+ "Set <VAR> to be the path (PATH), file name (NAME), file "
"extension (EXT), file name without extension (NAME_WE) of FileName, "
"the full path (ABSOLUTE), or the full path with all symlinks "
"resolved (REALPATH). "
@@ -73,14 +73,14 @@ public:
"trailing slashes. The longest file extension is always considered. "
"If the optional CACHE argument is specified, the result variable is "
"added to the cache.\n"
- " get_filename_component(VarName FileName\n"
- " PROGRAM [PROGRAM_ARGS ArgVar]\n"
+ " get_filename_component(<VAR> FileName\n"
+ " PROGRAM [PROGRAM_ARGS <ARG_VAR>]\n"
" [CACHE])\n"
"The program in FileName will be found in the system search path or "
"left as a full path. If PROGRAM_ARGS is present with PROGRAM, then "
"any command-line arguments present in the FileName string are split "
- "from the program name and stored in ArgVar. This is used to separate "
- "a program name from its arguments in a command line string.";
+ "from the program name and stored in <ARG_VAR>. This is used to "
+ "separate a program name from its arguments in a command line string.";
}
cmTypeMacro(cmGetFilenameComponentCommand, cmCommand);
diff --git a/Source/cmIncludeExternalMSProjectCommand.h b/Source/cmIncludeExternalMSProjectCommand.h
index d14d564..5269041 100644
--- a/Source/cmIncludeExternalMSProjectCommand.h
+++ b/Source/cmIncludeExternalMSProjectCommand.h
@@ -62,9 +62,8 @@ public:
" dep1 dep2 ...)\n"
"Includes an external Microsoft project in the generated workspace "
"file. Currently does nothing on UNIX. This will create a "
- "target named INCLUDE_EXTERNAL_MSPROJECT_[projectname]. This can "
- "be used in the add_dependencies command to make things depend "
- "on the external project.";
+ "target named [projectname]. This can be used in the add_dependencies "
+ "command to make things depend on the external project.";
}
cmTypeMacro(cmIncludeExternalMSProjectCommand, cmCommand);