You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Boris Unckel <bo...@gmx.net> on 2006/01/20 17:36:21 UTC
[logging] Cleanup source before release?
Hello,
is there interest that I spend some time to provide cleanup on the source
files? (Patch will be provided by file)
Learned from the last patch I saw doing right (but too many) things is not
usefull for the reviewer of a patch.
Cleanup means:
- Removing trailing white space
- Change method order (public, protected, package protected, private)
- Same layout on javadoc
Optionally
- Reformat with Eclipse format function. Is there a commons or
commons-logging specific preset available?
More advanced:
Are there source files you seem critical which should not be touched or
files where you think they are candidates?
Regards
Boris
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] Cleanup source before release?
Posted by Stephen Colebourne <sc...@btopenworld.com>.
Boris Unckel wrote:
> Cleanup means:
> - Change method order (public, protected, package protected, private)
Were you a smalltalk programmer? :-)
Personally I find that a very confusing order and prefer to group
methods by what they do. Thus a private helper method that assists a
public method is next to it.
Stephen
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] Cleanup source before release?
Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
On Sun, 2006-01-22 at 01:05 +1300, Simon Kitching wrote:
> On Sat, 2006-01-21 at 10:16 +0100, Boris Unckel wrote:
> > Good Morning,
> >
> > Simon Kitching wrote:
> > > Thanks for your offer Boris, your offer to spend time on JCL is
> > > appreciated. However I would personally prefer not to make these
> > > suggested changes. The code is reasonably ok now, and this just doesn't
> > > gain us anything that I can see.
> > >
> > > If you would like to write some new unit tests, that would be
> > > appreciated; the current test coverage is not great. Be warned, though:
> > > writing unit tests for commons-logging is *not* a trivial exercise!
> > In my initial posting I had Checkstyle[1] and Findbugs[2] in mind. But
> > JUnit is also very important.
> > I see two ways:
> > - I write a short overview what is already tested and post (maybe
> > already with code) what I think what should be covered.
> > - You seem to already have an idea what is not covered and where the
> > focus should be.
> >
> > I would prefer the second way to save time :-)
>
> Unforunately I can't list any specific areas. It's more a case of
> looking at what the code currently does, what the unit tests currently
> test, and seeing what's missing.
the difficult area is classloading.
http://svn.apache.org/repos/asf/jakarta/commons/proper/logging/contrib/demonstration/
contains analysis-with-code of the most common scenarios. AIUI most of
these were ported to unit tests a while ago. what would be useful is
establishing the behaviour in exotic context classloader configurations
and tests to verify that JCL behaves reasonably in these
circumstances.
- robert
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] Cleanup source before release?
Posted by Simon Kitching <sk...@apache.org>.
On Sat, 2006-01-21 at 10:16 +0100, Boris Unckel wrote:
> Good Morning,
>
> Simon Kitching wrote:
> > Thanks for your offer Boris, your offer to spend time on JCL is
> > appreciated. However I would personally prefer not to make these
> > suggested changes. The code is reasonably ok now, and this just doesn't
> > gain us anything that I can see.
> >
> > If you would like to write some new unit tests, that would be
> > appreciated; the current test coverage is not great. Be warned, though:
> > writing unit tests for commons-logging is *not* a trivial exercise!
> In my initial posting I had Checkstyle[1] and Findbugs[2] in mind. But
> JUnit is also very important.
> I see two ways:
> - I write a short overview what is already tested and post (maybe
> already with code) what I think what should be covered.
> - You seem to already have an idea what is not covered and where the
> focus should be.
>
> I would prefer the second way to save time :-)
Unforunately I can't list any specific areas. It's more a case of
looking at what the code currently does, what the unit tests currently
test, and seeing what's missing.
Note, however, that I hope/expect our first release candidate to be
created within the next few days, so you'd have to be pretty quick!
Regards,
Simon
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] Cleanup source before release?
Posted by Boris Unckel <bo...@gmx.net>.
Good Morning,
Simon Kitching wrote:
> Thanks for your offer Boris, your offer to spend time on JCL is
> appreciated. However I would personally prefer not to make these
> suggested changes. The code is reasonably ok now, and this just doesn't
> gain us anything that I can see.
>
> If you would like to write some new unit tests, that would be
> appreciated; the current test coverage is not great. Be warned, though:
> writing unit tests for commons-logging is *not* a trivial exercise!
In my initial posting I had Checkstyle[1] and Findbugs[2] in mind. But
JUnit is also very important.
I see two ways:
- I write a short overview what is already tested and post (maybe
already with code) what I think what should be covered.
- You seem to already have an idea what is not covered and where the
focus should be.
I would prefer the second way to save time :-)
Regards
Boris
[1] http://checkstyle.sourceforge.net/
[2] http://findbugs.sourceforge.net/
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org
Re: [logging] Cleanup source before release?
Posted by Simon Kitching <sk...@apache.org>.
On Fri, 2006-01-20 at 17:36 +0100, Boris Unckel wrote:
> Hello,
>
> is there interest that I spend some time to provide cleanup on the source
> files? (Patch will be provided by file)
>
> Learned from the last patch I saw doing right (but too many) things is not
> usefull for the reviewer of a patch.
>
> Cleanup means:
> - Removing trailing white space
> - Change method order (public, protected, package protected, private)
> - Same layout on javadoc
>
> Optionally
> - Reformat with Eclipse format function. Is there a commons or
> commons-logging specific preset available?
>
> More advanced:
> Are there source files you seem critical which should not be touched or
> files where you think they are candidates?
Thanks for your offer Boris, your offer to spend time on JCL is
appreciated. However I would personally prefer not to make these
suggested changes. The code is reasonably ok now, and this just doesn't
gain us anything that I can see.
If you would like to write some new unit tests, that would be
appreciated; the current test coverage is not great. Be warned, though:
writing unit tests for commons-logging is *not* a trivial exercise!
Regards,
Simon
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org