ChiliProject is not maintained anymore. Please be advised that there will be no more updates.
We do not recommend that you setup new ChiliProject instances and we urge all existing users to migrate their data to a maintained system, e.g. Redmine. We will provide a migration script later. In the meantime, you can use the instructions by Christian Daehn.
Rake task to manage copyright inside of source files (Feature #197)
| Status: | Closed | Start date: | 2011-02-17 |
|---|---|---|---|
| Priority: | Normal | Due date: | |
| Assignee: | Eric Davis |
% Done: | 0% |
| Category: | Refactoring | ||
| Target version: | 2.0.0 | ||
| Remote issue URL: | Affected version: |
Description
Instead of having the copyright statements in each file maintained by hand (and also the years updated ad-hoc), I think it would be nice to have a central copyright file and a script to autopopulate all of the source files with it. This will let us:
- update the copyright date in one place
- add rdoc exclude comments so the copyright doesn't show up as the class documentation
I would like to have this for 1.1.0 if possible but it's not a high priority.
Related issues
| related to Task #128: Decide on ChiliProject copyright | Closed | 2011-02-03 |
Associated revisions
[#197] Fix up main copyright files
[#197] Remove old copyrights
[#197] Add a rake task to update the copyright in code files
[#197] Upgrade the copyright in the code files
[#197] Better regex and no trailing whitespace.
History
Updated by Felix Schäfer at 2011-02-17 08:24 am
The copyrights all being slightly different in different files, it'll be delicate to get it right. Put that in 1.2.0 rather.
Updated by Eric Thomas at 2011-02-17 04:36 pm
Do you really need to have each file contain a copyright? I find that to be quite annoying when browsing through the source code. I don't see why you just don't remove all the copyrights from all the files and then just put the copyright inside the README.
Updated by Eric Davis at 2011-02-19 01:30 am
Felix Schäfer wrote:
The copyrights all being slightly different in different files, it'll be delicate to get it right.
How so? I was thinking of purging the existing Copyright notices and bulk replacing/adding them)
Eric Thomas wrote:
Do you really need to have each file contain a copyright? I find that to be quite annoying when browsing through the source code. I don't see why you just don't remove all the copyrights from all the files and then just put the copyright inside the
README.
I don't know the legal ramifications of it. Some people say each file needs to have it, others say a single file is all that's needed.
Updated by Eric Davis at 2011-05-27 07:26 pm
- Target version set to 2.0.0
Updated by Eric Davis at 2011-05-29 08:49 pm
I've updated the copyright by:
- moving Redmine's copyright from each file into the main doc/COPYRIGHT.rdoc file.
- adding a rake task (
copyright:update) that will go through all of the code files and add a short copyright to the top of the file. - the short copyright is wrapped in a block of rdoc that will prevent it from showing in the docs. So we won't see the copyright in each page on
rake doc:app.
If we need to update the copyright in each file now, just edit doc/COPYRIGHT_short.rdoc and rerun the rake task.
Merged to unstable in ec3717e
- Assignee set to Eric Davis
- Status changed from Open to Closed
Updated by Eric Davis at 2011-05-30 09:35 pm
- Tracker changed from Task to Feature