You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@struts.apache.org by Wendy Smoak <ws...@gmail.com> on 2006/06/11 04:01:07 UTC

Maven 2 website documentation editing

I updated the wiki page [1] but I want to call attention to a couple
of features of the Maven 2 site plugin.

First is the ability to start Jetty and regenerate pages on the fly as
you're editing them.  This works for a single module at a time.

   'mvn site:run'  then browse to http://localhost:8080

(If you get an error, delete
$M2_REPO/org/apache/maven/plugins/maven-site-plugin and try again.)

You can also "stage" the entire site locally with:

   'mvn site:stage'

It defaults to target/staging, or you can specify
-DstagingDirectory=/path/to/tempdir

When you're happy with it, 'mvn site site:deploy' will upload it to
the right place on people.apache.org, where it will sync to the active
webserver within an hour.

Other site plugin goals and their options can be found here:
   http://maven.apache.org/plugins/maven-site-plugin/plugin-info.html

[1] http://wiki.apache.org/struts/StrutsMaintenanceWebsite

-- 
Wendy

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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Ted Husted wrote:
> We don't like to make sweeping changes right *after* a popular
> release, because it fouls up patches people might submit based on the
> source for that release.It's a matter of degree and how many files are
> touched.

Ok, sorry, I wasn't remembering the previous conversations properly.

> Niall was talking about rolling 1.3.5 any day now. If we were going to
> do things, before 1.3.5 would be better, if there's time to squeeze
> them in.

I guess the question goes to Niall then...

I can put some time in on it this weekend Niall, if that doesn't 
conflict with your release plans... it'll be quite a few patches though, 
whether its one per source file, one per package, whatever is 
preferred... so, knowing that someone, whether you or someone else, will 
be willing and able to apply them relatively soon after they are 
submitted will be important so as to not hold anything up.  Just let me 
know what works for you Niall :)

Frank

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

-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

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


Re: SAF1 Checkstyle

Posted by Ted Husted <te...@gmail.com>.
On 6/20/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> after the next milestone (or was it after GA?  I'm not sure), so as soon
> as we hit that, I'll jump right on all this.

We don't like to make sweeping changes right *after* a popular
release, because it fouls up patches people might submit based on the
source for that release.It's a matter of degree and how many files are
touched.

Niall was talking about rolling 1.3.5 any day now. If we were going to
do things, before 1.3.5 would be better, if there's time to squeeze
them in.

-Ted.

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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Martin Cooper wrote:
> I'm with you - I'd prefer to fix them, rather than ignore them.

Cool.  I suspect most would agree with that as well.

The consensus I believe was to hold off on any actual changes until 
after the next milestone (or was it after GA?  I'm not sure), so as soon 
as we hit that, I'll jump right on all this.

Between these two issues, and then all the javadoc issues, I think 90%+ 
of the complaints will be gone, and those should all be pretty benign 
changes to boot.  After that we can tackle the stuff that alters code in 
some way, and is thus potentially dangerous.

> -- 
> Martin Cooper

Frank


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


Re: SAF1 Checkstyle

Posted by Martin Cooper <ma...@apache.org>.
On 6/20/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
>
> So, I'm looking through the Checkstyle results for all SAF1 subprojects
> to see if there is anything else that can and maybe should be addressed
> by rule changes... one particular complaint that shows up an awful lot
> is the "Line has trailing spaces" complaint.
>
> My own opinion is that all the source files should have trailing spaces
> removed (which is a trivial task in UltraEdit, I could do every source
> file in all subprojects in about 5 minutes).  But, I wanted to throw it
> out there for discussion because if that rule is disabled, the complaint
> numbers go down quite a bit immediately :)
>
> Along those lines is the "File does not end with a newline" complaint.
> Again, my own opinion is to add the space to all files (only slightly
> harder, might take me 15 minutes).  But, disabling the rule is an option
> as well.
>
> So, what does everyone think?  Are these two "issues" something we think
>   could just as well be ignored, and therefore the rules turned off?


I'm with you - I'd prefer to fix them, rather than ignore them.

--
Martin Cooper


FYI, just some quick stats, after the latest rule changes (I'll save
> everyone the trouble of doing it themselves!):
>
> Core .................. 1113
> Taglib ................ 921
> Apps - Cookbook ....... 208
> Tiles ................. 2447
> Faces ................. 682
> Faces Example 1 ....... 556
> Faces Example 2 ....... 548
> Extras ................ 22
> Examples .............. 514
> Mailreader DAO ........ 136
> Mailreader ............ 36
> EL .................... 2546
> Struts EL Exercise .... 123
> Scripting ............. 4
> Scripting Mailreader .. 6
>
> Frank
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>

Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
So, I'm looking through the Checkstyle results for all SAF1 subprojects 
to see if there is anything else that can and maybe should be addressed 
by rule changes... one particular complaint that shows up an awful lot 
is the "Line has trailing spaces" complaint.

My own opinion is that all the source files should have trailing spaces 
removed (which is a trivial task in UltraEdit, I could do every source 
file in all subprojects in about 5 minutes).  But, I wanted to throw it 
out there for discussion because if that rule is disabled, the complaint 
numbers go down quite a bit immediately :)

Along those lines is the "File does not end with a newline" complaint. 
Again, my own opinion is to add the space to all files (only slightly 
harder, might take me 15 minutes).  But, disabling the rule is an option 
as well.

So, what does everyone think?  Are these two "issues" something we think 
  could just as well be ignored, and therefore the rules turned off?

FYI, just some quick stats, after the latest rule changes (I'll save 
everyone the trouble of doing it themselves!):

Core .................. 1113
Taglib ................ 921
Apps - Cookbook ....... 208
Tiles ................. 2447
Faces ................. 682
Faces Example 1 ....... 556
Faces Example 2 ....... 548
Extras ................ 22
Examples .............. 514
Mailreader DAO ........ 136
Mailreader ............ 36
EL .................... 2546
Struts EL Exercise .... 123
Scripting ............. 4
Scripting Mailreader .. 6

Frank

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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Ok, that's no problem.  Waiting might be better, especially since it 
looks like at least some of it involves rule tweaking, and hence I'd 
think some discussion.  I don't want to do anything that makes getting 
to GA more difficult, so I'm ok with coming back to it later.

Frank

Ted Husted wrote:
> On 6/13/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
>> Hi Ted... I wouldn't say there's no one interested in fixing the errors
>> :)  I offered to do it some time ago, and I'm still willing (and my time
>> has freed up again, so able as well!)
> 
> Unforutnately, it seems to be a timing issue. If the patches had been
> available back in February when we trimmed the checkstyle issues from
> tens of thousands to thousands, I would have been able to apply them.
> 
> Right now, Wendy has been publishing 1.3.5 snapshots, and she may be
> ready for another try at a release. I don't know if we want to get
> into this again now or after we have a GA 1.3.
> 
> -Ted.
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
> 
> 
> 
> 

-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

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


Re: SAF1 Checkstyle

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/21/06, Frank W. Zammetti <fz...@omnytex.com> wrote:

> I'll see what I can do over the weekend...

I'd suggest opening several JIRA issues, at least one per component
(core, taglib, etc.) depending on how you decide to organize the
patches.

Ideally anyone could review the patch(es), commit and close one issue
in an hour or so.  I'd also like to avoid an issue for "Fix Checkstyle
Problems" that stays open forever.

-- 
Wendy

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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
First round of Checkstyle pathes are in JIRA:

http://issues.apache.org/struts/browse/STR-2900

I'd be happy to do another round after these are applied, if time allows 
before the next release is rolled.  In any case, this addresses around 
2,150 issues, give or take a few.

Frank

