[jira] [Updated] (GIRAPH-40) Adding checkstyle enforcement of Giraph code conventions

2012-02-15 Thread Avery Ching (Updated) (JIRA)

 [ 
https://issues.apache.org/jira/browse/GIRAPH-40?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Avery Ching updated GIRAPH-40:
--

Attachment: GIRAPH-40.3.patch

Good suggestion, Jakob.  I have addressed Jakob's comments by changing phases 
from 'compile'-'verify' for checkstyle.  This is the only change I made.  

{noquote}
   execution
-phasecompile/phase
+phaseverify/phase
 goals
{noquote}

We need to require our users to have tested with 'mvn verify' (or 'mvn 
install') before submitting diffs.  This matches the rat approach.

 Adding checkstyle enforcement of Giraph code conventions
 

 Key: GIRAPH-40
 URL: https://issues.apache.org/jira/browse/GIRAPH-40
 Project: Giraph
  Issue Type: New Feature
Reporter: Avery Ching
Assignee: Avery Ching
Priority: Minor
 Attachments: GIRAPH-40.2.patch, GIRAPH-40.3.patch, GIRAPH-40.patch, 
 GIRAPH-40.patch


 Now that we have some code conventions (see GIRAPH-21), we should enforce 
 them with a maven checkstyle plugin.

--
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] (GIRAPH-40) Adding checkstyle enforcement of Giraph code conventions

2012-02-14 Thread Avery Ching (Updated) (JIRA)

 [ 
https://issues.apache.org/jira/browse/GIRAPH-40?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Avery Ching updated GIRAPH-40:
--

Attachment: GIRAPH-40.patch

As promised, here is the full patch.  Due to its massive size, I am not posting 
this to reviewboard.  Here are the details of what I did:

* Created a checkstyle.xml file that follows our CODE_CONVENTIONS as best as 
possible.
* Compiles will now fail if checkstyle guidelines are not met.
* While checkstyle isn't comprehensive, it should reduce our reviewer overhead 
for formatting issues and common code style violations
* Current source code (not test code) now meets checkstyle checks

It passes both the local and MR unittests and also passes rat installation.

Take a look at a few files.  I don't recommend looking at everything since 

$ git diff HEAD^ | grep -P ^(\+|\-) | wc -l
   32848

Let's get this in soon to help us iterate faster and get rid of this technical 
debt!

 Adding checkstyle enforcement of Giraph code conventions
 

 Key: GIRAPH-40
 URL: https://issues.apache.org/jira/browse/GIRAPH-40
 Project: Giraph
  Issue Type: New Feature
Reporter: Avery Ching
Assignee: Avery Ching
Priority: Minor
 Attachments: GIRAPH-40.patch, GIRAPH-40.patch


 Now that we have some code conventions (see GIRAPH-21), we should enforce 
 them with a maven checkstyle plugin.

--
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