You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avalon.apache.org by Peter Donald <pe...@apache.org> on 2002/03/31 00:21:29 UTC

Release requirements?

Hi,

I was thinking about what should be the minimum requirements for us to 
release a component from excalibur. I was thinking that the following would 
be good as minimum requirements. 

* must pass checkstyle with 0 violations (which basically means lots more 
javadocing)
* must pass all unit tests
* must have one or more examples showing how to use package
* must not have any circular dependencies in package structure
* must have package.html that describes basic package usage (and possibly 
redirects to examples directory for more complete examples)
* must have docs/index.html that describes basic purpose and scope of 
component 
* should have links to examples/ and package.html from docs/index.html 
* should have 0 errors when performing javadoc

Comments?

-- 
Cheers,

Pete

--------------------------------------------
 Beer is proof that God loves us and wants 
 us to be happy. -- Benjamin Franklin
--------------------------------------------

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Release requirements?

Posted by Peter Donald <pe...@apache.org>.
On Fri, 5 Apr 2002 10:48, Leif Mortenson wrote:
> Eung-ju Park wrote:
> >>I was thinking about what should be the minimum requirements for us to
> >>release a component from excalibur. I was thinking that the following
> >
> >would
> >
> >>be good as minimum requirements.
> >>
> >>* must pass checkstyle with 0 violations (which basically means lots more
> >>javadocing)
> >
> >Javadocing all method of implementation class is painful to me.
> >I already javadocing Cache interface. But checkstyle need javadoing all
> >method
> >of  AbstractCache, ValidatingCache, SynchronizedCache, LRUCache...
> >Are we must pass checkstyle with 0 violations?
> >
> >All other requirements is good.
> >
> :-)  I know that it is difficult, but remember that without all of the
>
> javadocs, it is very difficult for
> someone else to use the classes correctly and understand how to create
> them.  Remember that
> there are lots of people willing to help out improving the javadocs
> later once there is something
> to work with.  So please make at attempt at them.

Another thing I do that seems to work well. Javadoc the interface and then in 
all the implementations do a 
@see MyInterface#myMethod

so that majority of documentation is in interface and linked from the impl. 
Then you just add in implementation documentation in the impl class.


-- 
Cheers,

Pete

---------------------------------------------------
"Marriage, Friends, Religon -- these are the demons 
you must slay in order to suceed in business.." 
                 -- Mr. Burns, The Simpsons 
---------------------------------------------------

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Release requirements?

Posted by Leif Mortenson <le...@tanukisoftware.com>.
Eung-ju Park wrote:

>>I was thinking about what should be the minimum requirements for us to
>>release a component from excalibur. I was thinking that the following
>>
>would
>
>>be good as minimum requirements.
>>
>>* must pass checkstyle with 0 violations (which basically means lots more
>>javadocing)
>>
>
>Javadocing all method of implementation class is painful to me.
>I already javadocing Cache interface. But checkstyle need javadoing all
>method
>of  AbstractCache, ValidatingCache, SynchronizedCache, LRUCache...
>Are we must pass checkstyle with 0 violations?
>
>All other requirements is good.
>
:-)  I know that it is difficult, but remember that without all of the 
javadocs, it is very difficult for
someone else to use the classes correctly and understand how to create 
them.  Remember that
there are lots of people willing to help out improving the javadocs 
later once there is something
to work with.  So please make at attempt at them.

Cheers,
Leif



--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Release requirements?

Posted by Eung-ju Park <co...@apache.org>.
----- Original Message -----
From: "Peter Donald" <pe...@apache.org>
To: "Avalon Developers List" <av...@jakarta.apache.org>
Sent: Sunday, March 31, 2002 8:21 AM
Subject: Release requirements?


> Hi,
>
> I was thinking about what should be the minimum requirements for us to
> release a component from excalibur. I was thinking that the following
would
> be good as minimum requirements.
>
> * must pass checkstyle with 0 violations (which basically means lots more
> javadocing)

Javadocing all method of implementation class is painful to me.
I already javadocing Cache interface. But checkstyle need javadoing all
method
of  AbstractCache, ValidatingCache, SynchronizedCache, LRUCache...
Are we must pass checkstyle with 0 violations?

All other requirements is good.



--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Release requirements?

Posted by Peter Donald <pe...@apache.org>.
On Mon, 1 Apr 2002 17:35, Leo Simons wrote:
> > I plan to write a task that automagically generates a manifest
> > that declares
> > dependencies on other jars via the standard "Optional Packages" mechanism
> > (previously known as "Extension" mechanism). Actually I have
> > already written
> > it .. just needs time to dcecouple it from the project it was
> > used in and add
> > it into ant ;)
>
> well that's a happy surprise =)

It actually proved to be much harder too decouple from last project so will 
take a while to extract out. But should be in next ant release in a month or 
two.

-- 
Cheers,

Pete

----------------------------------------------------
"The only way to discover the limits of the possible 
is to go beyond them into the impossible." 
                             -Arthur C. Clarke
----------------------------------------------------

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


RE: Release requirements?

Posted by Leo Simons <le...@apache.org>.
> On Mon, 1 Apr 2002 07:25, Leo Simons wrote:
> > There's nothing about JDKs. Should compile & run with version
> > 1.3 and 1.4, perhaps?
> 
> 1.2 is the default target for most things that I am using. The exception 
> being Phoenix which uses the jdk1.3 proxies and framework that 
> can optionally 
> build a JDK1.4 Logger if JDK1.4 present. 
> 
> Is there any other jdk dependencies ?

I can't really tell. All I ever use is 1.3 and it never chokes
on anythin' =) I'm just talking 'bout what should be 'requirments'.

