Build: devel: Replace indent with clang-format. #3824
Conversation
The indent tool has fallen out of favor with a lot of developers, while clang-format seems to be growing in popularity. We're not enforcing the usage of any style tool because they never get everything 100% right, and I'm not really sure anyone ever actually uses this target - I know I never have. However, this at least updates it to be something more modern should anyone want to use it. To generate this config, I dumped the default GNU coding style (clang-format -style=gnu -dump-config), removed anything that wasn't related to regular old C, and then went through every config option and checked to make sure it was close to our existing style. I'm sure something incorrect has snuck through.
clumens
force-pushed
the
clang-format
branch
from
f8e2d1d to
c8ea0e8
Compare
|
Updated .clang-format to not reformat doxygen comment blocks. |
|
@waltdisgrace Can you take a look at this? Thanks. |
| --- | ||
| Language: Cpp | ||
| BasedOnStyle: GNU | ||
| AccessModifierOffset: -2 |
There was a problem hiding this comment.
This one is C++-specific AFAICT
| BasedOnStyle: GNU | ||
| AccessModifierOffset: -2 | ||
| AlignAfterOpenBracket: Align | ||
| AlignArrayOfStructures: None |
There was a problem hiding this comment.
If it matters, some of these options require particular minimum clang-format versions. For example, this one requires clang-format 13. The stakes are low, of course. Worst case scenario, this little-used developer make target breaks. Wouldn't hurt to have a note in INSTALL.md or a comment in this file or the Makefile about the minimum version.
There was a problem hiding this comment.
Yes, that's true. In #3829, I brought up the fact that cppcheck changes what it can find and what needs to be suppressed over time too. I'm not sure if we've ever had any guidelines on what versions of these tools we're using and supporting. Given that it's all developer stuff, I lean towards not worrying about it too much. I expect that we're all using fairly modern stuff.
| AlignAfterOpenBracket: Align | ||
| AlignArrayOfStructures: None | ||
| AlignConsecutiveAssignments: | ||
| Enabled: false |
There was a problem hiding this comment.
Enabled: false covers all of these. Probably ditto for other option sets.
The indent tool has fallen out of favor with a lot of developers, while clang-format seems to be growing in popularity. We're not enforcing the usage of any style tool because they never get everything 100% right, and I'm not really sure anyone ever actually uses this target - I know I never have.
However, this at least updates it to be something more modern should anyone want to use it. To generate this config, I dumped the default GNU coding style (clang-format -style=gnu -dump-config), removed anything that wasn't related to regular old C, and then went through every config option and checked to make sure it was close to our existing style. I'm sure something incorrect has snuck through.