Frank W. Zammetti wrote:
> Ted, do you have any preference on how the patches should come in?  One 
> per package, one per source file, etc?
> 
> Frank
> 
> Frank W. Zammetti wrote:
>> I'll see what I can do over the weekend...
>>
>> Frank
>>
>> Ted Husted wrote:
>>> On 6/21/06, Niall Pemberton <ni...@gmail.com> wrote:
>>>> Unfortunately doesn't look like I'm going to find time to do this,
>>>
>>> I can make time in the first week of July, and it doesn't sound like
>>> anyone else will have time before then. So if  anyone wants to drum up
>>> some checkstyle patches, it looks like we have another brief window of
>>> opportunity.
>>>
>>> -Ted.
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>>> For additional commands, e-mail: dev-help@struts.apache.org
>>>
>>>
>>>
>>>
>>
> 

-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Ted, do you have any preference on how the patches should come in?  One 
per package, one per source file, etc?

Frank

Frank W. Zammetti wrote:
> I'll see what I can do over the weekend...
> 
> Frank
> 
> Ted Husted wrote:
>> On 6/21/06, Niall Pemberton <ni...@gmail.com> wrote:
>>> Unfortunately doesn't look like I'm going to find time to do this,
>>
>> I can make time in the first week of July, and it doesn't sound like
>> anyone else will have time before then. So if  anyone wants to drum up
>> some checkstyle patches, it looks like we have another brief window of
>> opportunity.
>>
>> -Ted.
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>>
>>
>>
> 

-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
I'll see what I can do over the weekend...

Frank

Ted Husted wrote:
> On 6/21/06, Niall Pemberton <ni...@gmail.com> wrote:
>> Unfortunately doesn't look like I'm going to find time to do this,
> 
> I can make time in the first week of July, and it doesn't sound like
> anyone else will have time before then. So if  anyone wants to drum up
> some checkstyle patches, it looks like we have another brief window of
> opportunity.
> 
> -Ted.
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
> 
> 
> 
> 

-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Ted Husted <te...@gmail.com>.
On 6/21/06, Niall Pemberton <ni...@gmail.com> wrote:
> Unfortunately doesn't look like I'm going to find time to do this,

I can make time in the first week of July, and it doesn't sound like
anyone else will have time before then. So if  anyone wants to drum up
some checkstyle patches, it looks like we have another brief window of
opportunity.

-Ted.

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Niall Pemberton <ni...@gmail.com>.
On 6/15/06, Niall Pemberton <ni...@gmail.com> wrote:
> On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> > On Thu, June 15, 2006 6:35 am, Ted Husted wrote:
> >
> > > In the meantime, that would give Frank time to work on those patches.
> >
> > So you don't want to wait for GA now?  That's fine with me... I'm not sure
> > I can take care of all the complaints by July, but I should be able to get
> > rid of enough of them to make it worth doing (the two things I mentioned
> > the other day would probably cut the numbers in half alone, and they're
> > low-hanging fruit I think).
>
> I'm going to try and find time for 1.3.5 next week - it may not
> happen, but if I can then IMO better to leave till after.

Unfortunately doesn't look like I'm going to find time to do this,

Niall

> Niall
>
> > > -Ted.
> >
> > Frank
>

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


Re: SAF1 Checkstyle

Posted by Martin Cooper <ma...@apache.org>.
On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
>
> Ted Husted wrote:
> > You might at least want to start those discussions about the
> > checkstyle settings, so that we can develop a strategy about how they
> > would be fixed the next time there is a window of opportunity.
>
> Fair enough...
>
> I saw two issues that seem to account for a large number of the
> complaints...
>
> * The issue "Variable xxxx must be private and have accessor methods.".
>   This is the VisibilityModifierCheck check.  I don't think directly
> addressing it, i.e., following the suggestion it gives, is the right
> answer... I can't imagine it wouldn't break things, either in the SAF
> codebase itself or in users' application code.
>
> Fortunately, there appears to be a setting in Checkstyle to deal with
> this:
>
> http://checkstyle.sourceforge.net/config_design.html#VisibilityModifier
>
> Or we could remove this check entirely.  I'd vote for just setting
> protectedAllowed to true though.


I wish there was a way to tell Checkstyle to allow protected variables for
pre-existing code, but complain about new code. ;-) The fact is that we
can't change protected variables to private in most places because it risks
breaking any extending classes. We could fix the ones in Struts, of course,
but we can't do anything about developers extending Struts in their own
apps. I suppose we could add the getters and setters and deprecate the
variable itself, making it private in a later release.

For now, though, I agree that setting protectedAllowed to true is the most
expedient option.

--
Martin Cooper


Looking at core alone, that would probably get rid of half of the
> remaining issues.  This is the only proposed rule change I have at this
> point.
>
> * The issue "Expected @throws tag for xxxx".  This is coming up a lot
> because there are runtime exceptions thrown in methods that are not
> declared (which is of course valid, but doesn't follow the style rules).
>   I would suggestion simply declaring them... I don't *think* that has
> any side-effects... anyone think there is?
>
> > When I did a a time study in February, curing the the current errors
> > with the current settings would take at least 40 hard hours. We need
> > to find a way to do the work faster, or get more people to work on it.
>
> Agreed, and your estimate may even be too optimistic given that first
> bullet above, if the rule change wasn't implemented.  I frankly don't
> see another way to deal with that particular complaint.
>
> > (We probably should have made this a Google Summer of Code project.)
>
> Hehe, yeah :)
>
> > There is also the issue of how we want to handle the exception issues.
> > We will be addressing exception handling in SAF 2, so it's a pertinent
> > question.
>
> I certainly don't disagree that some exception handling updates should
> be looked at, but I'm not sure that's pertinent in the context of
> Checkstyle complaints... the exception bullet above I don't think should
> be expanded to modifying how exceptions are handled now, it's just
> getting rid of the complaints, which I think is as simple as declaring
> the exceptions.
>
> > We might also consider fixing some of the errors at a time, for
> > example maybe just the exception handlers. That could have less of an
> > impact that trying to cure all six thousand at once.
>
> Same point as the above paragraph... I think we're talking about two
> different things really.
>
> Although, if you wanted to tackle just one category of complaint at a
> time, that would be fine... I was thinking of a package at a time, but
> the work breakdown can certainly be done any of a number of ways.
>
> Ultimately though, that one rule change above would cut down a pretty
> substantial number of complaints, and in this case I don't think
> changing the rules is a cop-out.  So, I'd like to see a consensus
> reached on that alone, everything else could be back-burnered as far as
> I'm concerned.
>
> > -Ted.
>
> Frank
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>

Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
On Mon, June 19, 2006 1:02 pm, Laurie Harper wrote:
> Since this is a change to the checkstyle rules, not a change to the
> codebase, I don't think it needs to wait for a release/GA/whatever.
> Might as well just get it done now...

Sounds good.  Tell you what... it's a minor change, but I'll create a
ticket when I get home tonight and attach the updated rules file.  If you
(or anyone else) wants to commit it before the next milestone, cool.  If
not, it'll be there whenever someone's ready to do it.

> Declaring runtime exceptions in the throws clause of a method signature
> has no impact on the signature, so it should be safe. However, it's
> generally considered poor style (on what basis I don't know, doesn't
> seem like a problem to me, but...).

Hmm, I just found this:

http://scv.bu.edu/Doc/Java/tutorial/java/exceptions/runtime.html

About midway down where they answer directly the "why shouldn't I declare
runtime exceptions"... makes sense to me :)  I could make the opposite
argument I think, but what it says there *does* seem reasonable to me.

> If there's a checkstyle rule change
> that could be used to take care of this then, again, there'd be no need
> to wait. If it really does need code changes, it'd be worth holding off
> but opening a JIRA issue so we don't forget to come back later.

I was just trying to look up the applicable Checkstyle rule from memory,
but I don't remember what it was... I'll take a look when I get home and
have the Checkstyle report in front of me... There probably is a setting,
there usually is with Checkstyle.  I'll let you know...

> L.

Frank

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


Re: SAF1 Checkstyle

Posted by Laurie Harper <la...@holoweb.net>.
Frank W. Zammetti wrote:
> Ted Husted wrote:
>> You might at least want to start those discussions about the
>> checkstyle settings, so that we can develop a strategy about how they
>> would be fixed the next time there is a window of opportunity.
> 
> Fair enough...
> 
> I saw two issues that seem to account for a large number of the 
> complaints...
> 
> * The issue "Variable xxxx must be private and have accessor methods.". 
>  This is the VisibilityModifierCheck check.  I don't think directly 
> addressing it, i.e., following the suggestion it gives, is the right 
> answer... I can't imagine it wouldn't break things, either in the SAF 
> codebase itself or in users' application code.
> 
> Fortunately, there appears to be a setting in Checkstyle to deal with this:
> 
> http://checkstyle.sourceforge.net/config_design.html#VisibilityModifier
> 
> Or we could remove this check entirely.  I'd vote for just setting 
> protectedAllowed to true though.

Since this is a change to the checkstyle rules, not a change to the 
codebase, I don't think it needs to wait for a release/GA/whatever. 
Might as well just get it done now...

> Looking at core alone, that would probably get rid of half of the 
> remaining issues.  This is the only proposed rule change I have at this 
> point.
> 
> * The issue "Expected @throws tag for xxxx".  This is coming up a lot 
> because there are runtime exceptions thrown in methods that are not 
> declared (which is of course valid, but doesn't follow the style rules). 
>  I would suggestion simply declaring them... I don't *think* that has 
> any side-effects... anyone think there is?

Declaring runtime exceptions in the throws clause of a method signature 
has no impact on the signature, so it should be safe. However, it's 
generally considered poor style (on what basis I don't know, doesn't 
seem like a problem to me, but...). If there's a checkstyle rule change 
that could be used to take care of this then, again, there'd be no need 
to wait. If it really does need code changes, it'd be worth holding off 
but opening a JIRA issue so we don't forget to come back later.

L.

> 
>> When I did a a time study in February, curing the the current errors
>> with the current settings would take at least 40 hard hours. We need
>> to find a way to do the work faster, or get more people to work on it.
> 
> Agreed, and your estimate may even be too optimistic given that first 
> bullet above, if the rule change wasn't implemented.  I frankly don't 
> see another way to deal with that particular complaint.
> 
>> (We probably should have made this a Google Summer of Code project.)
> 
> Hehe, yeah :)
> 
>> There is also the issue of how we want to handle the exception issues.
>> We will be addressing exception handling in SAF 2, so it's a pertinent
>> question.
> 
> I certainly don't disagree that some exception handling updates should 
> be looked at, but I'm not sure that's pertinent in the context of 
> Checkstyle complaints... the exception bullet above I don't think should 
> be expanded to modifying how exceptions are handled now, it's just 
> getting rid of the complaints, which I think is as simple as declaring 
> the exceptions.
> 
>> We might also consider fixing some of the errors at a time, for
>> example maybe just the exception handlers. That could have less of an
>> impact that trying to cure all six thousand at once.
> 
> Same point as the above paragraph... I think we're talking about two 
> different things really.
> 
> Although, if you wanted to tackle just one category of complaint at a 
> time, that would be fine... I was thinking of a package at a time, but 
> the work breakdown can certainly be done any of a number of ways.
> 
> Ultimately though, that one rule change above would cut down a pretty 
> substantial number of complaints, and in this case I don't think 
> changing the rules is a cop-out.  So, I'd like to see a consensus 
> reached on that alone, everything else could be back-burnered as far as 
> I'm concerned.
> 
>> -Ted.
> 
> Frank


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


Re: SAF1 Checkstyle

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Ted Husted wrote:
> You might at least want to start those discussions about the
> checkstyle settings, so that we can develop a strategy about how they
> would be fixed the next time there is a window of opportunity.

Fair enough...

I saw two issues that seem to account for a large number of the 
complaints...

* The issue "Variable xxxx must be private and have accessor methods.". 
  This is the VisibilityModifierCheck check.  I don't think directly 
addressing it, i.e., following the suggestion it gives, is the right 
answer... I can't imagine it wouldn't break things, either in the SAF 
codebase itself or in users' application code.

Fortunately, there appears to be a setting in Checkstyle to deal with this:

http://checkstyle.sourceforge.net/config_design.html#VisibilityModifier

Or we could remove this check entirely.  I'd vote for just setting 
protectedAllowed to true though.

Looking at core alone, that would probably get rid of half of the 
remaining issues.  This is the only proposed rule change I have at this 
point.

* The issue "Expected @throws tag for xxxx".  This is coming up a lot 
because there are runtime exceptions thrown in methods that are not 
declared (which is of course valid, but doesn't follow the style rules). 
  I would suggestion simply declaring them... I don't *think* that has 
any side-effects... anyone think there is?

> When I did a a time study in February, curing the the current errors
> with the current settings would take at least 40 hard hours. We need
> to find a way to do the work faster, or get more people to work on it.

Agreed, and your estimate may even be too optimistic given that first 
bullet above, if the rule change wasn't implemented.  I frankly don't 
see another way to deal with that particular complaint.

> (We probably should have made this a Google Summer of Code project.)

Hehe, yeah :)

> There is also the issue of how we want to handle the exception issues.
> We will be addressing exception handling in SAF 2, so it's a pertinent
> question.

I certainly don't disagree that some exception handling updates should 
be looked at, but I'm not sure that's pertinent in the context of 
Checkstyle complaints... the exception bullet above I don't think should 
be expanded to modifying how exceptions are handled now, it's just 
getting rid of the complaints, which I think is as simple as declaring 
the exceptions.

> We might also consider fixing some of the errors at a time, for
> example maybe just the exception handlers. That could have less of an
> impact that trying to cure all six thousand at once.

Same point as the above paragraph... I think we're talking about two 
different things really.

Although, if you wanted to tackle just one category of complaint at a 
time, that would be fine... I was thinking of a package at a time, but 
the work breakdown can certainly be done any of a number of ways.

Ultimately though, that one rule change above would cut down a pretty 
substantial number of complaints, and in this case I don't think 
changing the rules is a cop-out.  So, I'd like to see a consensus 
reached on that alone, everything else could be back-burnered as far as 
I'm concerned.

> -Ted.

Frank

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Ted Husted <te...@gmail.com>.
You might at least want to start those discussions about the
checkstyle settings, so that we can develop a strategy about how they
would be fixed the next time there is a window of opportunity.

When I did a a time study in February, curing the the current errors
with the current settings would take at least 40 hard hours. We need
to find a way to do the work faster, or get more people to work on it.

(We probably should have made this a Google Summer of Code project.)

There is also the issue of how we want to handle the exception issues.
We will be addressing exception handling in SAF 2, so it's a pertinent
question.

We might also consider fixing some of the errors at a time, for
example maybe just the exception handlers. That could have less of an
impact that trying to cure all six thousand at once.

-Ted.

