Dealing with SVN keyword expansion with git-svn

by

What’s going on here: Git is optimized to switch between branches as quickly as possible. In particular, git checkout is designed to not touch any files that are identical in both branches.

Unfortunately, RCS keyword substitution breaks this. For example, using $Date$ would require git checkout to touch every file in the tree when switching branches. For a repository the size of the Linux kernel, this would bring everything to a screeching halt.

In general, your best bet is to tag at least one version:

$ git tag v0.5.whatever

…and then call the following command from your Makefile:

$ git describe --tags
v0.5.15.1-6-g61cde1d

Here, git is telling me that I’m working on an anonymous version 6 commits past v0.5.15.1, with an SHA1 hash beginning with g61cde1d. If you stick the output of this command into a *.h file somewhere, you’re in business, and will have no problem linking the released software back to the source code. This is the preferred way of doing things.

If you can’t possibly avoid using RCS keywords, you may want to start with this explanation by Lars Hjemli. Basically, $Id$ is pretty easy, and you if you’re using git archive, you can also use $Format$.

But, if you absolutely cannot avoid RCS keywords, the following should get you started:

git config filter.rcs-keyword.clean 'perl -pe "s/\\\$Date[^\\\$]*\\\$/\\\$Date\\\$/"'
git config filter.rcs-keyword.smudge 'perl -pe "s/\\\$Date[^\\\$]*\\\$/\\\$Date: `date`\\\$/"'

echo '$Date$' > test.html
echo 'test.html filter=rcs-keyword' >> .gitattributes
git add test.html .gitattributes
git commit -m "Experimental RCS keyword support for git"

rm test.html
git checkout test.html
cat test.html

On my system, I get:

$Date: Tue Sep 16 10:15:02 EDT 2008$

If you have trouble getting the shell escapes in the smudge and clean commands to work, just write your own Perl scripts for expanding and removing RCS keywords, respectively, and use those scripts as your filter.

Note that you really don’t want to do this for more files than absolutely necessary, or git will lose most of its speed.

More Related Contents:

  1. How do I migrate an SVN repository with history to a new Git repository?
  2. How and/or why is merging in Git better than in SVN?
  3. How does Git solve the merging problem? [closed]
  4. Why is branching and merging easier in Mercurial than in Subversion?
  5. Why should I use version control? [closed]
  6. How do you deal with configuration files in source control?
  7. To put the prefix ? to codes by Git/SVN
  8. What are the relative strengths and weaknesses of Git, Mercurial, and Bazaar? [closed]
  9. Can we finally move to DVCS in Corporate Software? Is SVN still a ‘must have’ for development? [closed]
  10. What makes merging in DVCS easy?
  11. What makes some version control systems better at merging?
  12. Handling renames: svn vs. git vs. mercurial
  13. Pushing an existing Git repository to SVN
  14. Why are git submodules incompatible with svn externals?
  15. Should I use SVN or Git? [closed]
  16. Do I really need version control? [closed]
  17. How to have ‘git log’ show filenames like ‘svn log -v’
  18. Is git-svn dcommit after merging in git dangerous?
  19. Common Types of Subversion Hooks
  20. Are subversion externals an antipattern?
  21. Externalising SCM credentials with Maven
  22. How to attribute a single commit to multiple developers?
  23. How to use SVN, Branch? Tag? Trunk? [closed]
  24. Getting started with Version Control System
  25. How to import svn branches and tags into git-svn?
  26. Delete file with all history from svn repository
  27. How can I force subversion to commit an unchanged file?
  28. Should I store all projects in one repository or multiple?
  29. How would you organize a Subversion repository for in house software projects?
  30. How to synchronize two Subversion repositories?

Leave a Comment