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

From Eclipsepedia

Jump to: navigation, search
m
m (Install the org.eclipse.releng.tools plugin to Eclipse: adds information for dummy users)
 
(5 intermediate revisions by one user 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
+
Adjust the number "3.7" to the number matching your eclipse version.
* you can use Windows - preference - CVS - CVS Repositories
+
 
** Host: dev.eclipse.org
+
[[Image:InstallRelengTools.png]]
** Repository: /cvsroot/eclipse
+
 
* click on versions and look for org.eclipse.releng.tools-bundle
+
==Configuration of Eclipse copyright tool ==
* pick out the bundle version of your Eclipse version e. g. org.eclipse.releng.tools R3_3_1_1
+
 
* choose check out to import the bundle into your workspace
+
The Copyright Tool is configured using the preferences.
  
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
+

Latest revision as of 11:59, 20 November 2013

Contents

[edit] 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. Adjust the number "3.7" to the number matching your eclipse version.

InstallRelengTools.png

[edit] 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.

[edit] Use Eclipse copyright tool

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

Copyrighttool2.jpg

[edit] More Information

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