Question

I have a source code of about 500 files in about 10 directories. I need to refactor the directory structure – this includes changing the directory hierarchy or renaming some directories.

I am using svn version control. There are two ways to refactor: one preserving svn history (using svn move command) and the other without preserving. I think refactoring preserving svn history is a lot easier using eclipse CDT and SVN plugin (visual studio does not fit at all for directory restructuring).

But right now since the code is not released, we have the option to not preserve history.

Still there remains the task of changing the include directives of header files wherever they are included. I am thinking of writing a small script using python – receives a map from current filename to new filename, and makes the rename wherever needed (using something like sed). Has anyone done this kind of directory refactoring? Do you know of good related tools?

Answer 1

If you’re having to rewrite the #includes to do this, you did it wrong. Change all your #includes to use a very simple directory structure, at mot two levels deep and only using a second level to organize around architecture or OS dependencies (like sys/types.h).

Then change your make files to use -I include paths.

Voila. You’ll never have to hack the code again for this, and compiles will blow up instantly if something goes wrong.

As far as the history part, I personally find it easier to make a clean start when doing this sort of thing; archive the old one, make a new repository v2, go from there. The counterargument is when there is a whole lot of history of changes, or lots of open issues against the existing code.

Oh, and you do have good tests, and you’re not doing this with a release coming right up, right?