[geeklog-devel] Geeklog Code File Comment Headers
dirk at haun-online.de
Sun Jan 5 12:42:12 EST 2014
Tom <websitemaster at cogeco.net> wrote:
> Is there some sort of script for the comment headers in our code files that
> we can run to update them?
No. Or at least we don't have one.
> Most of the file Geeklog version numbers are out of whack.
If some file hasn't changed since the version stated in the header, then it shouldn't matter. But yeah, it is out of date for many.
> I also wonder what information really needs to be put here…
I'm not a lawyer, but we obviously need the licence there. It also makes sense to state the file name (in case it gets renamed or shows up elsewhere), a description of what it's for and that it's part of Geeklog. We could probably drop the version number altogether, though.
I guess we need the copyright line, which implies that we need a list of people holding that copyright, i.e. the authors. The author names are also horribly out of date (or just plain wrong) in many of our files, though. Email addresses, too (do we even need those?).
If you scroll to the end of the GPL text here: http://www.gnu.org/licenses/gpl-2.0.txt
you'll find instructions on how to best apply the licence to a file (that text is not part of the licence and hence not included in our copy under public_html/docs).
More information about the geeklog-devel