Add .clang_format #1542
Add .clang_format #1542
Conversation
There was a problem hiding this comment.
Overall these changes look like a great step forward in terms of Overviewer's overall code quality by making it easier to keep the code readable no matter the number of hands that touch it. I've left two comments requesting some clarifications on some things that stood out to me.
Feel free to tune in as well, @agrif.
| Priority: 1 | ||
| IndentCaseLabels: false | ||
| MaxEmptyLinesToKeep: '1' | ||
| PointerAlignment: Left |
There was a problem hiding this comment.
A lot of code in Overviewer appears to use right-aligned pointers. My C knowledge isn't the best, but I think
int *foo, bar;makes foo an int pointer and bar an int, whereas
int* foo, bar;makes both of them int pointers, correct?
In that case, wouldn't right-aligned pointers be the lesser trap?
Feel free to change my opinion on this, I'm mostly just noticing a lot of foo *bar to foo* bar transformations in this PR which have me a little worried over whether this was 100% intentional.
There was a problem hiding this comment.
Nope, both of those declare foo as a pointer and bar as an int. Yeah, it's pretty bad.
I used to use right-pointers because morally, I think pointerness should be part of the type. But C's syntax is such that right-pointers will get you in to trouble, like the confusion above, so nowadays I try to stick to left-pointers. I think that's a good choice for overviewer.
There was a problem hiding this comment.
So: I think I swapped left and right here... 😄
I meant, the int *foo style is probably more appropriate. I don't know enough about .clang-format to know if that's what's selected here.
There was a problem hiding this comment.
I'm gonna be a vote for left-pointers as defining a mix of ints and int-pointers on the same line is kind of a weird basis for having it all be on the right through-out the codebase. Would rather keep all type and type modifiers next to the type, with the name on its own(static volatile void* pointy).
CounterPillow
requested review from
CounterPillow
and removed request for
CounterPillow
|
Instead of backmerging master, can you rebase on top of it? |
Also applies clang-format to the current code base, using command:
`find . -regex '.*\.\(c\|h\)' -exec clang-format -style=file -i {} \;`
|
Cleaned the commit history up so it's just one |
This is to automate the styling of C code to aid contributors in making pull requests that conform to the existing style and so any future C style decisions can be made to a single file and automatically applied to the whole project.
I configured the
.clang_formatto suite most of the code found through-out the already-existing C code and based on the code review of my previous PRs.More options can be found here
With this any edits to the c code can be automatically formatted by calling
clang-formatorfind . -regex '.*\.\(c\|h\)' -exec clang-format -style=file -i {} \;