diff --git a/pmd-jedit/config/jedit.html b/pmd-jedit/config/jedit.html index 5aab6e6d78..f819b9af11 100644 --- a/pmd-jedit/config/jedit.html +++ b/pmd-jedit/config/jedit.html @@ -1,32 +1,27 @@ - - PMD JEdit Plug-in Users' Guide

PMD JEdit Plug-in Users' Guide

Table of Contents

Installation
System requirements
Installation
Integration
License

Installation

System requirements

-The PMD JEdit Plug-in requires at least JEdit 4.0final. -

-

-Refer to the PMD user manual for the basic requirements to run PMD (You -may find the latest version on the PMD website, -http://PMD.sf.net/) -

Installation

-The Plug-in comes as a single .zip file. -Unzipping this file into a directory of your choice (referred -to as <HOME_DIR>) will produce two -subdirectories /bin and /docs. -

-Further installation is simple: just copy the file -<HOME_DIR>/bin/PMD-jedit-bundle-<version>.jar -into the /jars directory of your JEdit distribution. -JEdit will then need to be restarted before PMD begins working. -

Integration

-The software adds a new menu item group into the Plugins -menu of the editor view. Available is a new menu item: -

  • + + +PMD JEdit Plug-in Users' Guide + + +

    PMD JEdit Plug-in Users' Guide

    +

    Installation +

    System requirements

    +

    PMD is a Java source code analyzer. The PMD JEdit Plugin requires at least JEdit 4.0final. Here's the PMD web site.

    +

    Installation

    +

    The Plugin comes as a single .zip file. +Just unzip it into your JEdit directory and it'll put a couple of jar files into your jars directory, restart JEdit, +and you'll be ready to go.

    +

    Integration

    +

    +The software adds a new menu item group into the Plugins menu of the editor view. There's one new menu item: +

    +
      +
    • Plugins->PMD->Check active buffer (Ctrl-Shift-F11). -

      -Checks the contents of the active text area. -

      -

      +Runs the currently displayed Java file through the PMD code checking rules and displays a pop up window with the results.

      • -

License

-The JEdit Plug-in is free software, released under the Apache license. -

\ No newline at end of file + +

License

+

The JEdit Plug-in is free software, released under the Apache license.

+ \ No newline at end of file diff --git a/pmd-jedit/config/pmd.props b/pmd-jedit/config/pmd.props index 7e9291c6d3..4de98b246b 100644 --- a/pmd-jedit/config/pmd.props +++ b/pmd-jedit/config/pmd.props @@ -1,13 +1,13 @@ # # Plugin properties # -plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.name=PMD Java Source Code Checker +plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.name=PMD plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.author=Tom Copeland plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.version=0.1 plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.docs=jedit.html plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.depend.0=jdk 1.3 plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.depend.1=jedit 04.00.99.00 -plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.jars=pmd.jar +plugin.net.sourceforge.pmd.jedit.PMDJEditPlugin.jars=pmd-0.3.jar # # Menu properties diff --git a/pmd-jedit/etc/build.xml b/pmd-jedit/etc/build.xml index 193563e977..d27840b870 100644 --- a/pmd-jedit/etc/build.xml +++ b/pmd-jedit/etc/build.xml @@ -30,8 +30,7 @@ - - + @@ -40,9 +39,23 @@ + + + + + + + + + + + + + + diff --git a/pmd-jedit/etc/changelog.txt b/pmd-jedit/etc/changelog.txt index c53e2804ac..8cbab45411 100644 --- a/pmd-jedit/etc/changelog.txt +++ b/pmd-jedit/etc/changelog.txt @@ -1,2 +1,2 @@ -???? 2002 - 0.1: +July 8 2002 - 0.1: Initial release diff --git a/pmd-jedit/etc/doing_the_next_pmd_jedit_release.txt b/pmd-jedit/etc/doing_the_next_pmd_jedit_release.txt index ee2a5c83f3..cb74ca3eff 100644 --- a/pmd-jedit/etc/doing_the_next_pmd_jedit_release.txt +++ b/pmd-jedit/etc/doing_the_next_pmd_jedit_release.txt @@ -1,25 +1,26 @@ update the release date in the changelog +change config/pmd.props to reflect actual pmd.jar file version -ant release <-- new task, should create jar and zip it up into a pmd-jedit.zip that looks like: -jars/pmd-0.3.jar -jars/PMDJEditPlugin.jar +Create the binary release: +ant release +rename it to pmd-jedit-bin-0.1.zip -so that it can be unzipped like an overlay - -cvs add -kb pmd-jedit-0.1.jar -cvs rm pmd-jedit-0.1.jar +Create the src release: +cvs add -kb PMDJEditPlugin-0.1.jar +// FOR 0.2 release: cvs rm PMDJEditPlugin-0.1.jar cvs ci -m "adding new jar, removing old one" cd c:\data\pmd-jedit -cvs rtag -D tomorrow "pmd_jedit_release_0_4" pmd-jedit +cvs rtag -D tomorrow "pmd_jedit_release_0_1" pmd-jedit rmdir /q /s c:\tmp\pmd-jedit mkdir c:\tmp\pmd-jedit cvs export -d c:\tmp\pmd-jedit -r pmd_jedit_release_0_1 pmd-jedit -zip it up, rename it to pmd-jedit-0.1.zip -unzip it into c:\jedit -TESTS: Can you -1) run jedit ok? -2) open the options panel? -3) run PMD on a file? +zip it up, rename it to pmd-jedit-src-0.1.zip + +unzip binary release into c:\jedit +TESTS: +1) Can you run jedit ok? +2) Can you open the options panel? +3) Can you it on a file? if you see a bug and fix it, you can delete the release using: cvs rtag -d pmd_jedit_release_0_1 pmd @@ -30,11 +31,13 @@ ftp upload.sourceforge.net generic userid/password: anonymous/tomcopeland@users.sourceforge.net cd incoming bin -put pmd-jedit-0.1.zip +put pmd-jedit-src-0.1.zip +put pmd-jedit-bin-0.1.zip Go to Admin, Edit/Release Files, click on Add new release Paste stuff into the changelog/readme boxes -Add the pmd-jedit-0.1.zip file +Add the pmd-jedit-src-0.1.zip file +Add the pmd-jedit-bin-0.1.zip file Classify the file Submit some news saying "hey, new release of the JEdit plugin!"