From c9dca8dc9231c7e88013210892eb266b1302e983 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Sat, 14 Nov 2015 17:53:52 +0100 Subject: [PATCH] #1441 PMD: Update documentation how to compile after modularization --- README.md | 37 +++++++++--- pmd-core/ReadMe.txt | 19 ------- src/site/markdown/customizing/compiling.md.vm | 57 ++++++++++++------- src/site/markdown/overview/changelog.md | 1 + 4 files changed, 68 insertions(+), 46 deletions(-) delete mode 100644 pmd-core/ReadMe.txt diff --git a/README.md b/README.md index b57cd39711..b4be81bcce 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,42 @@ -PMD -=== +# PMD [![Build Status](https://travis-ci.org/pmd/pmd.svg?branch=master)](https://travis-ci.org/pmd/pmd) -About ------ +## About + PMD is a source code analyzer. It finds common programming flaws like unused variables, empty catch blocks, unnecessary object creation, and so forth. It supports Java, JavaScript, XML, XSL. Additionally it includes CPD, the copy-paste-detector. CPD finds duplicated code in Java, C, C++, C#, PHP, Ruby, Fortran, JavaScript. -Source ------- +## Source + Our latest source of PMD can be found on [GitHub]. Fork us! -News and Website ----------------- +### How to build PMD? + +Simply use maven in the top-level directory: + + mvn clean package + +This will create the zip files in the directory `pmd-dist/target`: + + cd pmd-dist/target + ls *.zip + +That's all ! + +### Bug Reports + +We are using Sourceforge for bug tracking. Please file your bugs at . + +### Pull Requests + +Pull requests are always welcome: + + +## News and Website + More information can be found on our [Website] and on [SourceForge]. diff --git a/pmd-core/ReadMe.txt b/pmd-core/ReadMe.txt deleted file mode 100644 index 8f74c4b2d2..0000000000 --- a/pmd-core/ReadMe.txt +++ /dev/null @@ -1,19 +0,0 @@ -How to build PMD ? -================== - -Simply use maven: $ mvn compile - -PMD now uses a small plugin to generate its website, so if you want to build the -website ($ mvn site), you'll need to install it: - -$ cd ../maven-plugin-pmd-build -$ mvn clean install - -That's all ! - -How to quickly build a "release" (zipfiles - for testing purpose only) ? ------------------------------------------------------------------------- - -$ mvn -Dmaven.test.skip=true -Dmaven.clover.skip=true verify post-site - -Full release process is documented in src/site/xdocs/pmd-release-process.xml diff --git a/src/site/markdown/customizing/compiling.md.vm b/src/site/markdown/customizing/compiling.md.vm index d63ef2336a..8d8d8a65e9 100644 --- a/src/site/markdown/customizing/compiling.md.vm +++ b/src/site/markdown/customizing/compiling.md.vm @@ -7,10 +7,8 @@ ## Requirements -* JDK 1.6 or higher -* [Apache Maven][maven] 3 or later. - -[maven]: http://maven.apache.org +* JDK 1.7 or higher +* [Apache Maven](http://maven.apache.org) 3 or later. ## Compiling PMD @@ -27,39 +25,60 @@ Now cd down into the pmd directory: [tom@hal building]$ cd pmd-src-${project.version} [tom@hal pmd-src-${project.version}]$ ls -l | grep pom.xml - -rw-rw-r-- 1 tom tom 29357 Jan 31 20:00 pom.xml + -rw-rw-r-- 1 tom tom 36482 14. Nov 17:36 pom.xml [tom@hal pmd-src-${project.version}]$ That's the project configuration for maven... let's compile! [tom@hal pmd-src-${project.version}]$ mvn clean package [INFO] Scanning for projects... - [INFO] - [INFO] ------------------------------------------------------------------------ - [INFO] Building PMD ${project.version} [INFO] ------------------------------------------------------------------------ + [INFO] Reactor Build Order: [INFO] + [INFO] PMD + [INFO] PMD Core ... - Results : - - Tests run: 829, Failures: 0, Errors: 0, Skipped: 9 - + ... after a few minutes ... + [INFO] ------------------------------------------------------------------------ + [INFO] Reactor Summary: [INFO] - [INFO] --- maven-jar-plugin:2.3.1:jar (default-jar) @ pmd --- - [INFO] Building jar: target/pmd-${project.version}.jar + [INFO] PMD ................................................ SUCCESS [ 3.061 s] + [INFO] PMD Core ........................................... SUCCESS [ 25.675 s] + [INFO] PMD Test Framework ................................. SUCCESS [ 0.457 s] + [INFO] PMD C++ ............................................ SUCCESS [ 1.893 s] + [INFO] PMD C# ............................................. SUCCESS [ 0.619 s] + [INFO] PMD Fortran ........................................ SUCCESS [ 0.609 s] + [INFO] PMD Go ............................................. SUCCESS [ 0.103 s] + [INFO] PMD Java ........................................... SUCCESS [01:08 min] + [INFO] PMD JavaScript ..................................... SUCCESS [ 3.279 s] + [INFO] PMD JSP ............................................ SUCCESS [ 3.944 s] + [INFO] PMD Matlab ......................................... SUCCESS [ 1.342 s] + [INFO] PMD Objective-C .................................... SUCCESS [ 2.281 s] + [INFO] PMD PHP ............................................ SUCCESS [ 0.536 s] + [INFO] PMD PL/SQL ......................................... SUCCESS [ 10.973 s] + [INFO] PMD Python ......................................... SUCCESS [ 1.758 s] + [INFO] PMD Ruby ........................................... SUCCESS [ 0.438 s] + [INFO] PMD Velocity ....................................... SUCCESS [ 3.941 s] + [INFO] PMD XML and XSL .................................... SUCCESS [ 2.174 s] + [INFO] PMD Scala .......................................... SUCCESS [ 11.901 s] + [INFO] PMD Distribution Packages .......................... SUCCESS [ 11.366 s] + [INFO] PMD Java 8 Integration ............................. SUCCESS [ 0.560 s] [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESS [INFO] ------------------------------------------------------------------------ - [INFO] Total time: 1:41.062s - [INFO] Finished at: Mon Apr 30 09:36:12 CEST 2012 - [INFO] Final Memory: 13M/187M + [INFO] Total time: 02:36 min + [INFO] Finished at: 2015-11-14T17:46:06+01:00 + [INFO] Final Memory: 63M/765M [INFO] ------------------------------------------------------------------------ [tom@hal pmd-src-${project.version}]$ +Now the source and binary distribution zip files can be found in +the folder `pmd-dist/target`. + Notes: -* The rules that have already been written are specified in the src/main/resources/rulesets/ directory in the - source distribution. They're also in the jar file that's included with both the +* The rules that have already been written are specified in the src/main/resources/rulesets/ directories + of the specific languages, e.g. `pmd-java/src/main/resources/rulesets`. They're also in the jar file that's included with both the source and binary distributions. A paucity of detail, I'm sure you'd agree. If you think this document can be diff --git a/src/site/markdown/overview/changelog.md b/src/site/markdown/overview/changelog.md index c60dbced25..045098b4b4 100644 --- a/src/site/markdown/overview/changelog.md +++ b/src/site/markdown/overview/changelog.md @@ -26,5 +26,6 @@ * General * [#1429](https://sourceforge.net/p/pmd/bugs/1429/): Java - Parse Error: Cast in return expression * [#1425](https://sourceforge.net/p/pmd/bugs/1425/): Invalid XML Characters in Output + * [#1441](https://sourceforge.net/p/pmd/bugs/1441/): PMD: Update documentation how to compile after modularization **API Changes:**