Development Resources/How to Use Eclipse Copyright Tool

From Eclipsepedia

Jump to: navigation, search

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

Take the plugin from Eclipse repository like the documentation Eclipse_copyright_tool described:

  • use the CVS plugin of Eclipse to checkout the org.eclipse.releng.tools into your workspace
  • you can use Windows - preference - CVS - CVS Repositories
    • Host: dev.eclipse.org
    • Repository: /cvsroot/eclipse
  • 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
  • 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

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

Copyrighttool2.jpg

  • change to Resource-view of Eclipse
  • 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

The tool will:

  • insert a header
    • in java files
    • if configured, in *.properties files
    • if configured, with override existing header

The tool will NOT

  • insert a header in other files like plugin.xml