On Dec 21, 2008, at 8:23 AM, Janne Jalkanen wrote:
- I committed a few typo corrections, not important
- there should be package documentation, which tells the reader
at least
what you just said: *org.apache.jspwiki.api.* is the one you can
rely on.
Yup, good point.
+1 Regardless of how we name the api that can be relied on (see
discussion at https://issues.apache.org/jira/browse/JSPWIKI-38 ) the
package doc should indicate which APIs are intended to be stable.
- do we need all the @since tags ?
I'm still wondering whether they should refer to API versions.
I've found @since tags to be valuable as a way to see what's changed.
Especially useful for migrating plugins from earlier releases. I don't
see anything wrong with adding @since 3.0.0 to new APIs and tagging
the others with e.g. 2.8.0 for features that were in 2.8, even though
they were in a class instead of an interface.
But I'm not a user voice, so take this as a mild suggestion for
discussion not a recommendation.
BTW, I created a new issue: https://issues.apache.org/jira/browse/JSPWIKI-461
for tracking what should be done before an incubating release. I
think there are still several administrative issues (like whatever
status raports, etc). Then we probably need an issue for graduation
as well. I trust our mentors can review and tell us what stuff is
missing?
There's really nothing else to do before releasing. The release
process from the incubator is mainly an exercise in reviewing the
release package to make sure that all code is legally releasable under
the Apache license (code developed or donated to the project itself)
or compatible licenses (code developed elsewhere and released as part
of the package for convenience, e.g. the lib directory jar files).
The process that I observed Janne perform while verifying the
provenance of the code that was imported simply needs to be documented
in the status file incubator/trunk/site-author/projects/jspwiki.xml.
IIRC, the items identified as Copyright and Distribution Rights need
to be dated as of the date the work was completed.
Craig
/Janne
Craig L Russell
Architect, Sun Java Enterprise System http://db.apache.org/jdo
408 276-5638 mailto:[email protected]
P.S. A good JDO? O, Gasp!
