Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Eclipse copyright tool"
m |
|||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | 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, | + | [[COSMOS|COSMOS Wiki]] > [[COSMOS_dev_process|COSMOS Development Process]] |
| + | |||
| + | We are legally required (and also required by Eclipse guidelines) to maintain our copyrights as accurately as possible. 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, 2009"). To do the latter, the tool compares all files against the last revision from the previous year to see if there were any changes. So even if you didn't change the file for this checkin, it might be fixing the copyright for a previous change in the current year. | ||
Here are the steps to load and run the fix copyrights tool. | Here are the steps to load and run the fix copyrights tool. | ||
| − | + | <ol> | |
| − | + | <li>Load module <code>org.eclipse.releng.tools</code> from repository <code>/cvsroot/eclipse</code> on dev.eclipse.org.</li> | |
| − | + | <li>Export the plugin to your plugins directory by selecting '''Export...''' from the popup menu and then Deployable plugins and fragments</li> | |
| − | + | <li>Restart Eclipse to pick up the new plugin (shortcut is to choose '''File''' > '''Switch Workspace''' and incidate the same workspace).</li> | |
| − | + | <li>Go to '''Window''' > '''Preferences''' > '''Copyright Tool''' to set your copyright preferences. For IBM committers, the template should appear as follows: | |
| − | + | <pre>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</pre></li> | |
| − | + | <li>Set default creation year and default revision year in the preferences to the current year. Click OK to save the preferences.</li> | |
| − | + | <li>Switch to the Resource perspective.</li> | |
| − | + | <li>Select all projects for which you want to run the tool and select Fix Copyrights from the context menu.</li> | |
| − | + | <li>Perform a team synchronization on the changed projects and commit the changes.</li> | |
| + | </ol> | ||
Latest revision as of 15:08, 9 May 2011
COSMOS Wiki > COSMOS Development Process
We are legally required (and also required by Eclipse guidelines) to maintain our copyrights as accurately as possible. 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, 2009"). To do the latter, the tool compares all files against the last revision from the previous year to see if there were any changes. So even if you didn't change the file for this checkin, it might be fixing the copyright for a previous change in the current year.
Here are the steps to load and run the fix copyrights tool.
- Load module
org.eclipse.releng.toolsfrom repository/cvsroot/eclipseon dev.eclipse.org. - Export the plugin to your plugins directory by selecting Export... from the popup menu and then Deployable plugins and fragments
- Restart Eclipse to pick up the new plugin (shortcut is to choose File > Switch Workspace and incidate the same workspace).
- 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 - Set default creation year and default revision year in the preferences to the current year. Click OK to save the preferences.
- Switch to the Resource perspective.
- Select all projects for which you want to run the tool and select Fix Copyrights from the context menu.
- Perform a team synchronization on the changed projects and commit the changes.