> > Also, should follow that last legal stuff sent out over
> > committers@apache.org :)
> 
> Which particular bit is that? The excalibur jars all place the 
> LICENSE.txt in 
> META-INF/, phoenix no longer distributes non-Apache jars.
<snip>
> Ones we need to investigate;
> jakarta-avalon-excalibur/all/lib/jaxen-full.jar 
> jakarta-avalon-excalibur/all/lib/saxpath.jar 

This bit, I guess. It is probably best to check stuff like this
before any new release, hence the comment.

> > On a related note, how do we handle versioning and
> > compatibilities (which could get very messy with all
> > those jars lying around).
> 
> I plan to write a task that automagically generates a manifest 
> that declares 
> dependencies on other jars via the standard "Optional Packages" mechanism 
> (previously known as "Extension" mechanism). Actually I have 
> already written 
> it .. just needs time to dcecouple it from the project it was 
> used in and add 
> it into ant ;)

well that's a happy surprise =)

grz,

- Leo


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Release requirements?

Posted by Peter Donald <pe...@apache.org>.
On Mon, 1 Apr 2002 07:25, Leo Simons wrote:
> There's nothing about JDKs. Should compile & run with version
> 1.3 and 1.4, perhaps?

1.2 is the default target for most things that I am using. The exception 
being Phoenix which uses the jdk1.3 proxies and framework that can optionally 
build a JDK1.4 Logger if JDK1.4 present. 

Is there any other jdk dependencies ?

> Also, should follow that last legal stuff sent out over
> committers@apache.org :)

Which particular bit is that? The excalibur jars all place the LICENSE.txt in 
META-INF/, phoenix no longer distributes non-Apache jars.

Some of the other jars that we are using and should not be or should add 
license for by the end of the 90 day grace period;

Ones we just need to add licenses for;
jakarta-avalon/tools/lib/junit.jar (IBM Common license)
jakarta-avalon/tools/lib/junitperf.jar (BSD license)
jakarta-avalon/tools/lib/rhino.jar (Mozilla license)
jakarta-avalon/tools/lib/bsf.jar (IBM Common License)
jakarta-avalon-excalibur/all/lib/jdom.jar 
jakarta-avalon-apps/db/lib/bsf.jar (IBM Common License)
jakarta-avalon-apps/db/lib/js.jar (Mozilla license)
jakarta-avalon-apps/hsql/lib/hsqldb.jar (???)
jakarta-avalon-apps/enterprise/orb/lib/openorb-1.3.0.jar
jakarta-avalon-apps/enterprise/orb/lib/openorb_tools-1.3.0.jar
jakarta-avalon-apps/enterprise/ots/lib/openorb_ots-1.3.0.jar
jakarta-avalon-apps/enterprise/time/lib/openorb_event-1.3.0.jar

Ones we need to remove;
jakarta-avalon/tools/ext/resolver.jar (in xml-commons now anyway)
jakarta-avalon/tools/ext/jimi.jar 
jakarta-avalon-apps/enterprise/ots/lib/jdbc2_0-stdext.jar
jakarta-avalon-apps/enterprise/ots/lib/jjta_1.0.1.jar
jakarta-avalon-apps/enterprise/ots/lib/savepoint.jar

Ones we need to investigate;
jakarta-avalon-excalibur/all/lib/jaxen-full.jar 
jakarta-avalon-excalibur/all/lib/saxpath.jar 

> On a related note, how do we handle versioning and
> compatibilities (which could get very messy with all
> those jars lying around).

I plan to write a task that automagically generates a manifest that declares 
dependencies on other jars via the standard "Optional Packages" mechanism 
(previously known as "Extension" mechanism). Actually I have already written 
it .. just needs time to dcecouple it from the project it was used in and add 
it into ant ;)

> cheers, and happy easter,

back at yah

-- 
Cheers,

Pete

---------------------------------------------------
"Marriage, Friends, Religon -- these are the demons 
you must slay in order to suceed in business.." 
                 -- Mr. Burns, The Simpsons 
---------------------------------------------------

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


RE: Release requirements?

Posted by Leo Simons <ma...@leosimons.com>.
There's nothing about JDKs. Should compile & run with version
1.3 and 1.4, perhaps?

Also, should follow that last legal stuff sent out over
committers@apache.org :)

On a related note, how do we handle versioning and
compatibilities (which could get very messy with all
those jars lying around).

cheers, and happy easter,

- Leo

> -----Oorspronkelijk bericht-----
> Van: Peter Donald [mailto:peter@apache.org]
> Verzonden: Sunday, March 31, 2002 12:21 AM
> Aan: Avalon Developers List
> Onderwerp: Release requirements?
>
>
> Hi,
>
> I was thinking about what should be the minimum requirements for us to
> release a component from excalibur. I was thinking that the
> following would
> be good as minimum requirements.
>
> * must pass checkstyle with 0 violations (which basically means lots more
> javadocing)
> * must pass all unit tests
> * must have one or more examples showing how to use package
> * must not have any circular dependencies in package structure
> * must have package.html that describes basic package usage (and possibly
> redirects to examples directory for more complete examples)
> * must have docs/index.html that describes basic purpose and scope of
> component
> * should have links to examples/ and package.html from docs/index.html
> * should have 0 errors when performing javadoc
>
> Comments?
>
> --
> Cheers,
>
> Pete
>
> --------------------------------------------
>  Beer is proof that God loves us and wants
>  us to be happy. -- Benjamin Franklin
> --------------------------------------------
>
> --
> To unsubscribe, e-mail:
> <ma...@jakarta.apache.org>
> For additional commands, e-mail:
> <ma...@jakarta.apache.org>
>
>


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>