On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> Ok, my head is spinning :)
>
> I like simple, so, I'll say the same thing I remember saying months ago...
> just ping me when the time is right to deal with Checkstyle complaints,
> and so long as I still have some free time then, I'll do it.
>
> You have someone willing to do the work, I'll let you worry about the
> timing issues :)
>
> Frank
>
> On Thu, June 15, 2006 12:46 pm, Ted Husted wrote:
> > The problem is patches. People will tend to write patches against
> > whatever version they are using. If we make a lot of changes right
> > after a popular release, then a lot of the patches people submit back
> > won't work. The ideal time for broad refactorings is at the beginning
> > of a minor series (pre #.0.0),  rather than in the middle of several
> > point releases(.
> >
> > In the grand scope, it would be better if Niall could roll 1.3.5 now
> > rather than wait. If this milestone works out, then we might have to
> > target 1.4 for the next round of pro-forma refactorings.
> >
> > -Ted.
> >
> > On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> >> Ok, cool Niall... I guess we maybe need to decide what the "wait point"
> >> really is here... do we want to wait for GA before I generate these
> >> patches, or just the next release?  At first I thought Ted was saying
> >> let's wait for GA, but then it sounded like maybe just wait for 1.3.5
> >> (which may or may not be GA of course!).  It's cool with me either way,
> >> just want to make sure we're all on the same page... no sense in me
> >> doing
> >> work that will either take a long time to get applied (I'm assuming
> >> someone *will* apply them), or possibly have to be re-done anyway
> >> because
> >> a release or two maybe makes them invalid.
> >>
> >> Frank
> >>
> >>
> >> --
> >> Frank W. Zammetti
> >> Founder and Chief Software Architect
> >> Omnytex Technologies
> >> http://www.omnytex.com
> >> AIM: fzammetti
> >> Yahoo: fzammetti
> >> MSN: fzammetti@hotmail.com
> >> Java Web Parts -
> >> http://javawebparts.sourceforge.net
> >> Supplying the wheel, so you don't have to reinvent it!
> >>
> >> On Thu, June 15, 2006 11:21 am, Niall Pemberton wrote:
> >> > On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> >> >> On Thu, June 15, 2006 6:35 am, Ted Husted wrote:
> >> >>
> >> >> > In the meantime, that would give Frank time to work on those
> >> patches.
> >> >>
> >> >> So you don't want to wait for GA now?  That's fine with me... I'm not
> >> >> sure
> >> >> I can take care of all the complaints by July, but I should be able
> >> to
> >> >> get
> >> >> rid of enough of them to make it worth doing (the two things I
> >> mentioned
> >> >> the other day would probably cut the numbers in half alone, and
> >> they're
> >> >> low-hanging fruit I think).
> >> >
> >> > I'm going to try and find time for 1.3.5 next week - it may not
> >> > happen, but if I can then IMO better to leave till after.
> >> >
> >> > Niall
> >> >
> >> >> > -Ted.
> >> >>
> >> >> Frank
> >> >
> >> > ---------------------------------------------------------------------
> >> > To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> >> > For additional commands, e-mail: dev-help@struts.apache.org
> >> >
> >> >
> >>
> >>
> >> ---------------------------------------------------------------------
> >> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> >> For additional commands, e-mail: dev-help@struts.apache.org
> >>
> >>
> >
> >
> > --
> > HTH, Ted.
> > * http://www.husted.com/struts/
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> > For additional commands, e-mail: dev-help@struts.apache.org
> >
> >
>
>


-- 
HTH, Ted.
* http://www.husted.com/struts/

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Ok, my head is spinning :)

I like simple, so, I'll say the same thing I remember saying months ago...
just ping me when the time is right to deal with Checkstyle complaints,
and so long as I still have some free time then, I'll do it.

You have someone willing to do the work, I'll let you worry about the
timing issues :)

Frank

