is there a standard for putting the name of a source file in the file?

is there a standard for putting the name of a source file in the file?

[Robert P. J. Day]

  as i'm working my way thru the lib/ routines in barebox, i notice
that some source files there, like getopt.c, conveniently have the
filename right at the top:

/*
 * getopt.c - a simple getopt(3) implementation. See getopt.h for explanation.
...

i really like this habit as it makes it easy to send a file to the
printer and not forget what the file was.

  however, most of the files in lib/ don't have that.  as i work my
way through the files, i'd be happy to add something like that to each
file, and submit the changes all as one patch.  is there a standard?
from what i can see, there's quite the variety in how people add that
to a source file.

  i'm open to guidance and i can take it from there.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: is there a standard for putting the name of a source file in the file?

[Jean-Christophe PLAGNIOL-VILLARD]

On 08:48 Sun 18 Nov     , Robert P. J. Day wrote:
> 
>   as i'm working my way thru the lib/ routines in barebox, i notice
> that some source files there, like getopt.c, conveniently have the
> filename right at the top:
> 
> /*
>  * getopt.c - a simple getopt(3) implementation. See getopt.h for explanation.
> ...
> 
> i really like this habit as it makes it easy to send a file to the
> printer and not forget what the file was.
> 
>   however, most of the files in lib/ don't have that.  as i work my
> way through the files, i'd be happy to add something like that to each
> file, and submit the changes all as one patch.  is there a standard?
> from what i can see, there's quite the variety in how people add that
> to a source file.
> 
>   i'm open to guidance and i can take it from there.
no this is a pain in the ass to maintian when we move file

I' drop it and I'm against it

Best Regards,
J.
> 
> rday
> 
> -- 
> 
> ========================================================================
> Robert P. J. Day                                 Ottawa, Ontario, CANADA
>                         http://crashcourse.ca
> 
> Twitter:                                       http://twitter.com/rpjday
> LinkedIn:                               http://ca.linkedin.com/in/rpjday
> ========================================================================
> 
> _______________________________________________
> barebox mailing list
> barebox@lists.infradead.org
> http://lists.infradead.org/mailman/listinfo/barebox

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: is there a standard for putting the name of a source file in the file?

[Robert P. J. Day]

On Sun, 18 Nov 2012, Jean-Christophe PLAGNIOL-VILLARD wrote:

> On 08:48 Sun 18 Nov     , Robert P. J. Day wrote:
> >
> >   as i'm working my way thru the lib/ routines in barebox, i notice
> > that some source files there, like getopt.c, conveniently have the
> > filename right at the top:
> >
> > /*
> >  * getopt.c - a simple getopt(3) implementation. See getopt.h for explanation.
> > ...
> >
> > i really like this habit as it makes it easy to send a file to the
> > printer and not forget what the file was.
> >
> >   however, most of the files in lib/ don't have that.  as i work my
> > way through the files, i'd be happy to add something like that to each
> > file, and submit the changes all as one patch.  is there a standard?
> > from what i can see, there's quite the variety in how people add that
> > to a source file.
> >
> >   i'm open to guidance and i can take it from there.
> no this is a pain in the ass to maintian when we move file
>
> I' drop it and I'm against it

  ok, that logic makes sense, i'm good with that.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: is there a standard for putting the name of a source file in the file?

[Sascha Hauer]

On Sun, Nov 18, 2012 at 11:39:48AM -0500, Robert P. J. Day wrote:
> On Sun, 18 Nov 2012, Jean-Christophe PLAGNIOL-VILLARD wrote:
> 
> > On 08:48 Sun 18 Nov     , Robert P. J. Day wrote:
> > >
> > >   as i'm working my way thru the lib/ routines in barebox, i notice
> > > that some source files there, like getopt.c, conveniently have the
> > > filename right at the top:
> > >
> > > /*
> > >  * getopt.c - a simple getopt(3) implementation. See getopt.h for explanation.
> > > ...
> > >
> > > i really like this habit as it makes it easy to send a file to the
> > > printer and not forget what the file was.
> > >
> > >   however, most of the files in lib/ don't have that.  as i work my
> > > way through the files, i'd be happy to add something like that to each
> > > file, and submit the changes all as one patch.  is there a standard?
> > > from what i can see, there's quite the variety in how people add that
> > > to a source file.
> > >
> > >   i'm open to guidance and i can take it from there.
> > no this is a pain in the ass to maintian when we move file
> >
> > I' drop it and I'm against it
> 
>   ok, that logic makes sense, i'm good with that.

Me aswell. Tools like a2ps also print the filename ;)

Sascha


-- 
Pengutronix e.K.                           |                             |
Industrial Linux Solutions                 | http://www.pengutronix.de/  |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

Re: is there a standard for putting the name of a source file in the file?

[Robert P. J. Day]

On Mon, 19 Nov 2012, Sascha Hauer wrote:

> On Sun, Nov 18, 2012 at 11:39:48AM -0500, Robert P. J. Day wrote:
> > On Sun, 18 Nov 2012, Jean-Christophe PLAGNIOL-VILLARD wrote:
> >
> > > On 08:48 Sun 18 Nov     , Robert P. J. Day wrote:
> > > >
> > > >   as i'm working my way thru the lib/ routines in barebox, i notice
> > > > that some source files there, like getopt.c, conveniently have the
> > > > filename right at the top:
> > > >
> > > > /*
> > > >  * getopt.c - a simple getopt(3) implementation. See getopt.h for explanation.
> > > > ...
> > > >
> > > > i really like this habit as it makes it easy to send a file to the
> > > > printer and not forget what the file was.
> > > >
> > > >   however, most of the files in lib/ don't have that.  as i work my
> > > > way through the files, i'd be happy to add something like that to each
> > > > file, and submit the changes all as one patch.  is there a standard?
> > > > from what i can see, there's quite the variety in how people add that
> > > > to a source file.
> > > >
> > > >   i'm open to guidance and i can take it from there.
> > > no this is a pain in the ass to maintian when we move file
> > >
> > > I' drop it and I'm against it
> >
> >   ok, that logic makes sense, i'm good with that.
>
> Me aswell. Tools like a2ps also print the filename ;)

  yes, i agree, it was a silly idea, i only brought it up since some
of the files under lib/ were doing that and some weren't and i didn't
know if there was a standard of some kind.  movin' on ...

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox