[devtools] add clang-format.py #6790

pull MarcoFalke wants to merge 2 commits into bitcoin:master from MarcoFalke:MarcoFalke-2015-clangFormatWrapper changing 2 files +82 −6

MarcoFalke commented at 2:23 PM on October 9, 2015: member

This will add a python convenience wrapper for clang-format. The python code includes a list with tested versions (tested_versions) which can easily be updated in the future.

[ci skip]
jonasschnelli commented at 2:27 PM on October 9, 2015: contributor

Not sure if possible: a script that only clang-formats changed/added code (would require some clever git operations) would be nice.
MarcoFalke commented at 2:29 PM on October 9, 2015: member

@jonasschnelli Not sure if clang-format-diff.py is what you are looking for.
paveljanik commented at 2:08 PM on October 10, 2015: contributor

After looking at the amount of changes clang-format generates and actually looking at such changes and looking at our release process (releasing 0.10, 0.11, ...), I think it doesn't make sense to apply the formatting in one shot for all the source files. It only has sense for formatting new files and (maybe) for very stable files, like primites/* etc.

And as written above, I do not think the wrapper (in fact, -i and "tested" version check) is needed at all.
MarcoFalke commented at 1:12 PM on October 11, 2015: member

@paveljanik I think it doesn't make sense to apply the formatting in one shot for all the source files.

I think we all agree on this.

@paveljanik I do not think the [...] "tested" version check is needed at all.

How would one verify a format PR when different versions produce different output? Also, it may be useful the extend the clang-format.py to skip git subtrees et al. (c.f. https://github.com/sipa/bitcoin/commit/a1261296e48967b3236053d3435a3f521898df2f#diff-6ca10bb3f43dbe234b1fce27929ce0d4R10 ).
laanwj commented at 9:38 AM on October 13, 2015: member

Code review ACK, although I'm not sure I see when this should be used.

Needs mention in contrib/devtools/README.md
sipa commented at 9:43 AM on October 13, 2015: member

Earlier reasons to not use clang-format was that its output changed, even between several "versions" of clang-format-3.5. I wonder whether a solution could be to include a small snippet of representative unformatted code, and have the wrapper script check whether it results in the expected output?
paveljanik commented at 1:39 PM on October 13, 2015: contributor

It should definitely be used when committing new files...
MarcoFalke force-pushed on Oct 15, 2015
MarcoFalke force-pushed on Oct 15, 2015
[devtools] add clang-format.py 338f62f701
MarcoFalke force-pushed on Oct 15, 2015
MarcoFalke force-pushed on Oct 15, 2015
[trivial] Update contrib/devtools/README.md 8c15f33d15
MarcoFalke force-pushed on Oct 15, 2015
MarcoFalke commented at 10:28 AM on October 16, 2015: member

@laanwj Done. @sipa I have tested 3.6.{0,1,2} and they all produce the same output, so I have added them to tested_versions.
laanwj added the label Dev Scripts on Oct 23, 2015
laanwj commented at 8:41 AM on October 23, 2015: member

I wonder whether a solution could be to include a small snippet of representative unformatted code, and have the wrapper script check whether it results in the expected output?

I like this idea a lot.
laanwj merged this on Oct 23, 2015
laanwj closed this on Oct 23, 2015
laanwj referenced this in commit fa1d252e82 on Oct 23, 2015
MarcoFalke deleted the branch on Oct 23, 2015
MarcoFalke locked this on Sep 8, 2021

Contributors

Labels