hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

[doc] Fix edit me link, remove news link from top, add site.pmd.version var

Browse Source
This commit is contained in:
Andreas Dangel 2017-07-22 14:17:08 +02:00
parent 4370ff663e
commit c1fe2dfbd5
6 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/_config.yml
View File

@ -1,5 +1,8 @@
repository: pmd/pmd
pmd:
version: 6.0.0
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
@ -34,7 +37,7 @@ feedback_subject_line: PMD Source Code Analyzer
feedback_email:
# used as a contact email for the Feedback link in the top navigation bar
# feedback_disable: true
feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed
# feedback_text: "Need help?"

2
docs/_data/topnav.yml
View File

@ -3,8 +3,6 @@
topnav:
- title: Topnav
items:
- title: News
url: /news
- title: Download
external_url: https://github.com/pmd/pmd/releases/latest
- title: Fork us on github

2
docs/_layouts/page.html
View File

@ -41,7 +41,7 @@ layout: default
{% if site.github_editme_path %}
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{% unless page.url contains "index.html" %}pages/{% endunless %}{{page.folder}}{{page.url | remove: ".html" | append: ".md"}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
<a target="_blank" href="https://github.com/{{site.github_editme_path}}{{page.path}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
{% endif %}

3
docs/pages/pmd/devdocs/releasing.md
View File

@ -124,7 +124,7 @@ the following template:
* Move version/release info from **src/site/markdown/overview/changelog.md** to **src/site/markdown/overview/changelog-old.md**.
* Update version/release info in **src/site/markdown/overview/changelog.md**. Use the following template:
```
# PMD Release Notes
## ????? - ${DEVELOPMENT_VERSION}
@ -147,6 +147,7 @@ the following template:
### API Changes
### External Contributions
```
Commit and push

14
docs/pages/pmd/userdocs/getting_started.md
View File

@ -29,11 +29,11 @@ Download the latest binary distribution from [the github releases page](https://
Unzip it into any directory:
[tom@hal tmp]$ unzip -q pmd-bin-6.0.0.zip
[tom@hal tmp]$ unzip -q pmd-bin-{{site.pmd.version}}.zip
[tom@hal tmp]$ ls -l
total 4640
drwxrwxr-x 5 tom tom 4096 Apr 17 16:38 pmd-bin-6.0.0
-rw-rw-r-- 1 tom tom 4733312 Jun 9 15:44 pmd-bin-6.0.0.zip
drwxrwxr-x 5 tom tom 4096 Apr 17 16:38 pmd-bin-{{site.pmd.version}}
-rw-rw-r-- 1 tom tom 4733312 Jun 9 15:44 pmd-bin-{{site.pmd.version}}.zip
[tom@hal tmp]$
@ -61,7 +61,7 @@ specific to the utility used.
Type "./run.sh pmd -d \[filename\|jar or zip file containing source code\|directory] -f \[report format] -R \[ruleset file]", i.e:
/home/user/tmp/pmd-bin-${project.version}/pmd/bin>./run.sh pmd -d /home/user/data/pmd/pmd/test-data/Unused1.java -f xml -R rulesets/java/unusedcode.xml
/home/user/tmp/pmd-bin-{{site.pmd.version}}/pmd/bin>./run.sh pmd -d /home/user/data/pmd/pmd/test-data/Unused1.java -f xml -R rulesets/java/unusedcode.xml
<?xml version="1.0"?><pmd>
<file name="/home/user/data/pmd/pmd/test-data/Unused1.java">
<violation line="5" rule="UnusedLocalVariable">
@ -69,7 +69,7 @@ Type "./run.sh pmd -d \[filename\|jar or zip file containing source code\|direct
</violation>
</file></pmd>
/home/user/tmp/pmd-bin-${project.version}/pmd/bin>
/home/user/tmp/pmd-bin-{{site.pmd.version}}/pmd/bin>
### Basic usage for Windows
@ -78,7 +78,7 @@ You can find PMD's starter batch file `pmd.bat` in the `bin` subdirectory.
Type "pmd -d \[filename\|jar or zip file containing source code\|directory] -f \[report format] -R \[ruleset file]", i.e:
C:\tmp\pmd-bin-${project.version}\pmd\bin>pmd -d c:\data\pmd\pmd\test-data\Unused1.java -f xml -R rulesets/java/unusedcode.xml
C:\tmp\pmd-bin-{{site.pmd.version}}<\pmd\bin>pmd -d c:\data\pmd\pmd\test-data\Unused1.java -f xml -R rulesets/java/unusedcode.xml
<?xml version="1.0"?><pmd>
<file name="c:\data\pmd\pmd\test-data\Unused1.java">
<violation line="5" rule="UnusedLocalVariable">
@ -86,7 +86,7 @@ Type "pmd -d \[filename\|jar or zip file containing source code\|directory] -f \
</violation>
</file></pmd>
C:\tmp\pmd-bin-${project.version}\pmd\bin>
C:\tmp\pmd-bin-{{site.pmd.version}}\pmd\bin>
You can pass a file name, a directory name, or a jar or zip file name containing Java source code to PMD.

10
docs/pages/pmd/userdocs/tools.md
View File

@ -190,7 +190,7 @@ Here's how to set up PMD with Omnicore's CodeGuide:
* Add the following tool to CodeGuide (Tools->Configure Tools->New):
* Name: PMD
* Kind: Tool for directories
* Executable: /Applications/pmd-bin-${project.version}/bin/run.sh
* Executable: /Applications/pmd-bin-{{pmd.site.version}}/bin/run.sh
* Arguments: pmd -d $DIRECTORY_PATH$ -f emacs $USER_ARGUMENTS$
Now you can right click on a source directory, select the PMD tool and a dialog box will appear.
@ -286,7 +286,7 @@ Here's how to set it up as an "External Tool":
* For the next parameter you'll need to plug in the location of your PMD installation
and the rulesets you want to use
* Parameters:
`-cp %CLASSPATH%;c:\pmd\lib\pmd-${project.version}.jar;c:\pmd\lib\asm-3.2.jar;c:\pmd\lib\jaxen-1.1.1.jar net.sourceforge.pmd.PMD "$FilePath$" ideaj unusedcode,imports "$Sourcepath$" $FileClass$.method $FileName$`
`-cp %CLASSPATH%;c:\pmd\lib\pmd-{{pmd.site.version}}.jar;c:\pmd\lib\asm-3.2.jar;c:\pmd\lib\jaxen-1.1.1.jar net.sourceforge.pmd.PMD "$FilePath$" ideaj unusedcode,imports "$Sourcepath$" $FileClass$.method $FileName$`
That's pretty much it. Now you can right click on a source directory and select PMD,
it'll run recursively on the source files, and the results should
@ -535,8 +535,8 @@ The [SQE](http://kenai.com/projects/sqe/) project includes PMD integration for N
* The Java Development Kit, version 1.4.2 (versions 1.4 and higher are acceptable) is properly installed
into your machine, and exists in `D:\java\jdk\_142\`. This means that `D:\java\jdk\_142\bin\java.exe` exists.
* PMD version 5.0 exists in `D:\java\pmd-bin-${project.version}\`.
This means that `D:\java\pmd-bin-${project.version}\lib\pmd-${project.version}.jar` (among other jar files
* PMD version 5.0 exists in `D:\java\pmd-bin-{{pmd.site.version}}\`.
This means that `D:\java\pmd-bin-{{pmd.site.version}}\lib\pmd-{{pmd.site.version}}.jar` (among other jar files
in the same directory) exist.
**To integrate into TextPad**
@ -553,7 +553,7 @@ The [SQE](http://kenai.com/projects/sqe/) project includes PMD integration for N
8. Expand the **Tools** branch (if not already) by clicking on the '`+`' directly to its left.
9. In the expanded list, select **PMD directory**. This changes the right side of this dialog to the "tool" form.
10. In the "tool" form, enter these parameters:
* **Parameters:** `-classpath D:\java\pmd-bin-${project.version}\lib\pmd-${project.version}.jar;D:\java\pmd-bin-${project.version}\lib\asm-3.2.jar;D:\java\pmd-bin-${project.version}\lib\jaxen-1.1.1.jar net.sourceforge.pmd.PMD -d <i><b>$FileDir</b></i> -f net.sourceforge.pmd.renderers.TextPadRenderer -R E:\directory\my_pmd_ruleset.xml -debug`
* **Parameters:** `-classpath D:\java\pmd-bin-{{pmd.site.version}}\lib\pmd-{{pmd.site.version}}.jar;D:\java\pmd-bin-{{pmd.site.version}}\lib\asm-3.2.jar;D:\java\pmd-bin-{{pmd.site.version}}\lib\jaxen-1.1.1.jar net.sourceforge.pmd.PMD -d <i><b>$FileDir</b></i> -f net.sourceforge.pmd.renderers.TextPadRenderer -R E:\directory\my_pmd_ruleset.xml -debug`
* **Initial Folder:** `$FileDir`
* **Save all documents first:** `Checked`
* **Capture output:** `Checked`