[development] version = "$Name$" considered harmful in .info files
drupal at dwwright.net
Wed Jun 13 22:29:18 UTC 2007
It was easy to miss this in my last message to the "Announcing
cvs_deploy.module" thread, so I'm starting a new one...
The only reason we ever recommended people add:
version = "$Name$"
to the .info files they checked into CVS was for the convenience of
the power-users who deploy from CVS. These people should just use
the new cvs_deploy.module instead.
This line has caused lots of trouble and confusion for lots of
people. I'm sorry I ever suggested it, and wish I had just written
and released the cvs_deploy.module right when we were adding the
version information to the modules page in D5. Oh well, live and
I've edited the 4.7.x -> 5.x upgrade docs and the handbook page
about writing .info files to reflect the new best practice:
> version (Optional)
> The version string will ordinarily be added by drupal.org when a
> release is created and a tarball packaged. However, if your module
> is not being hosted on the drupal.org infrastructure, you can give
> your module whatever version string makes sense.
> Users getting their modules directly from CVS will not have a
> version string, since the .info files checked into CVS do not
> define a version. These users are encouraged to use the CVS deploy
>  module to provide accurate version strings for the admin/build/
> modules page for modules in directories checked out directly from CVS.
> In the past (before the CVS deploy module existed), it was
> recommended to use this:
> version = "$Name$"
> However, this led to much confusion and is no longer recommended.
> If you are a module developer, and you already have the above line
> in your .info files checked into the Drupal CVS repository, you
> should remove that line.
Please let me know if you have any questions or complaints.
More information about the development