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 Kevin Jackson <fo...@gmail.com> on 2007/05/24 04:28:35 UTC
[Patch] Javadoc & style
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
Re: [Patch] Javadoc & style
Posted by Xavier Hanin <xa...@gmail.com>.
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 <xa...@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 <fo...@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/
Re: [Patch] Javadoc & style
Posted by Gilles Scokart <gs...@gmail.com>.
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.
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?).
Gilles
2007/5/24, Xavier Hanin <xa...@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 <fo...@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
Re: [Patch] Javadoc & style
Posted by Xavier Hanin <xa...@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 <fo...@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/
Re: [Patch] Javadoc & style
Posted by Gilles Scokart <gs...@gmail.com>.
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 <fo...@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