Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[tigerstripe-dev] FW: [cosmos-dev] Fix copyrights tool

FYI....


From: cosmos-dev-bounces@xxxxxxxxxxx [mailto:cosmos-dev-bounces@xxxxxxxxxxx] On Behalf Of David Whiteman
Sent: Wednesday, January 09, 2008 8:29 AM
To: Cosmos Dev
Subject: [cosmos-dev] Fix copyrights tool


The Eclipse repository contains a tool that will fix copyrights in your code.  It will insert copyrights into any files that are missing them, and will also attempt to insert the additional year for modified files (e.g. "2007, 2008").  In my experience, it does the former perfectly, but it's not extremely accurate in performing the latter task.  But since it's most important that all relevant files have a copyright, I encourage you to run this tool periodically against your own code.

Here are the steps to load and run the fix copyrights tool.

1. Load module org.eclipse.releng.tools from repository /cvsroot/eclipse on dev.eclipse.org.
2. Export the plugin to your plugins directory by selecting Export... from the popup menu and then Deployable plugins and fragments
3. Restart Eclipse to pick up the new plugin (shortcut is to choose File > Switch Workspace and incidate the same workspace).
4. Go to Window > Preferences > Copyright Tool to set your copyright preferences.  For IBM committers, the template should appear as follows:

Copyright (c) ${date} IBM Corporation.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html

Contributors:
    IBM Corporation - initial API and implementation

5. Set default creation year in the preferences to 2008 and default revision year to 2008.  Click OK to save the preferences.
6. Switch to the Resource perspective.
7. Select all projects for which you want to run the tool and select Advanced Fix Copyrights from the context menu.
8. If the tool has changed any files (and it probably will), you will want to inspect its work during synchronization with the repo, since as I mentioned, it's not entirely accurate with modified files, even though it works well for files that didn't already have a copyright.

Let me know if you have any questions.  I guess it probably wouldn't hurt to copy these instructions to the dev process area of the wiki.

David
_______________________________________________
cosmos-dev mailing list
cosmos-dev@xxxxxxxxxxx
https://dev.eclipse.org/mailman/listinfo/cosmos-dev

Back to the top