On Thu, June 15, 2006 12:46 pm, Ted Husted wrote:
> The problem is patches. People will tend to write patches against
> whatever version they are using. If we make a lot of changes right
> after a popular release, then a lot of the patches people submit back
> won't work. The ideal time for broad refactorings is at the beginning
> of a minor series (pre #.0.0),  rather than in the middle of several
> point releases(.
>
> In the grand scope, it would be better if Niall could roll 1.3.5 now
> rather than wait. If this milestone works out, then we might have to
> target 1.4 for the next round of pro-forma refactorings.
>
> -Ted.
>
> On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
>> Ok, cool Niall... I guess we maybe need to decide what the "wait point"
>> really is here... do we want to wait for GA before I generate these
>> patches, or just the next release?  At first I thought Ted was saying
>> let's wait for GA, but then it sounded like maybe just wait for 1.3.5
>> (which may or may not be GA of course!).  It's cool with me either way,
>> just want to make sure we're all on the same page... no sense in me
>> doing
>> work that will either take a long time to get applied (I'm assuming
>> someone *will* apply them), or possibly have to be re-done anyway
>> because
>> a release or two maybe makes them invalid.
>>
>> Frank
>>
>>
>> --
>> Frank W. Zammetti
>> Founder and Chief Software Architect
>> Omnytex Technologies
>> http://www.omnytex.com
>> AIM: fzammetti
>> Yahoo: fzammetti
>> MSN: fzammetti@hotmail.com
>> Java Web Parts -
>> http://javawebparts.sourceforge.net
>> Supplying the wheel, so you don't have to reinvent it!
>>
>> On Thu, June 15, 2006 11:21 am, Niall Pemberton wrote:
>> > On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
>> >> On Thu, June 15, 2006 6:35 am, Ted Husted wrote:
>> >>
>> >> > In the meantime, that would give Frank time to work on those
>> patches.
>> >>
>> >> So you don't want to wait for GA now?  That's fine with me... I'm not
>> >> sure
>> >> I can take care of all the complaints by July, but I should be able
>> to
>> >> get
>> >> rid of enough of them to make it worth doing (the two things I
>> mentioned
>> >> the other day would probably cut the numbers in half alone, and
>> they're
>> >> low-hanging fruit I think).
>> >
>> > I'm going to try and find time for 1.3.5 next week - it may not
>> > happen, but if I can then IMO better to leave till after.
>> >
>> > Niall
>> >
>> >> > -Ted.
>> >>
>> >> Frank
>> >
>> > ---------------------------------------------------------------------
>> > To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> > For additional commands, e-mail: dev-help@struts.apache.org
>> >
>> >
>>
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
>> For additional commands, e-mail: dev-help@struts.apache.org
>>
>>
>
>
> --
> HTH, Ted.
> * http://www.husted.com/struts/
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>


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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Ted Husted <te...@gmail.com>.
The problem is patches. People will tend to write patches against
whatever version they are using. If we make a lot of changes right
after a popular release, then a lot of the patches people submit back
won't work. The ideal time for broad refactorings is at the beginning
of a minor series (pre #.0.0),  rather than in the middle of several
point releases(.

In the grand scope, it would be better if Niall could roll 1.3.5 now
rather than wait. If this milestone works out, then we might have to
target 1.4 for the next round of pro-forma refactorings.

-Ted.

On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> Ok, cool Niall... I guess we maybe need to decide what the "wait point"
> really is here... do we want to wait for GA before I generate these
> patches, or just the next release?  At first I thought Ted was saying
> let's wait for GA, but then it sounded like maybe just wait for 1.3.5
> (which may or may not be GA of course!).  It's cool with me either way,
> just want to make sure we're all on the same page... no sense in me doing
> work that will either take a long time to get applied (I'm assuming
> someone *will* apply them), or possibly have to be re-done anyway because
> a release or two maybe makes them invalid.
>
> Frank
>
>
> --
> Frank W. Zammetti
> Founder and Chief Software Architect
> Omnytex Technologies
> http://www.omnytex.com
> AIM: fzammetti
> Yahoo: fzammetti
> MSN: fzammetti@hotmail.com
> Java Web Parts -
> http://javawebparts.sourceforge.net
> Supplying the wheel, so you don't have to reinvent it!
>
> On Thu, June 15, 2006 11:21 am, Niall Pemberton wrote:
> > On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> >> On Thu, June 15, 2006 6:35 am, Ted Husted wrote:
> >>
> >> > In the meantime, that would give Frank time to work on those patches.
> >>
> >> So you don't want to wait for GA now?  That's fine with me... I'm not
> >> sure
> >> I can take care of all the complaints by July, but I should be able to
> >> get
> >> rid of enough of them to make it worth doing (the two things I mentioned
> >> the other day would probably cut the numbers in half alone, and they're
> >> low-hanging fruit I think).
> >
> > I'm going to try and find time for 1.3.5 next week - it may not
> > happen, but if I can then IMO better to leave till after.
> >
> > Niall
> >
> >> > -Ted.
> >>
> >> Frank
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> > For additional commands, e-mail: dev-help@struts.apache.org
> >
> >
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>


-- 
HTH, Ted.
* http://www.husted.com/struts/

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Ok, cool Niall... I guess we maybe need to decide what the "wait point"
really is here... do we want to wait for GA before I generate these
patches, or just the next release?  At first I thought Ted was saying
let's wait for GA, but then it sounded like maybe just wait for 1.3.5
(which may or may not be GA of course!).  It's cool with me either way,
just want to make sure we're all on the same page... no sense in me doing
work that will either take a long time to get applied (I'm assuming
someone *will* apply them), or possibly have to be re-done anyway because
a release or two maybe makes them invalid.

Frank


-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

On Thu, June 15, 2006 11:21 am, Niall Pemberton wrote:
> On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
>> On Thu, June 15, 2006 6:35 am, Ted Husted wrote:
>>
>> > In the meantime, that would give Frank time to work on those patches.
>>
>> So you don't want to wait for GA now?  That's fine with me... I'm not
>> sure
>> I can take care of all the complaints by July, but I should be able to
>> get
>> rid of enough of them to make it worth doing (the two things I mentioned
>> the other day would probably cut the numbers in half alone, and they're
>> low-hanging fruit I think).
>
> I'm going to try and find time for 1.3.5 next week - it may not
> happen, but if I can then IMO better to leave till after.
>
> Niall
>
>> > -Ted.
>>
>> Frank
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>
>


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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Niall Pemberton <ni...@gmail.com>.
On 6/15/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> On Thu, June 15, 2006 6:35 am, Ted Husted wrote:
>
> > In the meantime, that would give Frank time to work on those patches.
>
> So you don't want to wait for GA now?  That's fine with me... I'm not sure
> I can take care of all the complaints by July, but I should be able to get
> rid of enough of them to make it worth doing (the two things I mentioned
> the other day would probably cut the numbers in half alone, and they're
> low-hanging fruit I think).

I'm going to try and find time for 1.3.5 next week - it may not
happen, but if I can then IMO better to leave till after.

Niall

> > -Ted.
>
> Frank

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
On Thu, June 15, 2006 6:35 am, Ted Husted wrote:

> In the meantime, that would give Frank time to work on those patches.

So you don't want to wait for GA now?  That's fine with me... I'm not sure
I can take care of all the complaints by July, but I should be able to get
rid of enough of them to make it worth doing (the two things I mentioned
the other day would probably cut the numbers in half alone, and they're
low-hanging fruit I think).

> -Ted.

Frank


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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Ted Husted <te...@gmail.com>.
If no one else wants to step up, then I can do it first thing come
July, but not before.

In the meantime, that would give Frank time to work on those patches.

-Ted.

On 6/14/06, Wendy Smoak <ws...@gmail.com> wrote:
> On 6/13/06, Ted Husted <te...@gmail.com> wrote:
>
> > Right now, Wendy has been publishing 1.3.5 snapshots, and she may be
> > ready for another try at a release. I don't know if we want to get
> > into this again now or after we have a GA 1.3.
>
> The 1.3 distribution is in good shape, I think, (but I've thought that
> before...) and just needs someone to run through the release plan for
> 1.3.5.  I can't take this on right now, but if anyone else is
> interested in learning the release process, I can be available on IM
> to answer questions.  It isn't hard, just moderately time consuming,
> depending on how much checking you want to do.
>
> --
> Wendy

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/13/06, Ted Husted <te...@gmail.com> wrote:

> Right now, Wendy has been publishing 1.3.5 snapshots, and she may be
> ready for another try at a release. I don't know if we want to get
> into this again now or after we have a GA 1.3.

The 1.3 distribution is in good shape, I think, (but I've thought that
before...) and just needs someone to run through the release plan for
1.3.5.  I can't take this on right now, but if anyone else is
interested in learning the release process, I can be available on IM
to answer questions.  It isn't hard, just moderately time consuming,
depending on how much checking you want to do.

-- 
Wendy

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


Re: SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by Ted Husted <te...@gmail.com>.
On 6/13/06, Frank W. Zammetti <fz...@omnytex.com> wrote:
> Hi Ted... I wouldn't say there's no one interested in fixing the errors
> :)  I offered to do it some time ago, and I'm still willing (and my time
> has freed up again, so able as well!)

Unforutnately, it seems to be a timing issue. If the patches had been
available back in February when we trimmed the checkstyle issues from
tens of thousands to thousands, I would have been able to apply them.

Right now, Wendy has been publishing 1.3.5 snapshots, and she may be
ready for another try at a release. I don't know if we want to get
into this again now or after we have a GA 1.3.

-Ted.

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


SAF1 Checkstyle (was: Maven 2 website documentation editing)

Posted by "Frank W. Zammetti" <fz...@omnytex.com>.
Hi Ted... I wouldn't say there's no one interested in fixing the errors 
:)  I offered to do it some time ago, and I'm still willing (and my time 
has freed up again, so able as well!)

I just started going through them... my plan was to do one package in 
Core and see if anyone was willing to commit them.

I'm seeing two interesting issues though, and they seem to account for 
the vast majority of the complaints...

* There seems to be quite a few places where methods throw runtime 
exceptions but do not declare them as thrown, yet there are @throws 
clauses for them in the javadoc header.  How does everyone want to 
handle them?  I'd be inclined to declare them as thrown... anyone have 
any thoughts?  Would that break anything that I'm not thinking of? (if 
my basic Java knowledge memory is accurate, you still don't have to 
catch a runtime exception, even if the called method declares it as 
thrown, right?)

* There are a whole bunch of these types of issues:

"Variable xxxx must be private and have accessor methods."

All of them that I've looked at thus far are protected fields.  Looking 
at that Checkstyle rule, there is an "allowProtected/Package" setting, 
which sounds like what we'd want to change to get rid of these... I 
doubt very much we actually want to make these fields private :)  Any 
thoughts on that?

If we dealt with these two things as described here, I could probably 
have all but a handful of the issues resolved in the o.a.s.action 
package tonight, then if someone is willing to commit them, I'd be happy 
to continue on with the rest of the SAF1 codebase.

Frank


