Difference between revisions of "Development Resources/How to Use Eclipse Copyright Tool"

From Eclipsepedia

Jump to: navigation, search
(Configuration of Eclipse copyright tool)
m (How to use Eclipse copyright tool moved to Development Resources/How to Use Eclipse Copyright Tool: This is a generally useful page that should be part of the development resources.)
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
====Install the org.eclipse.releng.tools plugin to eClipse ====
+
==Install the org.eclipse.releng.tools plugin to Eclipse ==
  
Take the plugin from eClipse repository like the documentation [[Eclipse_copyright_tool]] described:
+
You can use the standard software installer ("Help > Install New Software...") to add the Eclipse Project's Releng Tools to your Eclipse configuration.
* use the CVS plugin of eClipse to checkout the org.eclipse.releng.tools into your workspace
+
 
* you can use Windows - preference - CVS - CVS Repositories
+
[[Image:InstallRelengTools.png]]
** Host: dev.eclipse.org
+
 
** Repository: /cvsroot/eclipse
+
==Configuration of Eclipse copyright tool ==
* click on versions and look for org.eclipse.releng.tools-bundle
+
 
* pick out the bundle version of your eClipse version e. g. org.eclipse.releng.tools R3_3_1_1
+
The Copyright Tool is configured using the preferences.
* choose check out to import the bundle into your workspace
+
  
To install this plugin to eClipse you have to export this bundle into the plugins-folder of eClipse:
 
* right click on bundle and export
 
* choose plugin-development and then Deployable plug-ins and fragments
 
* choose the plugins subfolder of your eClipse folder
 
* this exports a file like 'org.eclipse.releng.tools_3.3.0.200809301227.jar' into this plugin folder
 
* restart your eClipse workspace
 
  
====Configuration of Eclipse copyright tool ====
 
 
[[Image:Copyrighttool.jpg]]
 
[[Image:Copyrighttool.jpg]]
  
* the listbox 'copyright template' takes a fix header for your java files
 
* you can declare a creation and revision year
 
* you can declare that existing header will be replaced
 
* you can declare that properties files like build.properties will be skiped
 
  
====Use Eclipse copyright tool ====
+
If you're not sure what to put here, please see the [http://eclipse.org/legal/copyrightandlicensenotice.php Default Copyright and License Notice].
[[Image:Copyrighttool2.jpg]]
+
  
* change to Resource-view of eClipse
+
==Use Eclipse copyright tool ==
* deselect all working sets, if you have selected - you must see the project structure of your workspace
+
 
* click right on your project and choose Advanced fix copyrights
+
Once installed and configured, the Copyright tool can accessed via context menu on a project.
 +
 
 +
[[Image:Copyrighttool2.jpg]]
  
The tool will:
+
==More Information==
* insert a header
+
** in java files
+
** if configured, in *.properties files
+
** if configured, with override existing header
+
  
The tool will NOT
+
More information about the Eclipse Project's Release Engineering Tools can be found in the [[Platform-releng-faq#How do I use the releng plugin?|Platform Releng FAQ]].
* insert a header in other files like plugin.xml
+

Revision as of 13:03, 30 September 2011

Contents

Install the org.eclipse.releng.tools plugin to Eclipse

You can use the standard software installer ("Help > Install New Software...") to add the Eclipse Project's Releng Tools to your Eclipse configuration.

InstallRelengTools.png

Configuration of Eclipse copyright tool

The Copyright Tool is configured using the preferences.


Copyrighttool.jpg


If you're not sure what to put here, please see the Default Copyright and License Notice.

Use Eclipse copyright tool

Once installed and configured, the Copyright tool can accessed via context menu on a project.

Copyrighttool2.jpg

More Information

More information about the Eclipse Project's Release Engineering Tools can be found in the Platform Releng FAQ.