greenrd 00/11/13 12:53:02
Modified: . changes.xml
xdocs contrib.xml 3rdparty.xml site-book.xml
docs-book.xml
Added: xdocs patches.xml
Log:
new contrib system ready
Revision Changes Path
1.145 +5 -1 xml-cocoon/changes.xml
Index: changes.xml
===================================================================
RCS file: /home/cvs/xml-cocoon/changes.xml,v
retrieving revision 1.144
retrieving revision 1.145
diff -u -r1.144 -r1.145
--- changes.xml 2000/11/10 21:12:28 1.144
+++ changes.xml 2000/11/13 20:52:50 1.145
@@ -4,7 +4,7 @@
<!--
History of Cocoon changes
- $Id: changes.xml,v 1.144 2000/11/10 21:12:28 greenrd Exp $
+ $Id: changes.xml,v 1.145 2000/11/13 20:52:50 greenrd Exp $
-->
<changes title="History of Changes">
@@ -18,6 +18,10 @@
</devs>
<release version="@version@" date="@date@">
+ <action dev="RDG" type="add">
+ Simple (manual!) contributions management system for contributions
+ to Cocoon. See documentation.
+ </action>
<action dev="RDG" type="add">
Added ability to get tailored Configurations for superclasses
and support classes.
1.3 +24 -12 xml-cocoon/xdocs/contrib.xml
Index: contrib.xml
===================================================================
RCS file: /home/cvs/xml-cocoon/xdocs/contrib.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- contrib.xml 2000/11/10 02:13:19 1.2
+++ contrib.xml 2000/11/13 20:52:51 1.3
@@ -99,7 +99,7 @@
to make changes directly in CVS. If you submit many good patches, you may
be
nominated as a committer yourself!)</p>
- <p>If your contribution requires changing more than a few lines of Cocon
(code or
+ <p>If your contribution requires changing more than a few lines of Cocoon
(code or
documentation), then it counts as a <strong>patch</strong>. If you have a
patch and
would like to see it incorporated into the Cocoon distribution, take note
of the Licensing
Requirements listed below, and then read the <connect
href="patches.xml">Patch management
@@ -116,23 +116,24 @@
applied by users who wish to use them.
</p>
- <p>A typical contribution (not a patch) may go through the following
stages:
+ <p>A typical contribution (not a patch) may go through the following
stages:</p>
+
<ol>
<li>Posted to cocoon-users with a URL to download it from.</li>
<li>Listed on 3rdparty.html by a maintainer. [No requirements, other than
relevance (at the moment).]</li>
<li>Inclusion into the <code>contrib</code> directory,
which is for 3rd-party contributions that have been tested, but are not
necessarily
mature enough or general enough for the main distribution. [Must be
tested at least as
- specified below. See also Licensing Requirements below.]
+ specified below. See also Licensing Requirements below.]</li>
<li>Inclusion into the main distribution. [Committers must be confident
that it should work properly in
- most/all environments, and it must be considered sufficiently useful and
general to go into Cocoon. See also
- Licensing Requirements below].</li>
+ most/all environments, it must be documented as appropriate, and it must
be considered sufficiently
+ useful and general to go into Cocoon. See also Licensing Requirements
below].</li>
</ol>
<s2 title="Testing Requirements for Cocoon Contrib and Distribution">
<note>These tests do not apply to Cocoon 2 because it is designed
- to have different minimum requirements. As Cocoon 2 is still alpha we
are not at a rigourous
- test stage yet. Stay tuned!</note>
+ to have different minimum requirements. As Cocoon 2 is still alpha (at
the time of this writing),
+ we are not at a rigourous test stage yet. Stay tuned!</note>
<p>All new code should be tested under the following servlet engines:</p>
<ul>
@@ -154,17 +155,28 @@
the contributor is not required to do the testing - indeed it is
probably better
if someone else tests it, because the contributor might be tempted to do
less
than thorough testing!</p>
- </s2>
+ </s2>
+
+ <s2 title="Documentation Requirements for Cocoon Distribution">
+ <p>All new features (processor, logicsheets, config options etc.) should
be documented
+ appropriately (in XML or in cocoon.properties in the case of config
options).</p>
+
+ <p>Use something like <code>xdocs/index.xml</code> as a rough guide, add
+ the new page(s) to <code>xdocs/site-book.xml</code> and
<code>xdocs/docs-book.xml</code>,
+ and type <code>build.sh docs</code> or <code>build.bat docs</code> to
test the
+ documentation build.
+ </p>
+ </s2>
<s2 title="Licensing Requirements for the Cocoon Distribution">
<p>To avoid legal problems, the Apache Project Management Committe (PMC)
have agreed on
a policy for under what licensing code can be accepted into Apache
projects:</p>
<ul>
- <ol>Source code files must be under the Apache license and must have
copyright assigned to
- the Apache Software Foundation.</ol>
- <ol>Jar files need only be released under a license that permits free
redistribution
+ <li>Source code files must be under the Apache license and must have
copyright assigned to
+ the Apache Software Foundation.</li>
+ <li>Jar files need only be released under a license that permits free
redistribution
and does not cover new files added to the jar/library (so the GPL and
LGPL are not allowed,
- but MPL and Apache licenses are, for example).</ol>
+ but MPL and Apache licenses are, for example).</li>
</ul>
<p><strong>By submitting a patch, you signify your understanding and
acceptance of these
conditions</strong> - like most open source projects,
1.2 +1 -2 xml-cocoon/xdocs/3rdparty.xml
Index: 3rdparty.xml
===================================================================
RCS file: /home/cvs/xml-cocoon/xdocs/3rdparty.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- 3rdparty.xml 2000/11/10 02:13:19 1.1
+++ 3rdparty.xml 2000/11/13 20:52:51 1.2
@@ -52,8 +52,7 @@
</p>
<p>To have a link added to this table, see <connect href="contrib.xml">How
to contribute
- to Apache Cocoon</connect>.
- <p>
+ to Apache Cocoon</connect>.</p>
<table>
<tr>
1.21 +4 -1 xml-cocoon/xdocs/site-book.xml
Index: site-book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon/xdocs/site-book.xml,v
retrieving revision 1.20
retrieving revision 1.21
diff -u -r1.20 -r1.21
--- site-book.xml 2000/11/10 00:44:54 1.20
+++ site-book.xml 2000/11/13 20:52:51 1.21
@@ -20,6 +20,7 @@
<external label="XML Links"
href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/"/>
<separator/>
<page id="xsp" label="XSP Processor" source="xspprocessor.xml"/>
+ <spec id="wd-xsp" label="XSP WD" source="WD-xsp.xml"/>
<page id="sqltaglib" label="SQL XSP Taglib" source="sqltaglib.xml"/>
<page id="fp" label="FP XSP Taglib" source="fptaglib.xml"/>
<page id="connection-pool" label="SQL Conn Pool"
source="connection-pool.xml"/>
@@ -27,7 +28,9 @@
<page id="ldap" label="LDAP Processor" source="ldapprocessor.xml"/>
<page id="dcp" label="DCP Processor" source="dcpprocessor.xml"/>
<separator/>
- <spec id="wd-xsp" label="XSP WD" source="WD-xsp.xml"/>
+ <page id="contrib" label="Contributing" source="contrib.xml"/>
+ <page id="3rdparty" label="3rd Party" source="3rdparty.xml"/>
+ <page id="patches" label="Patch Queue" source="patches.xml"/>
<separator/>
<page id="cocoon2" label="Cocoon 2" source="cocoon2.xml"/>
<separator/>
1.20 +4 -1 xml-cocoon/xdocs/docs-book.xml
Index: docs-book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon/xdocs/docs-book.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- docs-book.xml 2000/11/10 00:44:54 1.19
+++ docs-book.xml 2000/11/13 20:52:51 1.20
@@ -16,6 +16,7 @@
<external label="XML Links"
href="http://dmoz.org/Computers/Data_Formats/Markup_Languages/XML/"/>
<separator/>
<page id="xsp" label="XSP Processor" source="xspprocessor.xml"/>
+ <spec id="wd-xsp" label="XSP WD" source="WD-xsp.xml"/>
<page id="sqltaglib" label="SQL XSP Taglib" source="sqltaglib.xml"/>
<page id="fp" label="FP XSP Taglib" source="fptaglib.xml"/>
<page id="connection-pool" label="SQL Conn Pool"
source="connection-pool.xml"/>
@@ -23,7 +24,9 @@
<page id="ldap" label="LDAP Processor" source="ldapprocessor.xml"/>
<page id="dcp" label="DCP Processor" source="dcpprocessor.xml"/>
<separator/>
- <spec id="wd-xsp" label="XSP WD" source="WD-xsp.xml"/>
+ <page id="contrib" label="Contributing" source="contrib.xml"/>
+ <external label="3rd Party"
href="http://xml.apache.org/cocoon/3rdparty.xml"/>
+ <external label="Patch Queue"
href="http://xml.apache.org/cocoon/patches.xml"/>
<separator/>
<external label="Javadocs" href="./api/index.html"/>
<separator/>
1.1 xml-cocoon/xdocs/patches.xml
Index: patches.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document SYSTEM "./dtd/document-v10.dtd">
<document>
<header>
<title>Patch Queue</title>
<authors>
<person name="Robin Green" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Introduction">
<p>
This is an <strong>informal</strong> list - in chronological order -
of some of the noteworthy patches that have been posted
to the <link href="mailto:[email protected]";>cocoon-dev</link>
mailing list.
These patches are not (yet) part of the Cocoon project, but need reviewing
for possible
inclusion. This system was instituted because, due to the large volume of
mail and
the lack of time of the committers, some patches tended to get forgetten
about. This
queue does not guarantee that any patch will be reviewed within a
reasonable time frame,
but it does at least make them easier to find!
</p>
<p><strong>Reviewers wanted!</strong> - If you have time to review and/or
test these patches,
we would be grateful for your time. Please post comments to the cocoon-dev
mailing lists.
</p>
<p>
Before submitting a patch, please read the page on <link
href="contrib.xml">Third-Party
Contributions</link>. The preferred submission method for patches is:
</p>
<ul>
<li>Post to [email protected]</li>
<li>Describe the patch, the reason for it and (if necessary) why this is
important.</li>
<li>Generate the patch in <code>diff -u</code> format from CVS</li>
<li>Also generate a documentation patch or new file, if this is something
that should be documented.
</li>
<li>Post as an attachment rather than inline (unless it is trivially
small).</li>
</ul>
<p>Following the above guidelines will facilitate your patch being reviewed
and applied efficiently.</p>
</s1>
<s1 title="Patch Queue">
<p><strong> [Under Construction] </strong> Archive links will be added
later.
<strong>Please do not bother the patch submitters/authors</strong> without
first reading the
relevant post(s) in the <connect href="mail-archives.xml">mailing list
archives.</connect>
</p>
<p>Vapourware will not be listed.</p>
<table>
<tr>
<th>Date Posted</th>
<th>Subject <!--and Link--></th>
<th>Brief Description/Comments <!--(click link for more)--></th>
<th>Submitted/Written By</th>
<th>Patch Against Version (mandatory)</th>
</tr>
<tr>
<td>Unknown, 2000</td>
<td><link href="http://sourcery.linuxave.net/";>Pipeline
debugging</link></td>
<td>This is not actually a patch, but a slightly forked version of Cocoon
with
ability to output what is the results of each stage of the pipeline to
files.
Needs work to merge it!
</td>
<td><link href="mailto:[EMAIL PROTECTED]">Robin Green</link></td>
<td>1.7.1-dev</td>
</tr>
<tr>
<td>Unknown, 2000</td>
<td>session.xsl</td>
<td>JSDK2.0/2.1 HttpSession objects removeValue() method doesn't have a
tag. +more...</td>
<td>Corey O'Donovan</td>
<td>1.?</td>
</tr>
<tr>
<td>28 Oct 2000</td>
<td>resource URL: handling</td>
<td>Allows resource: URLs to be used everywhere, e.g. can read from JARs
in XSLT.
NOTE: This particular approach was discouraged in an earlier cocoon-dev
discussion because of
possible security manager problems.
</td>
<td><link href="mailto:[EMAIL PROTECTED]">Ovidiu Predescu</link></td>
<td>1.?</td>
</tr>
<tr>
<td>29 Oct 2000</td>
<td>Browser database capabilities</td>
<td>Extensive changes to user agent recognition and a capabilities
map.</td>
<td><link href="mailto:[EMAIL PROTECTED]">Ovidiu Predescu</link></td>
<td>1.?</td>
</tr>
<tr>
<td>31 Oct 2000</td>
<td>User Agent support in cmd line</td>
<td>Support for specifying user agent in the command line and outputting
to stdout.</td>
<td><link href="mailto:[EMAIL PROTECTED]">Ovidiu Predescu</link></td>
<td>1.?</td>
</tr>
<tr>
<td>4 Nov 2000</td>
<td>Classloader conflicts (XSP)</td>
<td>Fixes classloader conflicts with XSP and some servlet engines (Resin).
NOTE: patch requires JDK1.2, Cocon 1.x must not require JDK1.2 so patch
must be made reflective.</td>
<td><link href="mailto:[EMAIL PROTECTED]">Sergei Ivanov</link></td>
<td>1.?</td>
</tr>
<tr>
<td>8 Nov 2000</td>
<td>XSP Debugger</td>
<td>Alternative patch to "pipeline debugger" at top of this queue.
Ideally the best of both solutions should be extracted.
</td>
<td><link href="mailto:[EMAIL PROTECTED]">Michael Hussey</link></td>
<td>1.8</td>
</tr>
</table>
<p>See also additional list of patches to be added in <connect
href="todo.xml">To Do</connect>.
</p>
</s1>
</body>
</document>
