Re: [FR-devel] Standard source code header.

[Laurent Julliard]

Horacio Lopez wrote:

> ----- Original Message ----- 
> From: "Laurent Julliard" <address@hidden>
> To: "FreeRIDE Developers" <address@hidden>
> Sent: Thursday, January 31, 2002 8:00 AM
> Subject: [FR-devel] Standard source code header.
>
>
>
> > Before we embark into too much coding I think it would be great if we 
> > all adopt a standard introductory header for all the FR source files 
> > (not the 3rd party modules or extensions).
> >
> > So let's see here is my first cut at it:
> >
> >
> > # Purpose: what this file is all about (2-3 lines maximum)
> > # ....
> > # $Id$   (<- CVS standard header for version number and date)
> > #
> > # Written by:  Author's name  <email>
> > # Created: Month Year
> > #
> > # This file is part of the FreeRIDE project
> > #
> > # This application is free software; you can redistribute it and/or
> > # modify it under the terms of the Ruby license defined in the
> > # COPYING file.
> > #
>
> Maybe we could add a link to the CVSWeb, that would
> be a good substitute for the changelog.


I'm a bit reluctant to include any kind of link to a location that is 
subject to change. if one day we migrate our CVS tree elsewhere or even 
Savannah changes the way it references change logs of a given file then 
we must go through all the headers and modify them. Tedious...

I had the same doubt with referencing people's email in the header 
because email addresses tend to change as well so may be email could be 
optional.

Laurent


--
Laurent JULLIARD - Xerox R&T/XAC/XPA - Open Source team
>> Host your Xerox Software project on CodeX: http://codex.xerox.com
>> address@hidden community: http://xww.linux.world.xerox.com