phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tweak

Browse Source 
git-svn-id: https://pmd.svn.sourceforge.net/svnroot/pmd/trunk@235 51baf565-9d33-0410-a72c-fc3788e3496d
This commit is contained in:
Tom Copeland
2002-07-08 17:24:35 +00:00
parent b1fd6b5b37
commit 6593818b80
5 changed files with 61 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
pmd-jedit/config/jedit.html
View File

@ -1,32 +1,27 @@
<html><head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>PMD JEdit Plug-in Users' Guide</title><meta name="generator" content="DocBook XSL Stylesheets V1.50.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="article"><div class="titlepage"><div><h1 class="title"><a name="d0e2"></a>PMD JEdit Plug-in Users' Guide</h1></div><div></div><hr></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><a href="#plugin-jedit-installation">Installation</a></dt><dd><dl><dt><a href="#plugin-jedit-installation-requirements">System requirements</a></dt><dt><a href="#plugin-jedit-installation-installation">Installation</a></dt></dl></dd><dt><a href="#plugin-jedit-integration">Integration</a></dt><dt><a href="#plugin-jedit-license">License</a></dt></dl></div><a class="indexterm" name="d0e17"></a><a class="indexterm" name="d0e20"></a><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="plugin-jedit-installation"></a>Installation</h2></div></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="plugin-jedit-installation-requirements"></a>System requirements</h3></div></div><p>
The PMD JEdit Plug-in requires at least JEdit 4.0final.
</p><p>
</p><p>
Refer to the PMD user manual for the basic requirements to run PMD (You
may find the latest version on the PMD website,
<a href="http://pmd.sf.net/" target="_top">http://PMD.sf.net/</a>)
</p></div><div class="sect2"><div class="titlepage"><div><h3 class="title"><a name="plugin-jedit-installation-installation"></a>Installation</h3></div></div><a class="indexterm" name="d0e43"></a><p>
The Plug-in comes as a single <tt>.zip</tt> file.
Unzipping this file into a directory of your choice (referred
to as <i><tt>&lt;HOME_DIR&gt;</tt></i>) will produce two
subdirectories <tt>/bin</tt> and <tt>/docs</tt>.
</p><p>
Further installation is simple: just copy the file
<tt><i><tt>&lt;HOME_DIR&gt;</tt></i>/bin/PMD-jedit-bundle-<i><tt>&lt;version&gt;</tt></i>.jar</tt>
into the <tt>/jars</tt> directory of your JEdit distribution.
JEdit will then need to be restarted before PMD begins working.
</p></div></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="plugin-jedit-integration"></a>Integration</h2></div></div><p>
The software adds a new menu item group into the <b>Plugins</b>
menu of the editor view. Available is a new menu item:
</p><div class="itemizedlist"><ul type="disc"><li><p>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>
PMD JEdit Plug-in Users' Guide
</title>
<body>
<h1>PMD JEdit Plug-in Users' Guide</h1>
<hr><p>Installation</h2>
<h3>System requirements</h3>
<p>PMD is a Java source code analyzer. The PMD JEdit Plugin requires at least JEdit 4.0final. <a href="http://pmd.sf.net/" target="_top">Here's</a> the PMD web site.</p>
<h3>Installation</h3>
<p>The Plugin comes as a single <tt>.zip</tt> 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.</p>
<h2>Integration</h2>
<p>
The software adds a new menu item group into the <b>Plugins</b> menu of the editor view. There's one new menu item:
</p>
<ul>
<li>
<b>Plugins</b>-&gt;<b>PMD</b>-&gt;<b>Check active buffer</b> (<b>Ctrl-Shift-F11</b>).
</p><p>
Checks the contents of the active text area.
</p>
</p>
Runs the currently displayed Java file through the PMD code checking rules and displays a pop up window with the results.</p>
</li>
<p></p></li></ul></div></div><div class="sect1"><div class="titlepage"><div><h2 class="title" style="clear: both"><a name="plugin-jedit-license"></a>License</h2></div></div><p>
The JEdit Plug-in is free software, released under the Apache license.
</p></div></div></body></html>
</ul>
<h2>License</h2>
<p>The JEdit Plug-in is free software, released under the Apache license.</p>
</body></html>

4
pmd-jedit/config/pmd.props
View File

@ -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

17
pmd-jedit/etc/build.xml
View File

@ -30,8 +30,7 @@
</javac>
</target>
<target name="dist" depends="clean">
<target name="jar">
<jar jarfile="${lib}/${ant.project.name}.jar">
<fileset dir="${build}"/>
<fileset dir="${config}">
@ -40,9 +39,23 @@
<include name="*.html"/>
</fileset>
</jar>
</target>
<target name="dist" depends="jar">
<copy file="${lib}/${ant.project.name}.jar" todir="${jedit.install.dir}"/>
</target>
<target name="release">
<antcall target="clean"/>
<antcall target="jar"/>
<mkdir dir="tmp/jars"/>
<copy file="${lib}/${ant.project.name}.jar" todir="tmp/jars"/>
<copy file="${lib}/pmd-0.3.jar" todir="tmp/jars"/>
<zip zipfile="pmd-jedit-0.1.zip" basedir="tmp"/>
<delete dir="tmp"/>
</target>
<target name="clean" depends="delete,compile">
</target>

2
pmd-jedit/etc/changelog.txt
View File

@ -1,2 +1,2 @@
???? 2002 - 0.1:
July 8 2002 - 0.1:
Initial release

35
pmd-jedit/etc/doing_the_next_pmd_jedit_release.txt
View File

@ -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!"