jira.codehaus.org

  • Log In Access more options
    • Online Help
    • Keyboard Shortcuts
    • About JIRA
    • JIRA Credits
    • What?s New
  • Dashboards Access more options (Alt+d)
  • Projects Access more options (Alt+p)
  • Issues Access more options (Alt+i)
  • Maven 1.x PMD Plugin
  • MPPMD-20

ruleset names

  • Log In
  • Views
    • XML
    • Word
    • Printable

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Won't Fix
  • Affects Version/s: None
  • Fix Version/s: 1.8
  • Labels:
    None
  • Environment:
    Web browser

Description

Web page http://pmd.sourceforge.net/rules/index.html

The PMD index should include the name of the ruleset for example
Braces Rules is called rulesets/braces.xml
Jakarta Commons Logging Rules is called ??

Activity

Ascending order - Click to sort in descending order
  • All
  • Comments
  • Work Log
  • History
  • Activity
Hide
Permalink
Arnaud Heritier added a comment - 03/Feb/06 5:03 PM

I don't see the interest. You can reopen it with more explanation if you really want it.
I added a link on each error to explain it. Isn't it enough ?

Show
Arnaud Heritier added a comment - 03/Feb/06 5:03 PM I don't see the interest. You can reopen it with more explanation if you really want it. I added a link on each error to explain it. Isn't it enough ?
Hide
Permalink
Sivanandan Srilakshmanan added a comment - 05/Feb/06 6:35 PM

Please allow me to explain the difficulty I face when using PMD Report.

Firstly
-------
If I need to suppress "OnlyOneReturn" under the Controversial Rules I need to specify it as <exclude name="OnlyOneReturnRule"/>

Where as when I need to suppress "CallSuperInConstructor" under the Controversial Rules I need to specify it as <exclude name="CallSuperInConstructor"/>

As you can see there is no document/consistency on the naming of the actual rules.
In "OnlyOneReturn" I need to actually exclude "OnlyOneReturnRule".
On the other hand for CallSuperInConstructor it is not a problem as the rule itself is called "CallSuperInConstructor".

Secondly
--------
Controversial Rules is contained in rulesets/controversial.xml Would Security Code Guidelines be in rulesets/SecurityCodeGuidelines.xml

If I am incorrect then I am sorry for creating the confusion and would much appreciate clarification on the correct usage or a methodical approach to finding the rules and rule set.

If I am correct, then I feel that the "rulesets/SecurityCodeGuidelines.xml" should be included as part of the heading. For example "Security Code Guidelines : rulesets/SecurityCodeGuidelines.xml"
and the rule to be the name itself. ie instead of calling OnlyOneReturn" under the Controversial Rules, call it OnlyOneReturnRule.

Thanks
Lakshman

Show
Sivanandan Srilakshmanan added a comment - 05/Feb/06 6:35 PM Please allow me to explain the difficulty I face when using PMD Report. Firstly ------- If I need to suppress "OnlyOneReturn" under the Controversial Rules I need to specify it as <exclude name="OnlyOneReturnRule"/> Where as when I need to suppress "CallSuperInConstructor" under the Controversial Rules I need to specify it as <exclude name="CallSuperInConstructor"/> As you can see there is no document/consistency on the naming of the actual rules. In "OnlyOneReturn" I need to actually exclude "OnlyOneReturnRule". On the other hand for CallSuperInConstructor it is not a problem as the rule itself is called "CallSuperInConstructor". Secondly -------- Controversial Rules is contained in rulesets/controversial.xml Would Security Code Guidelines be in rulesets/SecurityCodeGuidelines.xml If I am incorrect then I am sorry for creating the confusion and would much appreciate clarification on the correct usage or a methodical approach to finding the rules and rule set. If I am correct, then I feel that the "rulesets/SecurityCodeGuidelines.xml" should be included as part of the heading. For example "Security Code Guidelines : rulesets/SecurityCodeGuidelines.xml" and the rule to be the name itself. ie instead of calling OnlyOneReturn" under the Controversial Rules, call it OnlyOneReturnRule. Thanks Lakshman

People

  • Assignee:
    Unassigned
    Reporter:
    Sivanandan Srilakshmanan
Vote (0)
Watch (0)

Dates

  • Created:
    08/Sep/05 8:01 PM
    Updated:
    05/Feb/06 6:35 PM
    Resolved:
    03/Feb/06 5:03 PM
  • Atlassian JIRA (v5.0.4#731-sha1:3aa7374)
  • Report a problem
  • Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.