Ted Husted wrote:
> Yes, as to Action1, the vast majority of the style errors are a fair
> cop and reflect things we shouldn't be doing.
> 
> Of course, as far as Action 1 is concerned, it's a fair question of
> whether the checkstyle report adds any value. No one appears
> interested in fixing the errors, and so there are still so many errors
> that new ones go unnoticed.
> 
> I notice that as to Action2, the check style  plugin is commented out.
> I tried enabling it on my working copy, but then it wouldn't build.
> 
> 
> : reference not found: ConversionErrorInterceptor
> C:/projects/Apache/struts-current/action2/core/src/main/java/org/apache/struts/action2/dispatcher/VelocityResult.java:80: 
> 
> warning - Tag @link: reference not found: JspFactory
> 
>        at 
> org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeReport(Abs
> tractJavadocMojo.java:845)
>        at 
> org.apache.maven.plugin.javadoc.JavadocReport.generate(JavadocReport.
> java:104)
>        at 
> org.apache.maven.plugins.site.SiteMojo.generateReportsPages(SiteMojo.
> java:802)
>        at org.apache.maven.plugins.site.SiteMojo.execute(SiteMojo.java:301)
>        ... 18 more
> [INFO] 
> ------------------------------------------------------------------------
> [INFO] Total time: 28 seconds
> [INFO] Finished at: Sun Jun 11 20:58:44 EDT 2006
> [INFO] Final Memory: 20M/35M
> [INFO] 
> ------------------------------------------------------------------------
> 
> 
> Do we know what is the problem with running checkstyle with Action2?
> 
> -Ted.
> 
> On 6/11/06, Martin Cooper <ma...@apache.org> wrote:
>> You can blame whoever wrote the code. ;-) The Checkstyle rules for Struts
>> have been in place for _years_, and it's been trivial to run a Checkstyle
>> report for almost as long - even before we had 'ant release'. The 
>> original
>> rules were based on the Sun / Craig coding conventions, so you shouldn't
>> have a problem with them the way they are now. ;-) I am not in favour of
>> changing them to reflect the mess the code base has got into. That's like
>> changing the law just because people keep breaking it.
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
> 
> 
> 
> 

-- 
Frank W. Zammetti
Founder and Chief Software Architect
Omnytex Technologies
http://www.omnytex.com
AIM: fzammetti
Yahoo: fzammetti
MSN: fzammetti@hotmail.com
Java Web Parts -
http://javawebparts.sourceforge.net
Supplying the wheel, so you don't have to reinvent it!

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


Re: Maven 2 website documentation editing

Posted by Ted Husted <te...@gmail.com>.
Yes, as to Action1, the vast majority of the style errors are a fair
cop and reflect things we shouldn't be doing.

Of course, as far as Action 1 is concerned, it's a fair question of
whether the checkstyle report adds any value. No one appears
interested in fixing the errors, and so there are still so many errors
that new ones go unnoticed.

I notice that as to Action2, the check style  plugin is commented out.
I tried enabling it on my working copy, but then it wouldn't build.


: reference not found: ConversionErrorInterceptor
C:/projects/Apache/struts-current/action2/core/src/main/java/org/apache/struts/action2/dispatcher/VelocityResult.java:80:
warning - Tag @link: reference not found: JspFactory

        at org.apache.maven.plugin.javadoc.AbstractJavadocMojo.executeReport(Abs
tractJavadocMojo.java:845)
        at org.apache.maven.plugin.javadoc.JavadocReport.generate(JavadocReport.
java:104)
        at org.apache.maven.plugins.site.SiteMojo.generateReportsPages(SiteMojo.
java:802)
        at org.apache.maven.plugins.site.SiteMojo.execute(SiteMojo.java:301)
        ... 18 more
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 28 seconds
[INFO] Finished at: Sun Jun 11 20:58:44 EDT 2006
[INFO] Final Memory: 20M/35M
[INFO] ------------------------------------------------------------------------


Do we know what is the problem with running checkstyle with Action2?

-Ted.

On 6/11/06, Martin Cooper <ma...@apache.org> wrote:
> You can blame whoever wrote the code. ;-) The Checkstyle rules for Struts
> have been in place for _years_, and it's been trivial to run a Checkstyle
> report for almost as long - even before we had 'ant release'. The original
> rules were based on the Sun / Craig coding conventions, so you shouldn't
> have a problem with them the way they are now. ;-) I am not in favour of
> changing them to reflect the mess the code base has got into. That's like
> changing the law just because people keep breaking it.

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


Re: Maven 2 website documentation editing

Posted by Martin Cooper <ma...@apache.org>.
On 6/10/06, Craig McClanahan <cr...@apache.org> wrote:
>
> Several notes and a mystery below.
>
> On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:
> >
> > On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:
> >
> > > You can also "stage" the entire site locally with:
> > >
> > >    'mvn site:stage'
> > >
> > > It defaults to target/staging, or you can specify
> > > -DstagingDirectory=/path/to/tempdir
> >
> > Strange.  The default is to put target/staging under each module,
> > which isn't any more useful than the separate target/site directories
> > that 'mvn site' builds.
> >
> > With -DstagingDirectory=/path/to/tempdir, though, it puts the entire
> > site together, just as it will be on the server.  So use that. :)
>
>
> Don't forget to add "-Pmyfaces" as well ... the site generation seems to
> want to compile everything again, and  some of the compiles will fail
> without either -Pmyfaces or -Pjsfri being explicity listed (most likely a
> Maven issue).
>
> Mystery:  This runs for me on my Linux desktop, but on my Windows XP
> laptop
> I get "Required goal not found: site:stage" ... it's as if Maven doesn't
> know that this goal exists.  It is Maven 2.0.4 in both cases.  Do I need
> to
> do something special to make it recognize this?
>
> Issues:
>
> * Can I blame Wendy (who got the site build to work) for the
>   many thousands of Checkstyle errors we need to wade through?  :-)
>   Nah ... that'd be shooting the messenger.  But it is a good opportunity
>   to tweak the rules we're asking it to enforce.


You can blame whoever wrote the code. ;-) The Checkstyle rules for Struts
have been in place for _years_, and it's been trivial to run a Checkstyle
report for almost as long - even before we had 'ant release'. The original
rules were based on the Sun / Craig coding conventions, so you shouldn't
have a problem with them the way they are now. ;-) I am not in favour of
changing them to reflect the mess the code base has got into. That's like
changing the law just because people keep breaking it.

--
Martin Cooper


* The JxrReport plugin seemed to fail on every module, looking for
>   a pom.xml in the directory above the "mvn_reorg" root.  Shouldn't
>   it be obeying the parent declarations in the POMs?
>
> * Even though I used the -DstagingDirectory approach, the javadocs
>   for the modules aren't correctly linked from the website home page.
>   That's probably because those links are done manually.
>
> * On the Project Summary page, the description seems to come from
>   the struts parent POM (and I think I've seen this text still in some of
> the
>   generated MANIFEST.MF files too).  Can we make it come from the
>   Shale parent instead?
>
> * The "Dependencies" and "Dependency Convergence" reports address
>   my earlier question about a hierarchical chain of dependencies, although
>   the links on the latter page are all broken.  But it pointed me to a
> version
>   mismatch problem that's already been fixed.
>
> * The "Source Repository" page doesn't have any information ... we'll
>   want to fill in the appropriate POM stuff for that.
>
> * The project reports for each module don't seem to be linked into the
> overall
>   site anywhere.  Should they be?
>
>
>
> --
> > Wendy
>
>
> Craig
>
>

Re: Maven 2 website documentation editing

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/11/06, James Mitchell <jm...@apache.org> wrote:

> I guess what I'm looking for is something like this:
>
> http://wiki.apache.org/struts/Shale/BuildingWithMaven2
>
> With something like the above, all the great hints and tricks you
> guys keep throwing around in the threads won't get lost.
>
> Not sure about other people, but when I get a few minutes to help,
> I'm never sure where to jump in.  Chances are that what I was working
> on previously has been updated or continued by someone else, which, I
> admit, is a *good* problem to have.
>
> What do you think?

That there's a constant struggle between getting things to work, and
stopping to write down how and why they work. :)  Thanks for starting
the wiki page.

