You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ivy-dev@incubator.apache.org by Xavier Hanin <xa...@gmail.com> on 2007/06/01 07:11:06 UTC
Re: cleaning code (was Re: [Patch] Javadoc & style
OK, I'll apply the patch, clean the code and review eol next tuesday. Please
plan your commits accordingly.
Xavier
On 5/31/07, Maarten Coene <ma...@yahoo.com> wrote:
>
> I have no pending changes, so please go ahead: apply the patch, format the
> code with Eclipse and commit everything to SVN.
> A line length of 100 is fine for me as well :-)
>
> Maarten
>
>
> ----- Original Message ----
> From: Xavier Hanin <xa...@gmail.com>
> To: ivy-dev@incubator.apache.org
> Sent: Thursday, May 31, 2007 9:12:48 AM
> Subject: cleaning code (was Re: [Patch] Javadoc & style)
>
> Hi,
>
> We discussed recently about using the eclipse tool to clean up the code to
> decrease our number of checkstyle errors/warnings.
>
> Gilles now you have committed your changes, could we agree on a day where
> we
> could make sure we have no pending changes so that one of us can run the
> tool and commit the cleaned up code without needing a merge?
>
> Before we should apply the patch from Stephane:
> https://issues.apache.org/jira/browse/IVY-518
>
> On my side I have no pending changes, so any day is ok. I'm ok to apply
> the
> patch and run the clean up tool, I will have time to do it next week. If
> anybody else prefer to do it, I'd be happy to oblige :-)
>
> We also have to agree on maximum line length, is 100 (the current setting
> of
> checkstyle, borrowed from Ant) ok for everybody?
>
> Xavier
>
> On 5/24/07, Xavier Hanin <xa...@gmail.com> wrote:
> >
> > On 5/24/07, Gilles Scokart <gs...@gmail.com> wrote:
> > >
> > > Yes, I have pending changes about the buildlist. I'm waiting my
> > > userID to commit them.
> > >
> > > Do you think eclipse formater will really reduce the number of errors
> > > reported by CheckStyle? If yes, it might be a good idea, but I'm not
> > > sure it will.
> >
> >
> > Eclipse can fix a lot of code style errors, like import rules,
> > indentation, spaces, line length and so on. So I think it would reduce
> the
> > number of errors significantly and easily.
> >
> > I just have one remarks with the eclipse formating using Sun standard
> > > : the default width of 80 characters is too small. A bigger value
> > > should be used (120 maybe?).
> >
> >
> > I agree 80 is too small. The checkstyle rules Maarten has added set it
> to
> > 100, I think it's the same as for ant (I think the rules we use for the
> > moment are the same as for ant). Personally I use a wide screen, so long
> > lines are not a big issue for me, but I understand they make lines less
> > readable and more difficult to debug. So maybe 100 is a good compromise.
> >
> > Opinions?
> >
> > Xavier
> >
> > Gilles
> > >
> > >
> > > 2007/5/24, Xavier Hanin < xavier.hanin@gmail.com>:
> > > > I don't see the patch either.
> > > >
> > > > I've created a JIRA issue for this kind of patch:
> > > > https://issues.apache.org/jira/browse/IVY-515
> > > >
> > > > This will avoid to create one issue for each patch, which doesn't
> > > really
> > > > make sense.
> > > >
> > > > BTW, for the coding style problems, maybe we could use a tool to
> make
> > > things
> > > > cleaner. Eclipse has a pretty good tool to clean code and make it
> > > closer to
> > > > coding conventions. Running it is pretty simple, and since we agreed
> > > on the
> > > > standard coding convention, we don't even to configure it. The main
> > > problem
> > > > is to synchronize among developers to know who and when this will be
> > > done,
> > > > because it may result in a lot of conflict for subsequent merges.
> This
> > > also
> > > > mean that patch currently in JIRA will be more difficult to apply.
> But
> > > this
> > > > is the only way I see to reduce significantly the number of
> checkstyle
> > >
> > > > errors (this won't fix the _ prefix, but it will fix a lot of more
> > > trivial
> > > > errors).
> > > >
> > > > So, what do you think? Should we use this tool? If so, when? Do you
> > > have
> > > > pending changes in your code base?
> > > >
> > > > Xavier
> > > >
> > > > On 5/24/07, Gilles Scokart <gs...@gmail.com> wrote:
> > > > >
> > > > > Sorry, I didn't see your patch. Was it suposed to be attached to
> > > the
> > > > > mail?
> > > > >
> > > > > You could maybe add a Jira issue for it.
> > > > >
> > > > > Thanks,
> > > > >
> > > > > Gilles
> > > > >
> > > > > 2007/5/24, Kevin Jackson < foamdino@gmail.com>:
> > > > > > Hi all,
> > > > > >
> > > > > > Here are some javadoc and style changes to make Ivy conform
> > > (slightly)
> > > > > > more with the Apache style - hopefully kill off some checkstyle
> > > > > > warnings :)
> > > > > >
> > > > > > Kev
> > > > > >
> > > > >
> > > > >
> > > > > --
> > > > > Gilles SCOKART
> > > > >
> > > >
> > > >
> > > >
> > > > --
> > > > Xavier Hanin - Independent Java Consultant
> > > > Manage your dependencies with Ivy!
> > > > http://incubator.apache.org/ivy/
> > > >
> > >
> > >
> > > --
> > > Gilles SCOKART
> > >
> >
> >
> >
> > --
> > Xavier Hanin - Independent Java Consultant
> > Manage your dependencies with Ivy!
> > http://incubator.apache.org/ivy/
> >
>
>
>
> --
> Xavier Hanin - Independent Java Consultant
> Manage your dependencies with Ivy!
> http://incubator.apache.org/ivy/
>
>
>
>
>
>
> ____________________________________________________________________________________
> Luggage? GPS? Comic books?
> Check out fitting gifts for grads at Yahoo! Search
> http://search.yahoo.com/search?fr=oni_on_mail&p=graduation+gifts&cs=bz
>
--
Xavier Hanin - Independent Java Consultant
Manage your dependencies with Ivy!
http://incubator.apache.org/ivy/
Re: cleaning code (was Re: [Patch] Javadoc & style
Posted by Xavier Hanin <xa...@gmail.com>.
On 6/5/07, Gilles Scokart <gs...@gmail.com> wrote:
>
> Well done. Thanks to have it done.
>
> Did someone have experience using a checkstyle eclipse plugin? I think
> there is 2 plugins that report checkstyle errors/warnings directly into
> eclipse. I guess it will make it easier to do the fix progressively.
I have some experience with this one:
http://eclipse-cs.sourceforge.net/
The other one seems to be much less maintained than eclipse-cs. Eclipse-cs
work well, even though I find the configuration not very intuitive
(especially when you want to use an existing config). But I've done the
config for Ivy, I can check it in, then all you need is installing the
plugin. This can indeed help to fix the problems progressively.
I'll check in the config in a moment.
Xavier
Gilles
>
>
> > -----Original Message-----
> > From: Xavier Hanin [mailto:xavier.hanin@gmail.com]
> > Sent: mardi 5 juin 2007 16:01
> > To: ivy-dev@incubator.apache.org
> > Subject: Re: cleaning code (was Re: [Patch] Javadoc & style
> >
> > Hi,
> >
> > As planned last week, I've applied stephane's patch, configured and ran
> > eclipse formatter, and fix eols in our code base.
> >
> > I recommend to update your working copies before doing any new change.
> >
> > The number of checkstyle errors has been decreased from 22000+ to less
> > than
> > 5000. It's a nice decrease, but 5000 is still far too much for 280 files
> > :)
> > Hence for the moment I've removed the javadoc checks which will take
> more
> > time to fix. Without javadoc errors we still have about 1600 errors, a
> > large
> > amount is due to naming conventions (use of _ prefix).
> >
> > We now have to find time to fix checkstyle errors from time to time, to
> > decrease this number significantly. Then we'll be able to restore
> javadoc
> > rules and try to fix them too.
> >
> > Xavier
> >
> > On 6/1/07, Xavier Hanin <xa...@gmail.com> wrote:
> > >
> > > OK, I'll apply the patch, clean the code and review eol next tuesday.
> > > Please plan your commits accordingly.
> > >
> > > Xavier
> > >
> > > On 5/31/07, Maarten Coene < maarten_coene@yahoo.com> wrote:
> > > >
> > > > I have no pending changes, so please go ahead: apply the patch,
> format
> > > > the code with Eclipse and commit everything to SVN.
> > > > A line length of 100 is fine for me as well :-)
> > > >
> > > > Maarten
> > > >
> > > >
> > > > ----- Original Message ----
> > > > From: Xavier Hanin <xa...@gmail.com>
> > > > To: ivy-dev@incubator.apache.org
> > > > Sent: Thursday, May 31, 2007 9:12:48 AM
> > > > Subject: cleaning code (was Re: [Patch] Javadoc & style)
> > > >
> > > > Hi,
> > > >
> > > > We discussed recently about using the eclipse tool to clean up the
> > code
> > > > to
> > > > decrease our number of checkstyle errors/warnings.
> > > >
> > > > Gilles now you have committed your changes, could we agree on a day
> > > > where we
> > > > could make sure we have no pending changes so that one of us can run
> > the
> > > > tool and commit the cleaned up code without needing a merge?
> > > >
> > > > Before we should apply the patch from Stephane:
> > > > https://issues.apache.org/jira/browse/IVY-518
> > > >
> > > > On my side I have no pending changes, so any day is ok. I'm ok to
> > apply
> > > > the
> > > > patch and run the clean up tool, I will have time to do it next
> week.
> > If
> > > > anybody else prefer to do it, I'd be happy to oblige :-)
> > > >
> > > > We also have to agree on maximum line length, is 100 (the current
> > > > setting of
> > > > checkstyle, borrowed from Ant) ok for everybody?
> > > >
> > > > Xavier
> > > >
> > > > On 5/24/07, Xavier Hanin <xa...@gmail.com> wrote:
> > > > >
> > > > > On 5/24/07, Gilles Scokart < gscokart@gmail.com> wrote:
> > > > > >
> > > > > > Yes, I have pending changes about the buildlist. I'm waiting my
> > > > > > userID to commit them.
> > > > > >
> > > > > > Do you think eclipse formater will really reduce the number of
> > > > errors
> > > > > > reported by CheckStyle? If yes, it might be a good idea, but
> I'm
> > > > not
> > > > > > sure it will.
> > > > >
> > > > >
> > > > > Eclipse can fix a lot of code style errors, like import rules,
> > > > > indentation, spaces, line length and so on. So I think it would
> > reduce
> > > > the
> > > > > number of errors significantly and easily.
> > > > >
> > > > > I just have one remarks with the eclipse formating using Sun
> > standard
> > > > > > : the default width of 80 characters is too small. A bigger
> value
> > > > > > should be used (120 maybe?).
> > > > >
> > > > >
> > > > > I agree 80 is too small. The checkstyle rules Maarten has added
> set
> > it
> > > > to
> > > > > 100, I think it's the same as for ant (I think the rules we use
> for
> > > > the
> > > > > moment are the same as for ant). Personally I use a wide screen,
> so
> > > > long
> > > > > lines are not a big issue for me, but I understand they make lines
> > > > less
> > > > > readable and more difficult to debug. So maybe 100 is a good
> > > > compromise.
> > > > >
> > > > > Opinions?
> > > > >
> > > > > Xavier
> > > > >
> > > > > Gilles
> > > > > >
> > > > > >
> > > > > > 2007/5/24, Xavier Hanin < xavier.hanin@gmail.com>:
> > > > > > > I don't see the patch either.
> > > > > > >
> > > > > > > I've created a JIRA issue for this kind of patch:
> > > > > > > https://issues.apache.org/jira/browse/IVY-515
> > > > > > >
> > > > > > > This will avoid to create one issue for each patch, which
> > doesn't
> > > > > > really
> > > > > > > make sense.
> > > > > > >
> > > > > > > BTW, for the coding style problems, maybe we could use a tool
> to
> > > > make
> > > > > > things
> > > > > > > cleaner. Eclipse has a pretty good tool to clean code and make
> > it
> > > > > > closer to
> > > > > > > coding conventions. Running it is pretty simple, and since we
> > > > agreed
> > > > > > on the
> > > > > > > standard coding convention, we don't even to configure it. The
> > > > main
> > > > > > problem
> > > > > > > is to synchronize among developers to know who and when this
> > will
> > > > be
> > > > > > done,
> > > > > > > because it may result in a lot of conflict for subsequent
> > merges.
> > > > This
> > > > > > also
> > > > > > > mean that patch currently in JIRA will be more difficult to
> > apply.
> > > > But
> > > > > > this
> > > > > > > is the only way I see to reduce significantly the number of
> > > > checkstyle
> > > > > >
> > > > > > > errors (this won't fix the _ prefix, but it will fix a lot of
> > more
> > > > > > trivial
> > > > > > > errors).
> > > > > > >
> > > > > > > So, what do you think? Should we use this tool? If so, when?
> Do
> > > > you
> > > > > > have
> > > > > > > pending changes in your code base?
> > > > > > >
> > > > > > > Xavier
> > > > > > >
> > > > > > > On 5/24/07, Gilles Scokart <gscokart@gmail.com > wrote:
> > > > > > > >
> > > > > > > > Sorry, I didn't see your patch. Was it suposed to be
> attached
> > > > to
> > > > > > the
> > > > > > > > mail?
> > > > > > > >
> > > > > > > > You could maybe add a Jira issue for it.
> > > > > > > >
> > > > > > > > Thanks,
> > > > > > > >
> > > > > > > > Gilles
> > > > > > > >
> > > > > > > > 2007/5/24, Kevin Jackson < foamdino@gmail.com >:
> > > > > > > > > Hi all,
> > > > > > > > >
> > > > > > > > > Here are some javadoc and style changes to make Ivy
> conform
> > > > > > (slightly)
> > > > > > > > > more with the Apache style - hopefully kill off some
> > > > checkstyle
> > > > > > > > > warnings :)
> > > > > > > > >
> > > > > > > > > Kev
> > > > > > > > >
> > > > > > > >
> > > > > > > >
> > > > > > > > --
> > > > > > > > Gilles SCOKART
> > > > > > > >
> > > > > > >
> > > > > > >
> > > > > > >
> > > > > > > --
> > > > > > > Xavier Hanin - Independent Java Consultant
> > > > > > > Manage your dependencies with Ivy!
> > > > > > > http://incubator.apache.org/ivy/
> > > > > > >
> > > > > >
> > > > > >
> > > > > > --
> > > > > > Gilles SCOKART
> > > > > >
> > > > >
> > > > >
> > > > >
> > > > > --
> > > > > Xavier Hanin - Independent Java Consultant
> > > > > Manage your dependencies with Ivy!
> > > > > http://incubator.apache.org/ivy/
> > > > >
> > > >
> > > >
> > > >
> > > > --
> > > > Xavier Hanin - Independent Java Consultant
> > > > Manage your dependencies with Ivy!
> > > > http://incubator.apache.org/ivy/
> > > >
> > > >
> > > >
> > > >
> > > >
> > > >
> > > >
> >
> __________________________________________________________________________
> > __________
> > > > Luggage? GPS? Comic books?
> > > > Check out fitting gifts for grads at Yahoo! Search
> > > >
> http://search.yahoo.com/search?fr=oni_on_mail&p=graduation+gifts&cs=bz
> > > >
> > >
> > >
> > >
> > > --
> > > Xavier Hanin - Independent Java Consultant
> > > Manage your dependencies with Ivy!
> > > http://incubator.apache.org/ivy/
> > >
> >
> >
> >
> > --
> > Xavier Hanin - Independent Java Consultant
> > Manage your dependencies with Ivy!
> > http://incubator.apache.org/ivy/
>
>
--
Xavier Hanin - Independent Java Consultant
Manage your dependencies with Ivy!
http://incubator.apache.org/ivy/
RE: cleaning code (was Re: [Patch] Javadoc & style
Posted by Gilles Scokart <gs...@gmail.com>.
Well done. Thanks to have it done.
Did someone have experience using a checkstyle eclipse plugin? I think
there is 2 plugins that report checkstyle errors/warnings directly into
eclipse. I guess it will make it easier to do the fix progressively.
Gilles
> -----Original Message-----
> From: Xavier Hanin [mailto:xavier.hanin@gmail.com]
> Sent: mardi 5 juin 2007 16:01
> To: ivy-dev@incubator.apache.org
> Subject: Re: cleaning code (was Re: [Patch] Javadoc & style
>
> Hi,
>
> As planned last week, I've applied stephane's patch, configured and ran
> eclipse formatter, and fix eols in our code base.
>
> I recommend to update your working copies before doing any new change.
>
> The number of checkstyle errors has been decreased from 22000+ to less
> than
> 5000. It's a nice decrease, but 5000 is still far too much for 280 files
> :)
> Hence for the moment I've removed the javadoc checks which will take more
> time to fix. Without javadoc errors we still have about 1600 errors, a
> large
> amount is due to naming conventions (use of _ prefix).
>
> We now have to find time to fix checkstyle errors from time to time, to
> decrease this number significantly. Then we'll be able to restore javadoc
> rules and try to fix them too.
>
> Xavier
>
> On 6/1/07, Xavier Hanin <xa...@gmail.com> wrote:
> >
> > OK, I'll apply the patch, clean the code and review eol next tuesday.
> > Please plan your commits accordingly.
> >
> > Xavier
> >
> > On 5/31/07, Maarten Coene < maarten_coene@yahoo.com> wrote:
> > >
> > > I have no pending changes, so please go ahead: apply the patch, format
> > > the code with Eclipse and commit everything to SVN.
> > > A line length of 100 is fine for me as well :-)
> > >
> > > Maarten
> > >
> > >
> > > ----- Original Message ----
> > > From: Xavier Hanin <xa...@gmail.com>
> > > To: ivy-dev@incubator.apache.org
> > > Sent: Thursday, May 31, 2007 9:12:48 AM
> > > Subject: cleaning code (was Re: [Patch] Javadoc & style)
> > >
> > > Hi,
> > >
> > > We discussed recently about using the eclipse tool to clean up the
> code
> > > to
> > > decrease our number of checkstyle errors/warnings.
> > >
> > > Gilles now you have committed your changes, could we agree on a day
> > > where we
> > > could make sure we have no pending changes so that one of us can run
> the
> > > tool and commit the cleaned up code without needing a merge?
> > >
> > > Before we should apply the patch from Stephane:
> > > https://issues.apache.org/jira/browse/IVY-518
> > >
> > > On my side I have no pending changes, so any day is ok. I'm ok to
> apply
> > > the
> > > patch and run the clean up tool, I will have time to do it next week.
> If
> > > anybody else prefer to do it, I'd be happy to oblige :-)
> > >
> > > We also have to agree on maximum line length, is 100 (the current
> > > setting of
> > > checkstyle, borrowed from Ant) ok for everybody?
> > >
> > > Xavier
> > >
> > > On 5/24/07, Xavier Hanin <xa...@gmail.com> wrote:
> > > >
> > > > On 5/24/07, Gilles Scokart < gscokart@gmail.com> wrote:
> > > > >
> > > > > Yes, I have pending changes about the buildlist. I'm waiting my
> > > > > userID to commit them.
> > > > >
> > > > > Do you think eclipse formater will really reduce the number of
> > > errors
> > > > > reported by CheckStyle? If yes, it might be a good idea, but I'm
> > > not
> > > > > sure it will.
> > > >
> > > >
> > > > Eclipse can fix a lot of code style errors, like import rules,
> > > > indentation, spaces, line length and so on. So I think it would
> reduce
> > > the
> > > > number of errors significantly and easily.
> > > >
> > > > I just have one remarks with the eclipse formating using Sun
> standard
> > > > > : the default width of 80 characters is too small. A bigger value
> > > > > should be used (120 maybe?).
> > > >
> > > >
> > > > I agree 80 is too small. The checkstyle rules Maarten has added set
> it
> > > to
> > > > 100, I think it's the same as for ant (I think the rules we use for
> > > the
> > > > moment are the same as for ant). Personally I use a wide screen, so
> > > long
> > > > lines are not a big issue for me, but I understand they make lines
> > > less
> > > > readable and more difficult to debug. So maybe 100 is a good
> > > compromise.
> > > >
> > > > Opinions?
> > > >
> > > > Xavier
> > > >
> > > > Gilles
> > > > >
> > > > >
> > > > > 2007/5/24, Xavier Hanin < xavier.hanin@gmail.com>:
> > > > > > I don't see the patch either.
> > > > > >
> > > > > > I've created a JIRA issue for this kind of patch:
> > > > > > https://issues.apache.org/jira/browse/IVY-515
> > > > > >
> > > > > > This will avoid to create one issue for each patch, which
> doesn't
> > > > > really
> > > > > > make sense.
> > > > > >
> > > > > > BTW, for the coding style problems, maybe we could use a tool to
> > > make
> > > > > things
> > > > > > cleaner. Eclipse has a pretty good tool to clean code and make
> it
> > > > > closer to
> > > > > > coding conventions. Running it is pretty simple, and since we
> > > agreed
> > > > > on the
> > > > > > standard coding convention, we don't even to configure it. The
> > > main
> > > > > problem
> > > > > > is to synchronize among developers to know who and when this
> will
> > > be
> > > > > done,
> > > > > > because it may result in a lot of conflict for subsequent
> merges.
> > > This
> > > > > also
> > > > > > mean that patch currently in JIRA will be more difficult to
> apply.
> > > But
> > > > > this
> > > > > > is the only way I see to reduce significantly the number of
> > > checkstyle
> > > > >
> > > > > > errors (this won't fix the _ prefix, but it will fix a lot of
> more
> > > > > trivial
> > > > > > errors).
> > > > > >
> > > > > > So, what do you think? Should we use this tool? If so, when? Do
> > > you
> > > > > have
> > > > > > pending changes in your code base?
> > > > > >
> > > > > > Xavier
> > > > > >
> > > > > > On 5/24/07, Gilles Scokart <gscokart@gmail.com > wrote:
> > > > > > >
> > > > > > > Sorry, I didn't see your patch. Was it suposed to be attached
> > > to
> > > > > the
> > > > > > > mail?
> > > > > > >
> > > > > > > You could maybe add a Jira issue for it.
> > > > > > >
> > > > > > > Thanks,
> > > > > > >
> > > > > > > Gilles
> > > > > > >
> > > > > > > 2007/5/24, Kevin Jackson < foamdino@gmail.com >:
> > > > > > > > Hi all,
> > > > > > > >
> > > > > > > > Here are some javadoc and style changes to make Ivy conform
> > > > > (slightly)
> > > > > > > > more with the Apache style - hopefully kill off some
> > > checkstyle
> > > > > > > > warnings :)
> > > > > > > >
> > > > > > > > Kev
> > > > > > > >
> > > > > > >
> > > > > > >
> > > > > > > --
> > > > > > > Gilles SCOKART
> > > > > > >
> > > > > >
> > > > > >
> > > > > >
> > > > > > --
> > > > > > Xavier Hanin - Independent Java Consultant
> > > > > > Manage your dependencies with Ivy!
> > > > > > http://incubator.apache.org/ivy/
> > > > > >
> > > > >
> > > > >
> > > > > --
> > > > > Gilles SCOKART
> > > > >
> > > >
> > > >
> > > >
> > > > --
> > > > Xavier Hanin - Independent Java Consultant
> > > > Manage your dependencies with Ivy!
> > > > http://incubator.apache.org/ivy/
> > > >
> > >
> > >
> > >
> > > --
> > > Xavier Hanin - Independent Java Consultant
> > > Manage your dependencies with Ivy!
> > > http://incubator.apache.org/ivy/
> > >
> > >
> > >
> > >
> > >
> > >
> > >
> __________________________________________________________________________
> __________
> > > Luggage? GPS? Comic books?
> > > Check out fitting gifts for grads at Yahoo! Search
> > > http://search.yahoo.com/search?fr=oni_on_mail&p=graduation+gifts&cs=bz
> > >
> >
> >
> >
> > --
> > Xavier Hanin - Independent Java Consultant
> > Manage your dependencies with Ivy!
> > http://incubator.apache.org/ivy/
> >
>
>
>
> --
> Xavier Hanin - Independent Java Consultant
> Manage your dependencies with Ivy!
> http://incubator.apache.org/ivy/
Re: cleaning code (was Re: [Patch] Javadoc & style
Posted by Xavier Hanin <xa...@gmail.com>.
Hi,
As planned last week, I've applied stephane's patch, configured and ran
eclipse formatter, and fix eols in our code base.
I recommend to update your working copies before doing any new change.
The number of checkstyle errors has been decreased from 22000+ to less than
5000. It's a nice decrease, but 5000 is still far too much for 280 files :)
Hence for the moment I've removed the javadoc checks which will take more
time to fix. Without javadoc errors we still have about 1600 errors, a large
amount is due to naming conventions (use of _ prefix).
We now have to find time to fix checkstyle errors from time to time, to
decrease this number significantly. Then we'll be able to restore javadoc
rules and try to fix them too.
Xavier
On 6/1/07, Xavier Hanin <xa...@gmail.com> wrote:
>
> OK, I'll apply the patch, clean the code and review eol next tuesday.
> Please plan your commits accordingly.
>
> Xavier
>
> On 5/31/07, Maarten Coene < maarten_coene@yahoo.com> wrote:
> >
> > I have no pending changes, so please go ahead: apply the patch, format
> > the code with Eclipse and commit everything to SVN.
> > A line length of 100 is fine for me as well :-)
> >
> > Maarten
> >
> >
> > ----- Original Message ----
> > From: Xavier Hanin <xa...@gmail.com>
> > To: ivy-dev@incubator.apache.org
> > Sent: Thursday, May 31, 2007 9:12:48 AM
> > Subject: cleaning code (was Re: [Patch] Javadoc & style)
> >
> > Hi,
> >
> > We discussed recently about using the eclipse tool to clean up the code
> > to
> > decrease our number of checkstyle errors/warnings.
> >
> > Gilles now you have committed your changes, could we agree on a day
> > where we
> > could make sure we have no pending changes so that one of us can run the
> > tool and commit the cleaned up code without needing a merge?
> >
> > Before we should apply the patch from Stephane:
> > https://issues.apache.org/jira/browse/IVY-518
> >
> > On my side I have no pending changes, so any day is ok. I'm ok to apply
> > the
> > patch and run the clean up tool, I will have time to do it next week. If
> > anybody else prefer to do it, I'd be happy to oblige :-)
> >
> > We also have to agree on maximum line length, is 100 (the current
> > setting of
> > checkstyle, borrowed from Ant) ok for everybody?
> >
> > Xavier
> >
> > On 5/24/07, Xavier Hanin <xa...@gmail.com> wrote:
> > >
> > > On 5/24/07, Gilles Scokart < gscokart@gmail.com> wrote:
> > > >
> > > > Yes, I have pending changes about the buildlist. I'm waiting my
> > > > userID to commit them.
> > > >
> > > > Do you think eclipse formater will really reduce the number of
> > errors
> > > > reported by CheckStyle? If yes, it might be a good idea, but I'm
> > not
> > > > sure it will.
> > >
> > >
> > > Eclipse can fix a lot of code style errors, like import rules,
> > > indentation, spaces, line length and so on. So I think it would reduce
> > the
> > > number of errors significantly and easily.
> > >
> > > I just have one remarks with the eclipse formating using Sun standard
> > > > : the default width of 80 characters is too small. A bigger value
> > > > should be used (120 maybe?).
> > >
> > >
> > > I agree 80 is too small. The checkstyle rules Maarten has added set it
> > to
> > > 100, I think it's the same as for ant (I think the rules we use for
> > the
> > > moment are the same as for ant). Personally I use a wide screen, so
> > long
> > > lines are not a big issue for me, but I understand they make lines
> > less
> > > readable and more difficult to debug. So maybe 100 is a good
> > compromise.
> > >
> > > Opinions?
> > >
> > > Xavier
> > >
> > > Gilles
> > > >
> > > >
> > > > 2007/5/24, Xavier Hanin < xavier.hanin@gmail.com>:
> > > > > I don't see the patch either.
> > > > >
> > > > > I've created a JIRA issue for this kind of patch:
> > > > > https://issues.apache.org/jira/browse/IVY-515
> > > > >
> > > > > This will avoid to create one issue for each patch, which doesn't
> > > > really
> > > > > make sense.
> > > > >
> > > > > BTW, for the coding style problems, maybe we could use a tool to
> > make
> > > > things
> > > > > cleaner. Eclipse has a pretty good tool to clean code and make it
> > > > closer to
> > > > > coding conventions. Running it is pretty simple, and since we
> > agreed
> > > > on the
> > > > > standard coding convention, we don't even to configure it. The
> > main
> > > > problem
> > > > > is to synchronize among developers to know who and when this will
> > be
> > > > done,
> > > > > because it may result in a lot of conflict for subsequent merges.
> > This
> > > > also
> > > > > mean that patch currently in JIRA will be more difficult to apply.
> > But
> > > > this
> > > > > is the only way I see to reduce significantly the number of
> > checkstyle
> > > >
> > > > > errors (this won't fix the _ prefix, but it will fix a lot of more
> > > > trivial
> > > > > errors).
> > > > >
> > > > > So, what do you think? Should we use this tool? If so, when? Do
> > you
> > > > have
> > > > > pending changes in your code base?
> > > > >
> > > > > Xavier
> > > > >
> > > > > On 5/24/07, Gilles Scokart <gscokart@gmail.com > wrote:
> > > > > >
> > > > > > Sorry, I didn't see your patch. Was it suposed to be attached
> > to
> > > > the
> > > > > > mail?
> > > > > >
> > > > > > You could maybe add a Jira issue for it.
> > > > > >
> > > > > > Thanks,
> > > > > >
> > > > > > Gilles
> > > > > >
> > > > > > 2007/5/24, Kevin Jackson < foamdino@gmail.com >:
> > > > > > > Hi all,
> > > > > > >
> > > > > > > Here are some javadoc and style changes to make Ivy conform
> > > > (slightly)
> > > > > > > more with the Apache style - hopefully kill off some
> > checkstyle
> > > > > > > warnings :)
> > > > > > >
> > > > > > > Kev
> > > > > > >
> > > > > >
> > > > > >
> > > > > > --
> > > > > > Gilles SCOKART
> > > > > >
> > > > >
> > > > >
> > > > >
> > > > > --
> > > > > Xavier Hanin - Independent Java Consultant
> > > > > Manage your dependencies with Ivy!
> > > > > http://incubator.apache.org/ivy/
> > > > >
> > > >
> > > >
> > > > --
> > > > Gilles SCOKART
> > > >
> > >
> > >
> > >
> > > --
> > > Xavier Hanin - Independent Java Consultant
> > > Manage your dependencies with Ivy!
> > > http://incubator.apache.org/ivy/
> > >
> >
> >
> >
> > --
> > Xavier Hanin - Independent Java Consultant
> > Manage your dependencies with Ivy!
> > http://incubator.apache.org/ivy/
> >
> >
> >
> >
> >
> >
> > ____________________________________________________________________________________
> > Luggage? GPS? Comic books?
> > Check out fitting gifts for grads at Yahoo! Search
> > http://search.yahoo.com/search?fr=oni_on_mail&p=graduation+gifts&cs=bz
> >
>
>
>
> --
> Xavier Hanin - Independent Java Consultant
> Manage your dependencies with Ivy!
> http://incubator.apache.org/ivy/
>
--
Xavier Hanin - Independent Java Consultant
Manage your dependencies with Ivy!
http://incubator.apache.org/ivy/