You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@ace.apache.org by "Jeremias Maerki (Created) (JIRA)" <ji...@apache.org> on 2011/10/05 14:50:34 UTC
[jira] [Created] (ACE-185) Checkstyle configuration for Apache ACE
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
[jira] [Resolved] (ACE-185) Checkstyle configuration for Apache ACE
Posted by "Marcel Offermans (Resolved) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACE-185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Marcel Offermans resolved ACE-185.
----------------------------------
Resolution: Fixed
Added the provided zip file to the coding style guide, so people can easily find and download 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
[jira] [Commented] (ACE-185) Checkstyle configuration for Apache
ACE
Posted by "Marcel Offermans (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACE-185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13138174#comment-13138174 ]
Marcel Offermans commented on ACE-185:
--------------------------------------
Thanks a lot Jeremias for this contribution. Whilst I agree that it makes sense to add comments to the source code to document things like empty blocks, or more in general, to comment on any "non standard" construct you use in your code, I'm not directly in favor of changing the style guide for it. For one, style guides to me should not be set in stone and should ever prevail over common sense. Furthermore, I think that if you ask enough developers, you will get different views and preferences for a style guide, so we have to make some decisions and stick with them I guess.
> 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
[jira] [Commented] (ACE-185) Checkstyle configuration for Apache
ACE
Posted by "Jeremias Maerki (Commented) (JIRA)" <ji...@apache.org>.
[ 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
[jira] [Commented] (ACE-185) Checkstyle configuration for Apache
ACE
Posted by "Marcel Offermans (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACE-185?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13138237#comment-13138237 ]
Marcel Offermans commented on ACE-185:
--------------------------------------
Now why did I not think of that... :) Great idea, I'll move the files to svn!
> 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
[jira] [Updated] (ACE-185) Checkstyle configuration for Apache ACE
Posted by "Jeremias Maerki (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/ACE-185?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jeremias Maerki updated ACE-185:
--------------------------------
Attachment: checkstyle.zip
> 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