style cleanup that doesn't trample svn blame?

Question

I'd like to use Eclipse's formatter to fix some poorly styled code, but there's a huge downside to killing all the metadata in the repository about who is responsible for what. Any thoughts on ways to get around this? Perhaps it is just completely impossible...

Modal

Answer 1

You can tell blame to ignore whitespace changes:

svn blame -x -w file/path

Of course that only works if your style fix doesn't change more than whitespaces.

Euchre

This looks great but it doesn't work for me. What's the magic? What client and platform are you currently using? – Catacomb

Tortoise svn ignores whitespace changes per default (there is a checkbox to change this). – Insessorial

If you want it to also ignore changes in newlines (CRLF vs. LF), use svn blame -x -w -x --ignore-eol-style. See svn help blame and this question. – Ramage

Answer 2

The history is still there, you'll just have to look at a blame prior to the cleanup revision.

This is one good reason to have a style standard. Indentation changes can cause a lot of merge conflicts, etc. "Poorly styled" to one is well written to another.

Apeak

sadly, there's a large base of poorly styled code to start. I guess one pain point is that eclipse annotations only show the most recent change. And people use them a fair amount. – Modal

Answer 3

When reformatting code, I usually only fix the indentation. There are just too many cases where the automatic formatter ruins a carefully hand-formatted section.

Chopfallen

Answer 4

Another solution would be to add a pre-commit hook that compare the committed file with its formatted version. If there is no difference, the commit is accepted.

Otherwise, a simple message "Code not formatted : commit rejected" would inform your developers to style their modified files prior to commit.

Combined with the Stefan's answer, you still can use blame with -w option and moreover, you do not override the developer's names.

One drawback is that you won't be able to style your whole repository is one pass. Files will be styled as they are modified. Often used files will be quickly styled whereas some might never been updated.

Amaryllidaceous