+1, I don't think this buys us anything anymore and clearly causes grief for some folks.

We have a fair bit of boilerplate that looks something like this:
__revision__  = "$Revision: 7665 $"
__date__      = "$Date: 2005-10-06 13:33:04 -0700 (Thu, 06 Oct 2005) $"
__copyright__ = "Copyright (c) 2003-2004 Open Source Applications Foundation"
__license__   = "http://osafoundation.org/Chandler_0.1_license_terms.htm";
__parcel__ = "osaf.pim"

And indeed, its written up in our coding guidelines:
http://wiki.osafoundation.org/bin/view/Projects/ChandlerCodingStyleGuidelines

A year ago, Heikki asked that we move the copyright, license and revision to comments, and that we remove the date variable altogether:
http://lists.osafoundation.org/pipermail/dev/2004-August/001684.html

Perhaps we should:
(1) not include $Date$ and $Revision$ in new files
(2) include copyright and license info in comments

    """
    @copyright: Copyright (c) 2004 Open Source Applications Foundation
    @license: U{http://osafoundation.org/Chandler_0.1_license_terms.htm}
    """

(3) update the guidelines
(4) do a pass to clean up existing files

Cheers,
Katie

Ted Leung wrote:
I think that in the CVS era, the $Revision lines were useful since files had their own revision numbers. Since we are using subversion and all files have the same revision number, the $Revision tag seems less useful, since it's much easier to determine which version of a file someone has out in the field.

If we were back in the CVS days, I'd prefer to keep them. One more reason to be glad we left that behind.

+1

Ted

On Oct 28, 2005, at 4:57 PM, Heikki Toivonen wrote:

Alec Flett wrote:

So at the top of many of our source files, we have a line like:
@version:   $Revision: 8121 $
(or sometimes we use __version__ =...)

This drives me NUTS because every time I check in a file, I have to then reload the file into my editor because it changes on disk as a result of
the checkin. I can't imagine I'm the only one with this issue.

Is anyone emotionally tied to the $Revision$ lines?  Would anyone  mind
if I nuked them?


+1

I have mostly worked around this issue by changing my editor  settings to
reload files automatically, but that is not ideal either as I  sometimes
don't want that to happen.

All of the auto updated things cause havoc with diffs and merges every
now and then (SVN is better than CVS most of the time).

We currently seem to be using __version__ in at least the file
application/Utility.py (don't know of other places).

--
  Heikki Toivonen

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

Open Source Applications Foundation "Dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/dev


----
Ted Leung                 Open Source Applications Foundation (OSAF)
PGP Fingerprint: 1003 7870 251F FA71 A59A  CEE3 BEBA 2B87 F5FC 4B42


_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

Open Source Applications Foundation "Dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/dev

_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _

Open Source Applications Foundation "Dev" mailing list
http://lists.osafoundation.org/mailman/listinfo/dev

Reply via email to