Setting the $Id$ Tag in Subversion [StartupCTO]

Last Updated: 01 Oct 2025

|

Author: 57.141.6.58

Page locked

This page is currently locked for editing by another user. You have to wait until this user finishes editing or the lock expires.

Currently locked by: 183.232.253.46
Lock expires at: Dec 5, 2025 08:50 AM (231 min)

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

= Setting the $Id$ Tag in Subversion =

CVS will automatically set an ''$Id$'' tag in each file; it looks something like this:
<code>$Id: test.php 110 2009-04-28 05:20:41Z dordal $</code>

This is super-helpful for two reasons:
 * it lets you know at a glance what revision of a file you're working with, and who last worked on it
 * if you export your code (say as part of a deployment process), it lets others know what revision of a file they have

Subversion, by default, doesn't add these tags. However, you can configure it to set the tag when you checkin a file. 

**Note that this configuration has to be done //client side//; unfortunately you [[http://subversion.tigris.org/issues/show_bug.cgi?id=1974|can't set this on the svn server for all clients]].** If you have multiple developers, you'll need to be pretty strict about making sure they all go through this procedure.

== Configure subversion to automatically add the $Id: $ tag ==

First, update your ''~/.subversion/config'' with the following info:
<code>
[miscellany]
enable-auto-props = yes

[auto-props]
*.php = svn:keywords=Id
*.js = svn:keywords=Id
</code>

**NOTE:** You may want to add additional file types to the list above. As it stands, it will only set $Id: $ tags for ''*.php'' and ''*.js''.

== Set props on existing files ==

That configuration will automatically apply the ''svn:keywords'' property (which sets the ''$Id$'' tag) to all //new// files. But what about existing files? For these, you'll have to set the property manually. Go to the root of your source tree, and run this command:
<code>
find . \( -name "*.php" -o -name "*.js" \) -exec svn propset svn:keywords Id {} \;
</code>

''find'' will return a list of all ''.php'' and ''.js'' files, and then run ''svn propset'' on them to set the appropriate ''svn:keywords'' property. Now, all files have the property set, and will automatically set the ''$Id$'' tag on checkin.

== Add the $Id$ tag to each file ==

Finally, go through each file and add the prototype $Id$ tag. I like to do this in the comments at the header of each file, e.g.:
<code php>
/*
 * @author David Ordal, david -at- ordal.com
 * @version $Id$
 *
 */
</code>

When you checkin the file, you'll see it expand to:
<code php>
/*
 * @author David Ordal, david -at- ordal.com
 * @version $Id: test.php 110 2009-04-28 05:20:41Z dordal $
 *
 */
</code>

That's it!

Page locked

About Me

Recent Changes

Get In Touch

Follow