You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Christian Grobmeier <gr...@gmail.com> on 2009/03/24 08:00:53 UTC

[compress] Checkstyle configuration

Hi all,

I just try to figure out how to include a checkstyle.xml in compress.
I have stolen the configuration file
from [email] and put it in the root directory. For testing I enabled
it within eclipse and found out that
I need to set the following properties, which seem to come out from
commons-parent. I checked that out and searched, but couldn't find the
setting of this properties.

Can somebody please explain from where I have to fil these properties?
If somebody could explain or point me to a document or a mail how I
use commons-parent, this would be helpful too.

Here are the props:
<property name="headerFile" value="${checkstyle.header.file}"/>
<property name="cacheFile" value="${checkstyle.cache.file}"/>

However, checkstyle isn't throwing too much errors, a good sign :-)

Cheers,
Christian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Christian Grobmeier <gr...@gmail.com>.
Hi

> Christian, you could have a go at doing this yourself. I added you
> specifically to the COMPRESS project in JIRA, so you should have the
> privileges to do that. Let me know if it doesn't work for you, and I'll
> have another look at it.

it seems to work, thank you very much!

Christian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Dennis Lundberg <de...@apache.org>.
Christian Grobmeier wrote:
> Hi there,
> 
>> if you want to delete I can do it - no need to jira every detail while
>> we are  all on AC09
> 
> well, not all :-)
> Thanks, i didn't want to noise around.
> If you could delete it I would be glad.
> Can you please close this issue too?
> https://issues.apache.org/jira/browse/COMPRESS-25

Christian, you could have a go at doing this yourself. I added you
specifically to the COMPRESS project in JIRA, so you should have the
privileges to do that. Let me know if it doesn't work for you, and I'll
have another look at it.

> 
> Cheers!
> Christian
> 
>> Sitting next to Stefan Bodewig,
>>
>> Siegfried Goeschl
>>
>> Christian Grobmeier wrote:
>>>> On 2009-03-24, Torsten Curdt <tc...@apache.org> wrote:
>>>>
>>>>
>>>>> Personally I am not a big fan of checkstyle enforcement at all.
>>>>>
>>>> I can perfectly well live without it as well.
>>>>
>>> OK, I will add a patch to the cs issue whcih deletes the checkstyle.xml
>>> from the pom file (its currently commented out).
>>>
>>> Cheers + Thanks
>>> Christian
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>
>>>
>>>
>>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
> 
> 


-- 
Dennis Lundberg

Re: [compress] Checkstyle configuration

Posted by Christian Grobmeier <gr...@gmail.com>.
Hi there,

> if you want to delete I can do it - no need to jira every detail while
> we are  all on AC09

well, not all :-)
Thanks, i didn't want to noise around.
If you could delete it I would be glad.
Can you please close this issue too?
https://issues.apache.org/jira/browse/COMPRESS-25

Cheers!
Christian

> Sitting next to Stefan Bodewig,
>
> Siegfried Goeschl
>
> Christian Grobmeier wrote:
>>> On 2009-03-24, Torsten Curdt <tc...@apache.org> wrote:
>>>
>>>
>>>> Personally I am not a big fan of checkstyle enforcement at all.
>>>>
>>> I can perfectly well live without it as well.
>>>
>>
>> OK, I will add a patch to the cs issue whcih deletes the checkstyle.xml
>> from the pom file (its currently commented out).
>>
>> Cheers + Thanks
>> Christian
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>>
>>
>>
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Siegfried Goeschl <si...@it20one.at>.
Hi Christian,

if you want to delete I can do it - no need to jira every detail while
we are  all on AC09

Sitting next to Stefan Bodewig,

Siegfried Goeschl

Christian Grobmeier wrote:
>> On 2009-03-24, Torsten Curdt <tc...@apache.org> wrote:
>>
>>     
>>> Personally I am not a big fan of checkstyle enforcement at all.
>>>       
>> I can perfectly well live without it as well.
>>     
>
> OK, I will add a patch to the cs issue whcih deletes the checkstyle.xml
> from the pom file (its currently commented out).
>
> Cheers + Thanks
> Christian
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>
>
>   

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Christian Grobmeier <gr...@gmail.com>.
> On 2009-03-24, Torsten Curdt <tc...@apache.org> wrote:
>
>> Personally I am not a big fan of checkstyle enforcement at all.
>
> I can perfectly well live without it as well.

OK, I will add a patch to the cs issue whcih deletes the checkstyle.xml
from the pom file (its currently commented out).

Cheers + Thanks
Christian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Stefan Bodewig <bo...@apache.org>.
On 2009-03-24, Torsten Curdt <tc...@apache.org> wrote:

> Personally I am not a big fan of checkstyle enforcement at all.

I can perfectly well live without it as well.

Stefan

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Torsten Curdt <tc...@apache.org>.
> I was remembering when I was jumping into compress first. I openend
> the BZ2 classes and I felt so hopeless... the code was quite cryptic
> to me and so different to that style I was used too. If we would have
> clean and consistent codestyle, this may help some younger  devs to
> jump into the code and maybe even to contribute patches.

Indeed ... but codestyle is only blaming - not helping.
IMO providing IDE style settings is more pro-active.

