epugh 2004/07/24 10:03:48
Modified: xdocs/reference user-guide.xml
xdocs/reference/developers releasing-plugins.xml
xdocs/ant-guide/qna speed.xml hooks.xml help.xml
antfarming.xml
xdocs navigation.xml navigation-pdf.xml
Log:
MAVEN-1386 Remainder of doc fixes by Dennis Lundberg
Revision Changes Path
1.71 +5 -4 maven/xdocs/reference/user-guide.xml
Index: user-guide.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/user-guide.xml,v
retrieving revision 1.70
retrieving revision 1.71
diff -u -r1.70 -r1.71
--- user-guide.xml 23 Jul 2004 04:52:09 -0000 1.70
+++ user-guide.xml 24 Jul 2004 17:03:48 -0000 1.71
@@ -168,9 +168,9 @@
<project>
<pomVersion>3</pomVersion>
- <groupId>maven</groupId>
<artifactId>maven</artifactId>
<name>Maven</name>
+ <groupId>maven</groupId>
<currentVersion>1.0-b5-dev</currentVersion>
<organization>
<name>Apache Software Foundation</name>
@@ -201,9 +201,9 @@
<project>
<extend>parent-project.xml</extend>
- <groupId>super-extendo</groupId>
<artifactId>super-extendo</artifactId>
<name>Super Extendo</name>
+ <groupId>super-extendo</groupId>
<build>
<unitTest>
@@ -234,9 +234,9 @@
<source><![CDATA[
<project>
<pomVersion>3</pomVersion>
- <groupId>commons</groupId>
<artifactId>commons-master</artifactId>
<name>Commons Master Maven POM</name>
+ <groupId>commons</groupId>
<organization>
<name>Apache Software Foundation</name>
@@ -269,9 +269,10 @@
<source><![CDATA[
<project>
- <groupId>commons-betwixt</groupId>
+ <extend>master-project.xml</extend>
<artifactId>commons-betwixt</artifactId>
<name>Betwixt</name>
+ <groupId>commons-betwixt</groupId>
...
</project>
]]></source>
1.9 +2 -3 maven/xdocs/reference/developers/releasing-plugins.xml
Index: releasing-plugins.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/reference/developers/releasing-plugins.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- releasing-plugins.xml 23 Jul 2004 04:40:08 -0000 1.8
+++ releasing-plugins.xml 24 Jul 2004 17:03:48 -0000 1.9
@@ -74,7 +74,7 @@
</li>
<li>
<p>
- Go the <a
href="http://jira.codehaus.org/secure/project/ViewProjects.jspa">JIRA administration
page</a>
+ Go to the <a
href="http://jira.codehaus.org/secure/project/ViewProjects.jspa">JIRA administration
page</a>
for the Maven plugin you have just released (Note that you need to be a
JIRA administrator for this project) and
<strong>release</strong> the version. Also make sure to
<strong>add</strong> a new version for the following
development version. This is required so that issue creators/plugin
developers can assign a "fix for" version
@@ -107,7 +107,6 @@
These versions can go beyond 10: eg <code>1.13</code>.
A third version increment is optional and signifies minor updates. These
may also be deployed as
snapshots or users may just be asked to build out of CVS to acquire these
fixes.
- eg. <code>1.0.1</code> - use less whitespace in output HTML.
</p>
</li>
<li>
@@ -119,7 +118,7 @@
</p>
</li>
<li>
- <p> Q: Why would I want to given all the pain it will take?</p>
+ <p> Q: Why would I want to, given all the pain it will take?</p>
<p> A: Several possible answers... :-) Pick yours: </p>
<ol>
<li><p> Because, making a release is honorific and you'll be thanked for
it! </p></li>
1.4 +1 -1 maven/xdocs/ant-guide/qna/speed.xml
Index: speed.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/ant-guide/qna/speed.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- speed.xml 23 Jul 2004 04:40:07 -0000 1.3
+++ speed.xml 24 Jul 2004 17:03:48 -0000 1.4
@@ -44,7 +44,7 @@
<p>
Part of the misconception comes from claims that building the site or
building 30 projects
takes a lot of CPU and memory. Well, this would happen in Ant too if it
were attempted!
- This area is also a focus for future development so generating these
types of parts of the build
+ This area is also a focus for future development so that generating these
parts of the build
are much faster.
</p>
</subsection>
1.3 +4 -2 maven/xdocs/ant-guide/qna/hooks.xml
Index: hooks.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/ant-guide/qna/hooks.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- hooks.xml 23 Jul 2004 04:40:07 -0000 1.2
+++ hooks.xml 24 Jul 2004 17:03:48 -0000 1.3
@@ -41,7 +41,8 @@
So, here is a sample <code>maven.xml</code> file that demonstrates how this
would be achieved:
</p>
<source><![CDATA[<project xmlns:ant="jelly:ant">
- <!-- The java:jar-resources goal copies resources into target/classes so that
they are included in the JAR at / -->
+ <!-- The java:jar-resources goal copies resources into target/classes -->
+ <!-- so that they are included in the JAR at / -->
<postGoal name="java:jar-resources">
<attainGoal name="generate-dynamic-resources" />
<!-- maven.build.dest is the location where resources are put -->
@@ -52,7 +53,8 @@
<!-- Here is the goal you've defined to generate the resources in some fashion -->
<goal name="generate-dynamic-resources">
- <!-- Place them into ${maven.build.dir}/generated-resources according to the
fragment above -->
+ <!-- Place them into ${maven.build.dir}/generated-resources according to -->
+ <!-- the fragment above -->
...
</goal>
</project>]]></source>
1.3 +5 -5 maven/xdocs/ant-guide/qna/help.xml
Index: help.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/ant-guide/qna/help.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- help.xml 23 Jul 2004 04:40:07 -0000 1.2
+++ help.xml 24 Jul 2004 17:03:48 -0000 1.3
@@ -34,17 +34,17 @@
<subsection name="Help in Ant">
<p>
If you were using Ant, you'd probably run <code>ant -projecthelp</code>,
and if that didn't help,
- just run "ant" and hope the defualt goal is what you wanted.
+ just run "ant" and hope the default target is what you wanted.
A build.properties.sample file may have been provided so you'd copy that
and edit it to see if that
helped. Then you'd fix individual problems as they came up.
- If everything goes wrong and you can't find the right goal or what
property it's expecting, you dig into
+ If everything goes wrong and you can't find the right target or what
property it's expecting, you dig into
build.xml and look at what it is attempting.
</p>
<p>
The process for Maven should be simpler unless the project is being
really unhelpful.
</p>
</subsection>
- <subsection name="Help for a simple Maven project - no maven.xml">
+ <subsection name="Help for a simple Maven project without a maven.xml file">
<p>
If there is no <code>maven.xml</code> file, then you know the build
hasn't been customised so you can rely on
a few things working.
@@ -57,11 +57,11 @@
</p>
<p>
You shouldn't expect to have to define any properties outside what the
project has provided and you have
- already defined to get Maven running, as only the standard Mavne plugin
properties are being used, and you
+ already defined to get Maven running, as only the standard Maven plugin
properties are being used, and you
know how they behave.
</p>
</subsection>
- <subsection name="Help for a Maven project with maven.xml">
+ <subsection name="Help for a Maven project with a maven.xml file">
<p>
If there is a <code>maven.xml</code> file, then the build has been
customised. You can still rely on the
above goals doing what they advertise, but they might not be the
recommended way of building that
1.3 +2 -2 maven/xdocs/ant-guide/qna/antfarming.xml
Index: antfarming.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/ant-guide/qna/antfarming.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- antfarming.xml 23 Jul 2004 04:40:07 -0000 1.2
+++ antfarming.xml 24 Jul 2004 17:03:48 -0000 1.3
@@ -33,7 +33,7 @@
</p>
<p>
To do anything with Maven, you will still need to set up a
- <a href="/reference/project-descriptor.html">project.xml</a> file with the
information you need to do
+ <a href="../../reference/project-descriptor.html">project.xml</a> file with
the information you need to do
the Maven tasks you are using.
</p>
<p>
@@ -58,7 +58,7 @@
<source><![CDATA[
<project xmlns:ant="jelly:ant">
<preGoal name="site">
- <!-- Set the property html.dir that your Ant build expected to be able to put
the HTML into -->
+ <!-- Set the property html.dir that your Ant build uses to put the HTML into -->
<ant:property name="html.dir" value="${maven.docs.dest}" />
<ant:ant dir="${basedir}" antfile="build.xml" target="generate-html" />
</preGoal>
1.45 +1 -2 maven/xdocs/navigation.xml
Index: navigation.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/navigation.xml,v
retrieving revision 1.44
retrieving revision 1.45
diff -u -r1.44 -r1.45
--- navigation.xml 23 Jul 2004 04:52:09 -0000 1.44
+++ navigation.xml 24 Jul 2004 17:03:48 -0000 1.45
@@ -63,7 +63,7 @@
<item name="Best Product for Job" href="/ant-guide/where.html"/>
<item name="Practical" href="/ant-guide/practical.html"
collapse="false">
<item name="Maven Speed" href="/ant-guide/qna/speed.html"/>
- <item name="Dependencies" href="/ant-guide/qna/hooks.html"/>
+ <item name="Hooks" href="/ant-guide/qna/hooks.html"/>
<item name="Ant Targets" href="/ant-guide/qna/antfarming.html"/>
<item name="Project Help" href="/ant-guide/qna/help.html"/>
<item name="Properties" href="/ant-guide/qna/properties.html"/>
@@ -84,7 +84,6 @@
<item name="Articles" href="/misc/articles.html"/>
<item name="Glossary" href="/misc/glossary.html"/>
<item name="Powered By" href="/misc/powered.html"/>
- <item name="Tasks" href="/misc/tasks.html"/>
</item>
<item name="Apache" href="/apache/index.html" collapse="true">
<item name="Committer FAQ"
href="http://www.apache.org/dev/committers.html"/>
1.9 +1 -1 maven/xdocs/navigation-pdf.xml
Index: navigation-pdf.xml
===================================================================
RCS file: /home/cvs/maven/xdocs/navigation-pdf.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- navigation-pdf.xml 23 Jul 2004 04:52:09 -0000 1.8
+++ navigation-pdf.xml 24 Jul 2004 17:03:48 -0000 1.9
@@ -51,7 +51,7 @@
<item name="Best Product for Job" href="/ant-guide/where.html"/>
<item name="Practical" href="/ant-guide/practical.html">
<item name="Maven Speed" href="/ant-guide/qna/speed.html"/>
- <item name="Dependencies" href="/ant-guide/qna/hooks.html"/>
+ <item name="Hooks" href="/ant-guide/qna/hooks.html"/>
<item name="Ant Targets" href="/ant-guide/qna/antfarming.html"/>
<item name="Project Help" href="/ant-guide/qna/help.html"/>
<item name="Properties" href="/ant-guide/qna/properties.html"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]