Merge pull request #26 from kjlubick/misccleanup

Some message/docs cleanup and a bugrank.txt validation/alphabetization ant plugin

README.md

@@ -33,12 +33,12 @@ The master branch is the main branch of development currently targeting the new
 
 ##Setting up for Development##
 1. Download/install [Eclipse](https://www.eclipse.org/home/index.php), ideally 4.3 (Kepler) or newer.  The standard release (for Java) will work fine.
-2. Download [yank, the dependency manager](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.mebigfatguy.yank%22%20AND%20a%3A%22yank%22) .  `yank-1.2.0.jar` (or later) should go in your ~/.ant/lib folder, which you will have to make if it doesn't exist.  Windows people, this goes under [Username]/.ant/lib.  
-Don't have more than one version of yank in this folder, as it's not clear which one Ant will load, leading to annoying compatibility issues.
-3. Clone this git repo.  [GitHub for Windows](https://windows.github.com/) or [GitHub for Mac](https://mac.github.com/) are good clients if you don't already have one.
+2. **Ant Dependencies** Download [yank, the dependency manager](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.mebigfatguy.yank%22%20AND%20a%3A%22yank%22) and [bug-rank-check-style](https://bitbucket.org/klubick/bugrankcheckstyle/downloads).  Both jars (v1.2.0+ and v1.0.0+) should go in your ~/.ant/lib folder, which you will have to make if it doesn't exist.  Windows people, this goes under [Username]/.ant/lib.  
+Don't have more than one version of either jar in this folder, as it's not clear which one Ant will load, leading to annoying compatibility issues.
+3. [Fork](https://help.github.com/articles/fork-a-repo) this git repo and clone it.  [GitHub for Windows](https://windows.github.com/) or [GitHub for Mac](https://mac.github.com/) are good clients if you don't already have one.
 4.  Open Eclipse.  File>Import and then choose "Existing projects into workspace", and find the fb-contrib folder you created in step 3.  Ignore any compile errors (for now).
 5. Using git, clone the FindBugs repository using `git clone https://code.google.com/p/findbugs/`  You will only need the findbugs subfolder (the one that has README.txt in it).  You can delete the rest, if you wish.
-6. Import this project into Eclipse as well.  You may wish to mark these files as read-only, so you modify the "correct" files.
+6. Import this project into Eclipse as well.  You may wish to [mark these files as read-only](https://cloud.githubusercontent.com/assets/6819944/3866638/801ae098-1fdc-11e4-9fce-1fdecb81402f.gif), so you modify the "correct" files.
 7. In the fb-contrib project, find the `user.properties.example` file.  Make a copy of it named user.properties (this will not be tracked by version control). Modify the findbugs.dir property to where ever you have the FindBugs distribution installed.  This is the [executable FindBugs](http://findbugs.sourceforge.net/downloads.html) folder, *not* the source folder.  The jar will be "installed" to (findbugs.dir)\plugin.  
 For example, If you are using FindBugs with Eclipse (and you extracted Eclipse to C:\\), you'll set this to something like `findbugs.dir=/eclipse/plugins/edu.umd.cs.findbugs.plugin.eclipse_3.0.0.20140706-2cfb468`
 8. Finally, build fb-contrib by finding the [build.xml](https://github.com/mebigfatguy/fb-contrib/blob/717f757d69c098e1baf786d3e7c03efacf2bbfaf/build.xml) file in Eclipse, right-click it, and select Run As > Ant Build.  The dependencies needed should be downloaded to fb-contrib/lib and the fb-contrib-VERSION.jar should be built. 
@@ -52,6 +52,9 @@ External guides for making detectors:
 - https://www.ibm.com/developerworks/library/j-findbug2/
 - http://kjlubick.github.io/#/blog/post/1?building-my-first-findbugs-detector
 
+Misc references about bytecode:
+- http://www.jroller.com/dbrosius/entry/the_jvm_class_file_format
+
 For making detectors, it best to make several test cases, like those in the [sample directory](https://github.com/mebigfatguy/fb-contrib/tree/master/samples).  Even better is if you can comment where you expect bug markers to appear and why, like [this](https://github.com/mebigfatguy/fb-contrib/blob/717f757d69c098e1baf786d3e7c03efacf2bbfaf/samples/HES_Sample.java#L313).
 
 In your pull request, give an overview of your changes along with the related commits.

build.xml

@@ -48,9 +48,14 @@
         <echo message="fb-contrib - a findbugs plugin"/>
         <echo message=""/>
         <echo message="    this project uses yank (https://github.com/mebigfatguy/yank) for dependency management"/>
-        <echo message="    download yank.jar and place in ant/lib directory"/>
+        <echo message="    download yank.jar and place in ~/.ant/lib directory"/>
         <echo message="    http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.mebigfatguy.yank%22"/>
-        <antcall target="install"/>
+
+    	<echo message="===="/>
+    	<echo message="    Additionally, this project uses bug-rank-check-style to validate etc/bugrank.txt"/>
+    	<echo message="    bug-rank-check-style-1.0.0.jar can be downloaded at https://bitbucket.org/klubick/bugrankcheckstyle/downloads"/>
+    	<echo message="    and put in ~/.ant/lib alongside yank"/>
+    	<antcall target="install"/>
     </target>
 
 	<target name="-init" depends="yank" description="prepares repository for a build">
@@ -80,11 +85,13 @@
 	</target>
 
 	<target name="validate_xml" depends="-init" description="validates the xml files">
+		<taskdef name="bug-rank-check-style" classname="text.style.check.BugRankCheckStyleTask"/>
 		<xmlvalidate lenient="false" failonerror="yes">
 			<attribute name="http://apache.org/xml/features/validation/schema" value="true" />
 			<attribute name="http://xml.org/sax/features/namespaces" value="true" />
 			<fileset dir="${etc.dir}" includes="*.xml" />
 		</xmlvalidate>
+		<bug-rank-check-style findbugsxml="etc/findbugs.xml" failOnMissingDetector="false" />
 	</target>
 
 	<target name="compile" depends="-init" description="compiles java files">