There's a start on an assembly in a new shale-dist module.  I tried
using the latest version of the assembly plugin (v2.1) but I couldn't
get it to work.  The assembly descriptor format is different, it's
ignoring the <dependencySets> element, and it seems to only want to
work if it's in the top-level shale-parent pom.  I gave up and used
v2.0.1 which is working fine for Struts Action.

The assembly includes the website, so you have to build that first...
mvn site -Pmyfaces
cd shale-dist
mvn assembly:assembly -Pmyfaces

The zip file will be in target/assembly/out.  Right now it only
includes shale-core, but it's copy-and-paste to add the rest.

-- 
Wendy

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


Re: Maven 2 website documentation editing

Posted by James Mitchell <jm...@apache.org>.
I was looking into how to provide better aggregation.  It's been a  
while since I looked at that code, so please don't wait for me to  
provide a fix in the short term.  Between the day job and the kids  
(since school is out), I hardly have time to just keep up with  
mailing list traffic.

Go ahead with your plans, I'll try to look at this later this evening  
and a little bit tomorrow.  I'll have more time though later in the  
week.

I'm making certain assumptions about where we are and where we want  
to be, with respect to all of what the Maven build provides for  
Shale.  Is there a wiki page that outlines what we need/want?  What I  
mean is, take the old Ant build, each target gives a small  
description of what to expect when that target is run.  And more  
details are provided in the comments about what gets created and  
where it will be, etc, etc.

Given our current POM(s) structure, is there a list of commands with  
(and without) the known switches (-Pfoo -U) that details all the  
possible ways to get something done?  A list of what can be done?   
And a list of what currently doesn't work?  And why?

I guess what I'm looking for is something like this:

http://wiki.apache.org/struts/Shale/BuildingWithMaven2

With something like the above, all the great hints and tricks you  
guys keep throwing around in the threads won't get lost.

Not sure about other people, but when I get a few minutes to help,  
I'm never sure where to jump in.  Chances are that what I was working  
on previously has been updated or continued by someone else, which, I  
admit, is a *good* problem to have.

What do you think?


--
James Mitchell




On Jun 11, 2006, at 12:09 PM, Wendy Smoak wrote:

> On 6/11/06, James Mitchell <jm...@apache.org> wrote:
>
>> > I thought you were still building nightlies from the trunk, but  
>> yes,
>> > the assembly is next.  We can't do much about the aggregation  
>> anyway
>> > (unless James wants to go work on Maven plugins... ;) )
>> >
>>
>> Already looking at it, albeit with what limited time I have these  
>> days.
>
> At what?  Fixing some Maven plugins so they aggregate properly, or at
> the assembly?
>
> I just tried the new way with <moduleSets> [1] and couldn't get it to
> work, so I'm just using the descriptor from Struts Action with
> <fileSets> and relative paths.
>
> If you're doing it, though, I'll step aside. :)
>
> [1] http://maven.apache.org/plugins/maven-assembly-plugin/examples/ 
> multimodule/module-source-inclusion-simple.html
>
> -- 
> Wendy
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@struts.apache.org
> For additional commands, e-mail: dev-help@struts.apache.org
>


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


Re: Maven 2 website documentation editing

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/11/06, James Mitchell <jm...@apache.org> wrote:

> > I thought you were still building nightlies from the trunk, but yes,
> > the assembly is next.  We can't do much about the aggregation anyway
> > (unless James wants to go work on Maven plugins... ;) )
> >
>
> Already looking at it, albeit with what limited time I have these days.

At what?  Fixing some Maven plugins so they aggregate properly, or at
the assembly?

I just tried the new way with <moduleSets> [1] and couldn't get it to
work, so I'm just using the descriptor from Struts Action with
<fileSets> and relative paths.

If you're doing it, though, I'll step aside. :)

[1] http://maven.apache.org/plugins/maven-assembly-plugin/examples/multimodule/module-source-inclusion-simple.html

-- 
Wendy

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


Re: Maven 2 website documentation editing

Posted by James Mitchell <jm...@apache.org>.
On Jun 11, 2006, at 2:14 AM, Wendy Smoak wrote:

> On 6/10/06, Craig McClanahan <cr...@apache.org> wrote:
>> On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:
>
>> > Old site plugin?  Try -U on the command line to make it update, or
>> >    rm -rf $M2_REPO/org/apache/maven/plugins/maven-site-plugin
>> > so it will download again.
>>
>> The -U switch worked.  Hmm, does that mean Maven treats snapshot  
>> plugins
>> different from snapshot dependencies?
>
> Maven will not update released plugins unless you tell it to.  (I
> think it does check for new plugin snapshots, but we aren't using
> any.)
>
>> Just as one example ... as the site generation was occurring, I  
>> saw it
>> create checkstyle reports for each module.  But I can't seem to  
>> find them
>> anywhere on the generated site. I would imagine we should also be  
>> able to
>> see all the other module-specific reports.
>
> Maven-generated reports are always under the 'Project Reports' menu
> link.  Checkstyle should be there, along with PMD, Surefire, etc.
> Menu links can be added for the ones you want to highlight, such as
> Javadoc.
>
>> We'll clearly want an aggregated site, but I'm wondering if  
>> focusing on the
>> assembly stuff might not be more urgent, so we can resurrect the  
>> nightly
>> builds.  Those have a timeout on the server, and I'm getting  
>> pinged from a
>> couple of users that it looks like the project is not progressing  
>> since
>> those are not being generated.
>
> I thought you were still building nightlies from the trunk, but yes,
> the assembly is next.  We can't do much about the aggregation anyway
> (unless James wants to go work on Maven plugins... ;) )
>

Already looking at it, albeit with what limited time I have these days.

> -- 
> Wendy
>



--
James Mitchell




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


Re: Maven 2 website documentation editing

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/10/06, Craig McClanahan <cr...@apache.org> wrote:
> On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:

> > Old site plugin?  Try -U on the command line to make it update, or
> >    rm -rf $M2_REPO/org/apache/maven/plugins/maven-site-plugin
> > so it will download again.
>
> The -U switch worked.  Hmm, does that mean Maven treats snapshot plugins
> different from snapshot dependencies?

Maven will not update released plugins unless you tell it to.  (I
think it does check for new plugin snapshots, but we aren't using
any.)

> Just as one example ... as the site generation was occurring, I saw it
> create checkstyle reports for each module.  But I can't seem to find them
> anywhere on the generated site. I would imagine we should also be able to
> see all the other module-specific reports.

Maven-generated reports are always under the 'Project Reports' menu
link.  Checkstyle should be there, along with PMD, Surefire, etc.
Menu links can be added for the ones you want to highlight, such as
Javadoc.

> We'll clearly want an aggregated site, but I'm wondering if focusing on the
> assembly stuff might not be more urgent, so we can resurrect the nightly
> builds.  Those have a timeout on the server, and I'm getting pinged from a
> couple of users that it looks like the project is not progressing since
> those are not being generated.

I thought you were still building nightlies from the trunk, but yes,
the assembly is next.  We can't do much about the aggregation anyway
(unless James wants to go work on Maven plugins... ;) )

-- 
Wendy

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


Re: Maven 2 website documentation editing

Posted by Craig McClanahan <cr...@apache.org>.
On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:
>
> On 6/10/06, Craig McClanahan <cr...@apache.org> wrote:
>
> > Don't forget to add "-Pmyfaces" as well ... the site generation seems to
> > want to compile everything again, and  some of the compiles will fail
> > without either -Pmyfaces or -Pjsfri being explicity listed (most likely
> a
> > Maven issue).
>
> I have a question out on users@maven to see how to get exactly one of
> those activated, with a default.
>
> > Mystery:  This runs for me on my Linux desktop, but on my Windows XP
> laptop
> > I get "Required goal not found: site:stage" ... it's as if Maven doesn't
> > know that this goal exists.  It is Maven 2.0.4 in both cases.  Do I need
> to
> > do something special to make it recognize this?
>
> Old site plugin?  Try -U on the command line to make it update, or
>    rm -rf $M2_REPO/org/apache/maven/plugins/maven-site-plugin
> so it will download again.


