dion 2003/08/07 09:52:38
Modified: xdocs/reference Tag: MAVEN_RC1_STABLE dirlayout.xml
user-guide.xml project-descriptor.xml
xdocs Tag: MAVEN_RC1_STABLE navigation.xml faq.fml
xdocs/start Tag: MAVEN_RC1_STABLE integrate.xml
xdocs/ant-guide Tag: MAVEN_RC1_STABLE practical.xml
Added: xdocs/ant-guide/qna Tag: MAVEN_RC1_STABLE properties.xml
Log:
Update from back ported fixes
Revision Changes Path
No revision
No revision
1.7.4.1 +3 -3 maven/xdocs/reference/dirlayout.xml
Index: dirlayout.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/dirlayout.xml,v
retrieving revision 1.7
retrieving revision 1.7.4.1
diff -u -r1.7 -r1.7.4.1
--- dirlayout.xml 27 Jun 2003 02:00:58 -0000 1.7
+++ dirlayout.xml 7 Aug 2003 16:52:38 -0000 1.7.4.1
@@ -59,9 +59,9 @@
<td>
The code may be placed into separate source code directories
by language, as in src/java/ and src/php/ for source code in
- the Java and PHP languages respectively. Other projects may
- separate the code according to function (src/share,
- src/test, src/rttest). It is highly recommended that
+ the Java and PHP languages respectively. The separation into
+ directories according to function (src/share, src/core, src/web)
+ is currently not supported by Maven. It is highly recommended that
sub-directories be used under src/.
</td>
</tr>
1.56.2.1 +47 -12 maven/xdocs/reference/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/user-guide.xml,v
retrieving revision 1.56
retrieving revision 1.56.2.1
diff -u -r1.56 -r1.56.2.1
--- user-guide.xml 11 Jul 2003 07:29:05 -0000 1.56
+++ user-guide.xml 7 Aug 2003 16:52:38 -0000 1.56.2.1
@@ -328,7 +328,6 @@
<source><![CDATA[
<project
default="nightly-build"
- xmlns:m="maven"
xmlns:j="jelly:core"
xmlns:u="jelly:util">
@@ -374,14 +373,6 @@
</p>
</li>
<li>
- <code>xmlns:m="maven"</code>
- <p>
- This tells Jelly that all XML elements prefixed with <code>m:</code>
- are part of the tag library registered with jelly
- under the identifier <code>maven</code>.
- </p>
- </li>
- <li>
<code>xmlns:u="jelly:util"</code>
<p>
This tells Jelly that all XML elements prefixed with <code>u:</code>
@@ -1109,7 +1100,20 @@
<section name="Testing">
+ <!-- Change this section into a demonstratino of the resources element in
general -->
+
<subsection name="Test Resources">
+ <p>
+ It is a fairly common occurrence that you want to include some resources
in your
+ test classpath for testing purposes. Maven allows you include any
arbitrary set of
+ resources for testing by utilizing the project/build/unitTest/resources
element in your POMs.
+ </p>
+
+ <p>
+ The following example demonstrates how to recursively include all files
with an 'xml'
+ or 'properties' extension within the ${basedir}/src/test directory:
+ </p>
+
<source><![CDATA[
<project>
...
@@ -1118,12 +1122,11 @@
<unitTest>
...
<resources>
- <!-- A -->
<resource>
<directory>${basedir}/src/test</directory>
<includes>
- <include>*.xml</include>
- <include>*.properties</include>
+ <include>**/*.xml</include>
+ <include>**/*.properties</include>
</includes>
</resource>
</resources>
@@ -1131,6 +1134,38 @@
</build>
</project>
]]></source>
+
+ <p>
+ The following example demonstrates how to recursively include all files
with an 'xml'
+ or 'properties' extension within the ${basedir}/src/test directory and
exclude the
+ naughty.properties file. Note the addition of the
project/build/unitTest/resources/excludes
+ element:
+ </p>
+
+<source><![CDATA[
+ <project>
+ ...
+ <build>
+ ...
+ <unitTest>
+ ...
+ <resources>
+ <resource>
+ <directory>${basedir}/src/test</directory>
+ <includes>
+ <include>**/*.xml</include>
+ <include>**/*.properties</include>
+ </includes>
+ <excludes>
+ <exclude>naughty.properties</exclude>
+ </excludes>
+ </resource>
+ </resources>
+ </unitTest>
+ </build>
+ </project>
+]]></source>
+
</subsection>
<subsection name="Running a Single Test">
1.18.4.1 +75 -6 maven/xdocs/reference/project-descriptor.xml
Index: project-descriptor.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/project-descriptor.xml,v
retrieving revision 1.18
retrieving revision 1.18.4.1
diff -u -r1.18 -r1.18.4.1
--- project-descriptor.xml 21 Jul 2003 05:50:51 -0000 1.18
+++ project-descriptor.xml 7 Aug 2003 16:52:38 -0000 1.18.4.1
@@ -1,11 +1,9 @@
<?xml version="1.0"?>
<document>
-<!--
- | FIXME: This file is missing details on the
build/sourceModifications/sourceModification element
- |-->
<properties>
<author email="[EMAIL PROTECTED]">Pete Kazmier</author>
+ <author email="[EMAIL PROTECTED]">don Gillard</author>
<title>Maven Project Descriptors</title>
</properties>
@@ -332,6 +330,20 @@
<source><pre>scm:cvs:lserver:[EMAIL
PROTECTED]:/cvs/root:module-name</pre></source>
</p>
<p>
+ For ssh access:
+ <source><pre>scm:cvs:ext:[EMAIL
PROTECTED]:/cvs/root:module-name</pre></source>
+ Remember that CVS will expect an environment variable called
+ <code>CVS_RSH</code> to be set, typically to <code>ssh</code> or your
+ ssh client.
+ </p>
+ <p>
+ Some cvs clients support other protocols, such as ntserver and extssh.
+ Here's an example using CVS NT and ntserver:
+ <source>scm|cvs|ntserver|[EMAIL PROTECTED]|e:\cvs|Deployment</source>
+ Note the use of the vertical bar as delimiter as the repository has a
+ colon (<code>:</code>) in it.
+ </p>
+ <p>
For local file system repositories
<source><pre>scm:cvs:local:ignored:/cvs/root:module-name</pre></source>
</p>
@@ -663,7 +675,7 @@
</td>
</tr>
<tr>
- <td>sourceDirectory</td>
+ <td><a name="sourceDirectory">sourceDirectory</a></td>
<td>
This element specifies a directory containing the source
of the project. The generated build system will compile
@@ -671,6 +683,13 @@
</td>
</tr>
<tr>
+ <td><a href="#sourceModifications">sourceModifications</a></td>
+ <td>
+ This element specifies how source code will be excluded or included
+ depending on the presence of a given class.
+ </td>
+ </tr>
+ <tr>
<td>aspectSourceDirectory</td>
<td>
This element specifies a directory containing Aspect
@@ -689,6 +708,41 @@
<td>Describe the resources associated with the project</td>
</tr>
</table>
+ <subsection name="sourceModifications">
+ <p>
+ This element describes all of the sourceModifications associated with a
+ project. Each source modification is described by a
+ <code>sourceModification</code> element, which is then described by
+ additional elements (described below). These modifications are used
+ to exclude or include various source depending on the environment
+ the build is running in.
+ </p>
+
+ <p>sourceModification elements</p>
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td>className</td>
+ <td>
+ If the class with this name can <strong>not</strong> be
+ loaded, then the includes and excludes specified below
+ will be applied to the contents of the
+ <a href="#sourceDirectory">sourceDirectory</a>
+ </td>
+ </tr>
+ <tr>
+ <td><a href="#includes">includes</a></td>
+ <td>Describe the files to be included if the class was not found</td>
+ </tr>
+ <tr>
+ <td><a href="#excludes">excludes</a></td>
+ <td>Describe the files to be excluded if the class was not found</td>
+ </tr>
+ </table>
+ <p>
+ <strong>Note</strong>: not all plugins support the sourceModifications
element.
+ </p>
+ </subsection>
<subsection name="unitTest">
<table>
<tr><th>Element</th><th>Description</th></tr>
@@ -713,6 +767,13 @@
elements (described <a href="#resource">below</a>). These resources are
used to
complete the jar file or to run unit test.
</p>
+ <table>
+ <tr><th>Element</th><th>Description</th></tr>
+ <tr>
+ <td><a href="#resource">resource</a></td>
+ <td>Each resource must be defined in a <tt>resource</tt> element.</td>
+ </tr>
+ </table>
</subsection>
<subsection name="resource">
<table>
@@ -748,7 +809,11 @@
<tr><th>Element</th><th>Description</th></tr>
<tr>
<td>include</td>
- <td>This element specify an Ant pattern.</td>
+ <td>
+ This element specifies an
+ <a href="http://ant.apache.org/manual/CoreTypes/patternset.html";>Ant
pattern</a>
+ of files to include in a list.
+ </td>
</tr>
</table>
</subsection>
@@ -757,7 +822,11 @@
<tr><th>Element</th><th>Description</th></tr>
<tr>
<td>exclude</td>
- <td>This element specify an Ant pattern.</td>
+ <td>
+ This element specifies an
+ <a href="http://ant.apache.org/manual/CoreTypes/patternset.html";>Ant
pattern</a>
+ of files to exclude from a list.
+ </td>
</tr>
</table>
</subsection>
No revision
No revision
1.24.4.1 +2 -1 maven/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/navigation.xml,v
retrieving revision 1.24
retrieving revision 1.24.4.1
diff -u -r1.24 -r1.24.4.1
--- navigation.xml 17 Jul 2003 01:22:31 -0000 1.24
+++ navigation.xml 7 Aug 2003 16:52:38 -0000 1.24.4.1
@@ -39,10 +39,11 @@
<item name="Maven Speed" href="/ant-guide/qna/speed.html"/>
<item name="Dependencies" href="/ant-guide/qna/inprogress.html"/>
<item name="Ant Targets" href="/ant-guide/qna/inprogress.html"/>
- <item name="Properties" href="/ant-guide/qna/inprogress.html"/>
+ <item name="Properties" href="/ant-guide/qna/properties.html"/>
</item>
</item>
<item name="Maven Wiki" href="http://wiki.codehaus.org/maven/"/>
+ <item name="Chinese site" href="http://maven.huangdong.com"/>
</item>
<item name="Misc" href="/misc/index.html" collapse="true">
<item name="Articles" href="/misc/articles.html"/>
1.2.2.1 +7 -0 maven/xdocs/faq.fml
Index: faq.fml
===================================================================
RCS file: /home/cvs/maven/xdocs/faq.fml,v
retrieving revision 1.2
retrieving revision 1.2.2.1
diff -u -r1.2 -r1.2.2.1
--- faq.fml 17 Jul 2003 06:50:42 -0000 1.2
+++ faq.fml 7 Aug 2003 16:52:38 -0000 1.2.2.1
@@ -159,6 +159,13 @@
</answer>
</faq>
+ <faq id="ibiblio-upload">
+ <question>How do I upload a resource to or update a resource on
http://www.ibiblio.org/maven?</question>
+ <answer>
+ Read <a href="repository-upload.html">Uploading to Ibiblio Instructions</a>.
+ </answer>
+ </faq>
+
<faq id="ignoring-broken-tests">
<question>How do I make my build complete even with broken tests?</question>
<answer>
No revision
No revision
1.20.4.1 +6 -0 maven/xdocs/start/integrate.xml
Index: integrate.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/start/integrate.xml,v
retrieving revision 1.20
retrieving revision 1.20.4.1
diff -u -r1.20 -r1.20.4.1
--- integrate.xml 27 Jul 2003 14:31:41 -0000 1.20
+++ integrate.xml 7 Aug 2003 16:52:38 -0000 1.20.4.1
@@ -219,8 +219,14 @@
<!-- Resources that are packaged up inside the JAR file -->
<resources>
<resource>
+ <directory>${basedir}/src/resources/misc</directory>
<includes>
<include>*.xsd</include>
+ </includes>
+ </resource>
+ <resource>
+ <directory>${basedir}/src/resources/logging</directory>
+ <includes>
<include>log4j.properties</include>
</includes>
</resource>
No revision
No revision
1.1.2.1 +0 -0 maven/xdocs/ant-guide/qna/properties.xml
Index: properties.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/ant-guide/qna/properties.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
No revision
No revision
1.1.1.1.4.1 +29 -29 maven/xdocs/ant-guide/practical.xml
Index: practical.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/ant-guide/practical.xml,v
retrieving revision 1.1.1.1
retrieving revision 1.1.1.1.4.1
diff -u -r1.1.1.1 -r1.1.1.1.4.1
--- practical.xml 5 Oct 2002 13:22:56 -0000 1.1.1.1
+++ practical.xml 7 Aug 2003 16:52:38 -0000 1.1.1.1.4.1
@@ -1,29 +1,29 @@
-<?xml version="1.0"?>
-
-<document>
-
- <properties>
- <title>Maven</title>
- <author email="[EMAIL PROTECTED]">Ben Walding</author>
- </properties>
-
- <body>
-
- <section name="Practical">
- <p>
- A common question that comes up is how to do certain things in Maven that
- are quite trivial in Ant. These answers represent the best-of-breed
solutions to problems,
- and if you have a better solution, let the maintainer know.
- </p>
-
- <p>
- <ul>
- <li><a href="qna/speed.html">Ant is sooo much faster than this sluggish
Maven</a></li>
- <li><a href="qna/inprogress.html">Using dependencies to make extra things
happen before / after a goal</a></li>
- <li><a href="qna/inprogress.html">Using Ant build targets while you're
converting over to Maven</a></li>
- <li><a href="qna/inprogress.html">Expanding properties in a file</a></li>
- </ul>
- </p>
- </section>
- </body>
-</document>
+<?xml version="1.0"?>
+
+<document>
+
+ <properties>
+ <title>Maven</title>
+ <author email="[EMAIL PROTECTED]">Ben Walding</author>
+ </properties>
+
+ <body>
+
+ <section name="Practical">
+ <p>
+ A common question that comes up is how to do certain things in Maven that
+ are quite trivial in Ant. These answers represent the best-of-breed
solutions to problems,
+ and if you have a better solution, let the maintainer know.
+ </p>
+
+ <p>
+ <ul>
+ <li><a href="qna/speed.html">Ant is sooo much faster than this sluggish
Maven</a></li>
+ <li><a href="qna/inprogress.html">Using dependencies to make extra things
happen before / after a goal</a></li>
+ <li><a href="qna/inprogress.html">Using Ant build targets while you're
converting over to Maven</a></li>
+ <li><a href="qna/properties.html">Expanding properties in a file</a></li>
+ </ul>
+ </p>
+ </section>
+ </body>
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
