diff options
author | Brad King <brad.king@kitware.com> | 2016-05-06 18:19:04 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2016-05-06 18:25:55 (GMT) |
commit | 64b5520346c75ec479042a114390a0bf71909723 (patch) | |
tree | bea1373e84594ba036fe50eea3eab86375d63aa6 /Source/cmcmd.cxx | |
parent | 73601ff831faa80a188e5997ee048b6986b00a5c (diff) | |
download | CMake-64b5520346c75ec479042a114390a0bf71909723.zip CMake-64b5520346c75ec479042a114390a0bf71909723.tar.gz CMake-64b5520346c75ec479042a114390a0bf71909723.tar.bz2 |
Isolate formatted streaming blocks with clang-format off/on
The clang-format tool can do a good job formatting most code, but
well-organized streaming blocks are best left manually formatted.
Find blocks of the form
os <<
"...\n"
"...\n"
;
using the command
$ git ls-files -z -- Source |
egrep -v -z '^Source/kwsys/' |
xargs -0 pcregrep -M --color=always -B 1 -A 1 -n \
'<<[^\n]*\n(^ *("[^\n]*("|<<|;)$|;)\n){2,}'
Find blocks of the form
os << "...\n"
<< "...\n"
<< "...\n";
using the command
$ git ls-files -z -- Source |
egrep -v -z '^Source/kwsys/' |
xargs -0 pcregrep -M --color=always -B 1 -A 1 -n \
'<<[^\n]*\n(^ *<<[^\n]*(\\n"|<<|;)$\n){2,}'
Surround such blocks with the pair
/* clang-format off */
...
/* clang-format on */
in order to protect them from update by clang-format. Use the C-style
`/*...*/` comments instead of C++-style `//...` comments in order to
prevent them from ever being swallowed by re-formatting of surrounding
comments.
Diffstat (limited to 'Source/cmcmd.cxx')
-rw-r--r-- | Source/cmcmd.cxx | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/Source/cmcmd.cxx b/Source/cmcmd.cxx index 01b12a3..79e1bf0 100644 --- a/Source/cmcmd.cxx +++ b/Source/cmcmd.cxx @@ -44,14 +44,19 @@ void CMakeCommandUsage(const char* program) std::ostringstream errorStream; #ifdef CMAKE_BUILD_WITH_CMAKE + /* clang-format off */ errorStream << "cmake version " << cmVersion::GetCMakeVersion() << "\n"; + /* clang-format on */ #else + /* clang-format off */ errorStream << "cmake bootstrap\n"; + /* clang-format on */ #endif // If you add new commands, change here, // and in cmakemain.cxx in the options table + /* clang-format off */ errorStream << "Usage: " << program << " -E <command> [arguments...]\n" << "Available commands: \n" @@ -95,6 +100,7 @@ void CMakeCommandUsage(const char* program) << " create_symlink old new - create a symbolic link new -> old\n" #endif ; + /* clang-format on */ cmSystemTools::Error(errorStream.str().c_str()); } |