ace-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Jeremias Maerki (Commented) (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (ACE-185) Checkstyle configuration for Apache ACE
Date Fri, 28 Oct 2011 09:46:32 GMT

    [ https://issues.apache.org/jira/browse/ACE-185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13138199#comment-13138199
] 

Jeremias Maerki commented on ACE-185:
-------------------------------------

Thanks, Marcel. No problem about the empty blocks. I'm fully aware of different styles between
people and between projects. Having a style guide around implies that it should be respected,
thus my contributing the checkstyle file. Common sense is good and a zero warning policies
evil (I know a place where some people really want that (and a zero FindBugs policy, too)).
Interpreting the style guide, I've set many checks to produce "errors", rather than "warnings",
since I did not know how seriously the style guide is to be taken inside the project. I encourage
the Ace team to tweak those settings to their liking. My contribution is just a starting point.
I suggest to leave at least the "tab" check and the "file header" check on "error" level.
Placing the ZIP on the style guide page would not have been my first choice, though. I already
mentioned that I had trouble finding that page. I fear that most people will miss it. Personally,
I'd have added the two files to https://svn.apache.org/repos/asf/incubator/ace/trunk. There
you're bound to stumble over it.
                
> Checkstyle configuration for Apache ACE
> ---------------------------------------
>
>                 Key: ACE-185
>                 URL: https://issues.apache.org/jira/browse/ACE-185
>             Project: Ace
>          Issue Type: Improvement
>            Reporter: Jeremias Maerki
>            Priority: Minor
>         Attachments: checkstyle.zip
>
>
> As promised a Checkstyle configuration file (for version 5.4). I've tried to match the
ACE style guide as closely as possible. Some minor things cannot be checked. And I've had
trouble mapping the empty blocks ({}) which I, BTW, don't like. I recommend to change that
rule to require at least a comment. I believe it's a good idea to explain why a block is left
empty. I've set the severity for WhitespaceAround to warning for now as a consequence.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

Mime
View raw message