cheers
--
Torsten

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Christian Grobmeier <gr...@gmail.com>.
>> Is that because of the checkstyle tool, or because of the rules that
>> have been chosen?
>
> Not because of these rules. It's the approach.
>
> I've seen people wasting too much time on this. Builds breaking
> because of wrong coding styles. Terrible!

I thought checkstyle.xml is a commons convention. However, I do net
need such enforced checks in build pom. But I think we should let know
people about the codestyle in this project. This enhances
readabillity. Of course we should enhance our style to the proposed
checkstyle.xml.

I was remembering when I was jumping into compress first. I openend
the BZ2 classes and I felt so hopeless... the code was quite cryptic
to me and so different to that style I was used too. If we would have
clean and consistent codestyle, this may help some younger  devs to
jump into the code and maybe even to contribute patches.

Cheers,
Christian


Cheers,
Christian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Torsten Curdt <tc...@apache.org>.
>> Personally I am not a big fan of checkstyle enforcement at all.
>
> Is that because of the checkstyle tool, or because of the rules that
> have been chosen?

Not because of these rules. It's the approach.

I've seen people wasting too much time on this. Builds breaking
because of wrong coding styles. Terrible!

Everyone has different opinions and so on. Just be respectful when you
modify the code adapt to the style in the class and you should be OK.
If you must rather define rules for eclipse/idea because those will
actually fix the style and not just complain about it. That's a much
healthier approach IMO

...but again - this is just my POV.

cheers
--
Torsten

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by sebb <se...@gmail.com>.
On 24/03/2009, Torsten Curdt <tc...@apache.org> wrote:
> > Since codestyle is a very personal discussion (sometimes), I would
>  > like to give you a chance to discuss before I create the attachement.
>
>
> Personally I am not a big fan of checkstyle enforcement at all.

Is that because of the checkstyle tool, or because of the rules that
have been chosen?

>  cheers
>  --
>
> Torsten
>
>
>  ---------------------------------------------------------------------
>  To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>  For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Torsten Curdt <tc...@apache.org>.
> Since codestyle is a very personal discussion (sometimes), I would
> like to give you a chance to discuss before I create the attachement.

Personally I am not a big fan of checkstyle enforcement at all.

cheers
--
Torsten

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Christian Grobmeier <gr...@gmail.com>.
Hi again,

sorry for the attachment, but this is my proposed Checkstyle config.
Since codestyle is a very personal discussion (sometimes), I would
like to give you a chance to discuss before I create the attachement.

Additionally, i commented out the $properties in teh file till some
maven guru can help me :-)

Mostly I have taken the same options then [email] has, except that I
prefer to have my braces { on the same level as my method name is (sun
standard).

Any comments?
Best,
Christian


On Tue, Mar 24, 2009 at 8:00 AM, Christian Grobmeier
<gr...@gmail.com> wrote:
> Hi all,
>
> I just try to figure out how to include a checkstyle.xml in compress.
> I have stolen the configuration file
> from [email] and put it in the root directory. For testing I enabled
> it within eclipse and found out that
> I need to set the following properties, which seem to come out from
> commons-parent. I checked that out and searched, but couldn't find the
> setting of this properties.
>
> Can somebody please explain from where I have to fil these properties?
> If somebody could explain or point me to a document or a mail how I
> use commons-parent, this would be helpful too.
>
> Here are the props:
> <property name="headerFile" value="${checkstyle.header.file}"/>
> <property name="cacheFile" value="${checkstyle.cache.file}"/>
>
> However, checkstyle isn't throwing too much errors, a good sign :-)
>
> Cheers,
> Christian
>

Re: [compress] Checkstyle configuration

Posted by Christian Grobmeier <gr...@gmail.com>.
>> I need to set the following properties, which seem to come out from
>> commons-parent. I checked that out and searched, but couldn't find the
>> setting of this properties.
>
> I think you're mistaken - AFAIK commons-parent doesn't have anything
> configured for checkstyle.

oh... thanks! OK I will check other projects too and look what they do. Thanks!

Christian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org


Re: [compress] Checkstyle configuration

Posted by Niall Pemberton <ni...@gmail.com>.
On Tue, Mar 24, 2009 at 7:00 AM, Christian Grobmeier
<gr...@gmail.com> wrote:
> Hi all,
>
> I just try to figure out how to include a checkstyle.xml in compress.
> I have stolen the configuration file
> from [email] and put it in the root directory. For testing I enabled
> it within eclipse and found out that
> I need to set the following properties, which seem to come out from
> commons-parent. I checked that out and searched, but couldn't find the
> setting of this properties.

I think you're mistaken - AFAIK commons-parent doesn't have anything
configured for checkstyle.

Niall

> Can somebody please explain from where I have to fil these properties?
> If somebody could explain or point me to a document or a mail how I
> use commons-parent, this would be helpful too.
>
> Here are the props:
> <property name="headerFile" value="${checkstyle.header.file}"/>
> <property name="cacheFile" value="${checkstyle.cache.file}"/>
>
> However, checkstyle isn't throwing too much errors, a good sign :-)
>
> Cheers,
> Christian
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
For additional commands, e-mail: dev-help@commons.apache.org