The -U switch worked.  Hmm, does that mean Maven treats snapshot plugins
different from snapshot dependencies?

> * Even though I used the -DstagingDirectory approach, the javadocs
> >   for the modules aren't correctly linked from the website home page.
> >   That's probably because those links are done manually.
>
> I don't think it will automatically add links to sub-project Javadoc,
> but see below.
>
> > * On the Project Summary page, the description seems to come from
> >   the struts parent POM (and I think I've seen this text still in some
> of
> > the
> >   generated MANIFEST.MF files too).  Can we make it come from the
> >   Shale parent instead?
>
> Is there one?  Add a <description> to the shale-parent pom and it
> should override the inherited one.  Keep in mind that the jar plugin
> uses <description> as the Specification-Title.  There's an issue open,
> we're arguing that it should use <name> instead and give us back the
> multi-line description.


I'll do that with <description> for now, but I'm on your side about using
<name> for the manifest.

> * The "Dependencies" and "Dependency Convergence" reports address
> >   my earlier question about a hierarchical chain of dependencies,
> although
> >   the links on the latter page are all broken.  But it pointed me to a
> > version  mismatch problem that's already been fixed.
>
> I think I've seen that mentioned on the Maven user list, there's
> probably an issue open.


OK.

> * The project reports for each module don't seem to be linked into the
> > overall site anywhere.  Should they be?
>
> I'm not sure what you mean, can you give an example of what you want it to
> do?


Just as one example ... as the site generation was occurring, I saw it
create checkstyle reports for each module.  But I can't seem to find them
anywhere on the generated site. I would imagine we should also be able to
see all the other module-specific reports.

Everything is moving towards aggregation, but not all of it works yet.
> As with Maven 1, you can override the default page that gets
> generated, so for example in Struts Action we have
> src/site/apidocs/index.xml for this:
>    http://struts.apache.org/struts-action/apidocs/index.html


We'll clearly want an aggregated site, but I'm wondering if focusing on the
assembly stuff might not be more urgent, so we can resurrect the nightly
builds.  Those have a timeout on the server, and I'm getting pinged from a
couple of users that it looks like the project is not progressing since
those are not being generated.

--
> Wendy


Craig


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

Re: Maven 2 website documentation editing

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/10/06, Craig McClanahan <cr...@apache.org> wrote:

> Don't forget to add "-Pmyfaces" as well ... the site generation seems to
> want to compile everything again, and  some of the compiles will fail
> without either -Pmyfaces or -Pjsfri being explicity listed (most likely a
> Maven issue).

I have a question out on users@maven to see how to get exactly one of
those activated, with a default.

> Mystery:  This runs for me on my Linux desktop, but on my Windows XP laptop
> I get "Required goal not found: site:stage" ... it's as if Maven doesn't
> know that this goal exists.  It is Maven 2.0.4 in both cases.  Do I need to
> do something special to make it recognize this?

Old site plugin?  Try -U on the command line to make it update, or
   rm -rf $M2_REPO/org/apache/maven/plugins/maven-site-plugin
so it will download again.

> * Even though I used the -DstagingDirectory approach, the javadocs
>   for the modules aren't correctly linked from the website home page.
>   That's probably because those links are done manually.

I don't think it will automatically add links to sub-project Javadoc,
but see below.

> * On the Project Summary page, the description seems to come from
>   the struts parent POM (and I think I've seen this text still in some of
> the
>   generated MANIFEST.MF files too).  Can we make it come from the
>   Shale parent instead?

Is there one?  Add a <description> to the shale-parent pom and it
should override the inherited one.  Keep in mind that the jar plugin
uses <description> as the Specification-Title.  There's an issue open,
we're arguing that it should use <name> instead and give us back the
multi-line description.

> * The "Dependencies" and "Dependency Convergence" reports address
>   my earlier question about a hierarchical chain of dependencies, although
>   the links on the latter page are all broken.  But it pointed me to a
> version  mismatch problem that's already been fixed.

I think I've seen that mentioned on the Maven user list, there's
probably an issue open.

> * The project reports for each module don't seem to be linked into the
> overall site anywhere.  Should they be?

I'm not sure what you mean, can you give an example of what you want it to do?

Everything is moving towards aggregation, but not all of it works yet.
 As with Maven 1, you can override the default page that gets
generated, so for example in Struts Action we have
src/site/apidocs/index.xml for this:
   http://struts.apache.org/struts-action/apidocs/index.html

-- 
Wendy

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


Re: Maven 2 website documentation editing

Posted by Craig McClanahan <cr...@apache.org>.
Several notes and a mystery below.

On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:
>
> On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:
>
> > You can also "stage" the entire site locally with:
> >
> >    'mvn site:stage'
> >
> > It defaults to target/staging, or you can specify
> > -DstagingDirectory=/path/to/tempdir
>
> Strange.  The default is to put target/staging under each module,
> which isn't any more useful than the separate target/site directories
> that 'mvn site' builds.
>
> With -DstagingDirectory=/path/to/tempdir, though, it puts the entire
> site together, just as it will be on the server.  So use that. :)


Don't forget to add "-Pmyfaces" as well ... the site generation seems to
want to compile everything again, and  some of the compiles will fail
without either -Pmyfaces or -Pjsfri being explicity listed (most likely a
Maven issue).

Mystery:  This runs for me on my Linux desktop, but on my Windows XP laptop
I get "Required goal not found: site:stage" ... it's as if Maven doesn't
know that this goal exists.  It is Maven 2.0.4 in both cases.  Do I need to
do something special to make it recognize this?

Issues:

* Can I blame Wendy (who got the site build to work) for the
  many thousands of Checkstyle errors we need to wade through?  :-)
  Nah ... that'd be shooting the messenger.  But it is a good opportunity
  to tweak the rules we're asking it to enforce.

* The JxrReport plugin seemed to fail on every module, looking for
  a pom.xml in the directory above the "mvn_reorg" root.  Shouldn't
  it be obeying the parent declarations in the POMs?

* Even though I used the -DstagingDirectory approach, the javadocs
  for the modules aren't correctly linked from the website home page.
  That's probably because those links are done manually.

* On the Project Summary page, the description seems to come from
  the struts parent POM (and I think I've seen this text still in some of
the
  generated MANIFEST.MF files too).  Can we make it come from the
  Shale parent instead?

* The "Dependencies" and "Dependency Convergence" reports address
  my earlier question about a hierarchical chain of dependencies, although
  the links on the latter page are all broken.  But it pointed me to a
version
  mismatch problem that's already been fixed.

* The "Source Repository" page doesn't have any information ... we'll
  want to fill in the appropriate POM stuff for that.

* The project reports for each module don't seem to be linked into the
overall
  site anywhere.  Should they be?



--
> Wendy


Craig

Re: Maven 2 website documentation editing

Posted by Wendy Smoak <ws...@gmail.com>.
On 6/10/06, Wendy Smoak <ws...@gmail.com> wrote:

> You can also "stage" the entire site locally with:
>
>    'mvn site:stage'
>
> It defaults to target/staging, or you can specify
> -DstagingDirectory=/path/to/tempdir

Strange.  The default is to put target/staging under each module,
which isn't any more useful than the separate target/site directories
that 'mvn site' builds.

With -DstagingDirectory=/path/to/tempdir, though, it puts the entire
site together, just as it will be on the server.  So use that. :)

-- 
Wendy

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