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

BUG: Fixed man page formatting for INSTALL command documentation. Fixed line-too-long warning.

This commit is contained in:
Brad King 2006-08-22 10:38:10 -04:00
parent c9eaf72567
commit 211e991057
2 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Source/cmDocumentation.cxx
View File

@ -840,13 +840,17 @@ void cmDocumentation::PrintParagraphHTML(std::ostream& os, const char* text)
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
void cmDocumentation::PrintPreformattedMan(std::ostream& os, const char* text) void cmDocumentation::PrintPreformattedMan(std::ostream& os, const char* text)
{ {
os << text << "\n"; std::string man_text = text;
cmSystemTools::ReplaceString(man_text, "\\", "\\\\");
os << man_text << "\n";
} }
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
void cmDocumentation::PrintParagraphMan(std::ostream& os, const char* text) void cmDocumentation::PrintParagraphMan(std::ostream& os, const char* text)
{ {
os << text << "\n\n"; std::string man_text = text;
cmSystemTools::ReplaceString(man_text, "\\", "\\\\");
os << man_text << "\n\n";
} }
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------

26
Source/cmInstallCommand.h
View File

@ -95,12 +95,13 @@ public:
"when a single file is installed by the command. " "when a single file is installed by the command. "
"\n" "\n"
"The TARGETS signature:\n" "The TARGETS signature:\n"
" INSTALL(TARGETS targets... [[ARCHIVE|LIBRARY|RUNTIME]\n" " INSTALL(TARGETS targets...\n"
" [DESTINATION <dir>]\n" " [[ARCHIVE|LIBRARY|RUNTIME]\n"
" [PERMISSIONS permissions...]\n" " [DESTINATION <dir>]\n"
" [CONFIGURATIONS [Debug|Release|...]]\n" " [PERMISSIONS permissions...]\n"
" [COMPONENT <component>]\n" " [CONFIGURATIONS [Debug|Release|...]]\n"
" ] [...])\n" " [COMPONENT <component>]\n"
" ] [...])\n"
"The TARGETS form specifies rules for installing targets from a " "The TARGETS form specifies rules for installing targets from a "
"project. There are three kinds of target files that may be " "project. There are three kinds of target files that may be "
"installed: archive, library, and runtime. " "installed: archive, library, and runtime. "
@ -194,15 +195,16 @@ public:
"expression to match directories or files encountered during traversal " "expression to match directories or files encountered during traversal "
"of an input directory. The full path to an input file or directory " "of an input directory. The full path to an input file or directory "
"(with forward slashes) is matched against the expression. " "(with forward slashes) is matched against the expression. "
"A PATTERN will match only complete file names: the portion of the full " "A PATTERN will match only complete file names: the portion of the "
"path matching the pattern must occur at the end of the file name and " "full path matching the pattern must occur at the end of the file name "
"be preceded by a slash. " "and be preceded by a slash. "
"A REGEX will match any portion of the full path but it may use " "A REGEX will match any portion of the full path but it may use "
"'/' and '$' to simulate the PATTERN behavior. " "'/' and '$' to simulate the PATTERN behavior. "
"Options following one of these matching expressions " "Options following one of these matching expressions "
"are applied only to files or directories matching them. The EXCLUDE " "are applied only to files or directories matching them. "
"option will skip the matched file or directory. The PERMISSIONS " "The EXCLUDE option will skip the matched file or directory. "
"option overrides the permissions setting for the matched file. " "The PERMISSIONS option overrides the permissions setting for the "
"matched file or directory. "
"For example the code\n" "For example the code\n"
" INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj\n" " INSTALL(DIRECTORY icons scripts/ DESTINATION share/myproj\n"
" PATTERN \"CVS\" EXCLUDE\n" " PATTERN \"CVS\" EXCLUDE\n"