You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@zookeeper.apache.org by "Mahadev konar (JIRA)" <ji...@apache.org> on 2008/07/15 01:30:31 UTC

[jira] Created: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Cleaning/restructuring up Zookeeper server code
-----------------------------------------------

                 Key: ZOOKEEPER-74
                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
             Project: Zookeeper
          Issue Type: Improvement
          Components: server
            Reporter: Mahadev konar
            Assignee: Mahadev konar
             Fix For: 3.0.0


I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Benjamin Reed (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12616716#action_12616716 ] 

Benjamin Reed commented on ZOOKEEPER-74:
----------------------------------------

+1 we should coordinate the creation of this patch there are quite a few patches in flight and we don't want to break them. (BTW I had totally missed this mart of the Sun standards. It's a good idea.)

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.0.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "james strachan (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12616518#action_12616518 ] 

james strachan commented on ZOOKEEPER-74:
-----------------------------------------

its a very minor thing, but the contributing guide says to use Sun's coding conventions..

http://wiki.apache.org/hadoop/ZooKeeper/HowToContribute

yet lots of the code tends to litter fields in classes in between methods; its sometimes a bit hard looking at the source to grok what fields are owned by what object. I prefer the Sun standards where all the fields are at the top as most java folks and apache java projects do. 

Though good IDE's can kinda work around this though and so I tend to rely on the outline view in my IDE rather than the source to grok what state a class has :)

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.0.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Patrick Hunt updated ZOOKEEPER-74:
----------------------------------

    Fix Version/s:     (was: 3.2.0)
                   3.3.0
     Release Note: not a blocker for 3.2, moving to 3.3

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.3.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12616765#action_12616765 ] 

Patrick Hunt commented on ZOOKEEPER-74:
---------------------------------------

We may want to use "violations" which hadoop core uses. Integrates into hudson and supports many more tools than just checkstyle.

http://hudson.gotdns.com/wiki/display/HUDSON/Violations
http://hudson.zones.apache.org/hudson/view/Hadoop/job/Hadoop-trunk/

we could bootstrap (taking into accnt ben's comment on in flight patches) using the cleanup/format tools in eclipse, I assume there must be a config that gets you close to the sun std.


> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.0.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12616755#action_12616755 ] 

Patrick Hunt commented on ZOOKEEPER-74:
---------------------------------------

+1 - I always found the field issue james mentioned pretty annoying as well

+1 as well for getting "checkstyle" with customized config into the commit process (doc on howtocommit and report on Hudson) as part of this change. If we're serious about coding conventions we should be able to track/enforce it.



> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.0.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Mahadev konar (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Mahadev konar updated ZOOKEEPER-74:
-----------------------------------

    Fix Version/s:     (was: 3.1.0)
                   3.2.0

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.2.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Krishna Sankar (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12654670#action_12654670 ] 

Krishna Sankar commented on ZOOKEEPER-74:
-----------------------------------------

Couple of quick questions:
a) Do we want to go the route of refactoring the code from a few UML and sequence diagrams or just wing it ?
b) As you guys know the code better, what is the approx effort involved ? Is it a question of cleaning up the object graph (creation et al) or more involved ?
c) What is the time frame for 3.2.0 ? Looks like we couldn't do it in 3.1.0 timeframe.
d) And as Ben poits out, we need to complete the patches in flight even before looking at refactoring.
Cheers
<k/>

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.2.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Patrick Hunt updated ZOOKEEPER-74:
----------------------------------

    Fix Version/s:     (was: 3.0.0)
                   3.1.0

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.1.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Updated: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Mahadev konar (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Mahadev konar updated ZOOKEEPER-74:
-----------------------------------

    Fix Version/s:     (was: 3.3.0)
                   3.4.0

moving this to 3.4. Its definitely worth doing it along with ZOOKEEPER-22 in 3.4.

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.4.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


[jira] Commented: (ZOOKEEPER-74) Cleaning/restructuring up Zookeeper server code

Posted by "Patrick Hunt (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/ZOOKEEPER-74?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12616757#action_12616757 ] 

Patrick Hunt commented on ZOOKEEPER-74:
---------------------------------------

According to the homepage checkstyle already has a "sun coding configuration" config
http://checkstyle.sourceforge.net/

> Cleaning/restructuring up Zookeeper server code
> -----------------------------------------------
>
>                 Key: ZOOKEEPER-74
>                 URL: https://issues.apache.org/jira/browse/ZOOKEEPER-74
>             Project: Zookeeper
>          Issue Type: Improvement
>          Components: server
>            Reporter: Mahadev konar
>            Assignee: Mahadev konar
>             Fix For: 3.0.0
>
>
> I have been thinking this for a while and find that the zookeeper server code needs some cleaning up. The server code is a little tricky/confusing to read sometimes gievn that there is no clearity on ownership of objects. I will put down a proposal for restructuring/cleaning the code up with javadocs so that the code is easier to understand and develop on. comments on what you find confusing are welcome on this jira. 

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.