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

Robert P. J. Day rpjday at crashcourse.ca
Sun Nov 18 08:48:51 EST 2012


  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
========================================================================



More information about the barebox mailing list