checksrc: add COPYRIGHT year check #3303
Conversation
danielgustafsson
force-pushed
the
dg-checksrc_copyright_3
branch
from
48336bb
to
2e2098e
Compare
|
The good thing about this PR is that it seem to work, the bad part is that this option makes |
danielgustafsson
changed the title
|
I agree that this heavy impact would be unfortunate to impose on everyone by default. But I would like to come up with a system that allows me personally to have this run in my local dev environment! Possibly we can support this by simply making checksrc support a local file for extra options or something so that I can just put a "lib/.checksrc" file in there specifying the extra option to use in that dir? I also think we should adjust the travis checksrc job to make sure it runs this copyright check as well. |
danielgustafsson
force-pushed
the
dg-checksrc_copyright_3
branch
from
2e2098e
to
52b2950
Compare
I like this idea so I've implemented it and pushed a rebase which contains support for enabling extended checks in
Unless I botched it from not really knowing Travis configuration very well, the second commit in this PR should enable it in Travis. |
|
Thanks for the review! Just realized that I have forgotten to add this to |
Forgetting to bump the year in the copyright clause when hacking has been quite common among curl developers, but a traditional checksrc check isn't a good fit as it would penalize anyone hacking on January 1st (among other things). This adds a more selective COPYRIGHTYEAR check which intends to only cover the currently hacked on changeset. The check for updated copyright year is currently not enforced on any file but only on files edited and/or committed locally. This is due to the amount of files which aren't updated with their correct copyright year at the time of their respective commit. To further avoid running this expensive check for every developer, it adds a new local override mode for checksrc where a .checksrc file can be used to turn on extended warnings locally.
The extended warning for checking incorrect COPYRIGHTYEAR is quite expensive to run so rather than expecting every developer to do it we ensure it's turned on locally for Travis.
danielgustafsson
force-pushed
the
dg-checksrc_copyright_3
branch
from
52b2950
to
687033b
Compare
This is a patch which I had shelved deeming it too uninteresting/complicated to be useful, but when discussing the recent
snprintf()switcheroo in #3297 the topic was brought up again. This is more of a discussion piece/show-and-tell PR than something I really think we should do, but working code is generally nicer to discuss around than handwaving so here goes.The check for updated copyright year is currently not enforced on any file but only on files edited and/or committed locally. This is due to the amount of files which aren't updated with their correct copyright year at the time of their respective commit. If enforced for the correct year, there are hundreds of errors which is painful. We could of course just sed the list of files to the current year and be done with it, but then we could just as well bump every file in the tree and there are reasons why we don't do that.
Invoking the checking like in this patch is rather expensive, and obviously only works on cloned repos and not source tarballs (which in this day and age really isn't used for active development anyways).