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/cmDocumentation.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/cmDocumentation.cxx')
| -rw-r--r-- | Source/cmDocumentation.cxx | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index 81e6796..4e8bcb5 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -94,12 +94,14 @@ cmDocumentation::~cmDocumentation() //---------------------------------------------------------------------------- bool cmDocumentation::PrintVersion(std::ostream& os) { + /* clang-format off */ os << this->GetNameString() << " version " << cmVersion::GetCMakeVersion() << "\n" "\n" "CMake suite maintained and supported by Kitware (kitware.com/cmake).\n" ; + /* clang-format on */ return true; } @@ -935,6 +937,7 @@ bool cmDocumentation::PrintOldCustomModules(std::ostream& os) } else if((ext.length()==2) && (ext[1] >='1') && (ext[1]<='9')) { + /* clang-format off */ os << ".TH " << name << " " << ext[1] << " \"" << cmSystemTools::GetCurrentDateTime("%B %d, %Y") << @@ -947,6 +950,7 @@ bool cmDocumentation::PrintOldCustomModules(std::ostream& os) ".PP\n" << detail ; + /* clang-format on */ } else { |