Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@350059 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl 2005-11-30 21:51:28 +00:00
parent 9d395e5e29
commit f796377f4d
2 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
pom/xdocs/index.xml
View File

@ -30,17 +30,6 @@
This plug-in provides some basic validation and updating mechanisms This plug-in provides some basic validation and updating mechanisms
for your POM. for your POM.
</p> </p>
<p>
<strong>WARNING</strong>: for the <code>pom:validate</code> goal
to work, your project descriptor (<code>project.xml</code>) has
to be at least parsable and well-formed in the first place
(chicken or egg?). If your pom is not well-formed, Maven
will fail with a (hopefully useful) error message before any
plugin starts to work. If you are having problems getting Maven
to run, you should try to validate your pom with an independent
validation tool first.
See <a href="validation.html">Validation</a> for more details.
</p>
</section> </section>
</body> </body>
</document> </document>

20
pom/xdocs/validation.xml
View File

@ -30,7 +30,17 @@
project descriptor (<code>project.xml</code>, pom) against an xsd project descriptor (<code>project.xml</code>, pom) against an xsd
schema. The general form of a project descriptor can be found schema. The general form of a project descriptor can be found
on the main Maven on the main Maven
<a href="http://maven.apache.org/reference/project-descriptor.html">site</a>. <a href="http://maven.apache.org/maven-1.x/reference/project-descriptor.html">site</a>.
</p>
<p>
<strong>WARNING</strong>: for the <code>pom:validate</code> goal
to work, your project descriptor (<code>project.xml</code>) has
to be at least parsable and well-formed in the first place
(chicken or egg?). If your pom is not well-formed, Maven
will fail with a (hopefully useful) error message before any
plugin starts to work. If you are having problems getting Maven
to run, you should try to validate your pom with an independent
xml validation tool first.
</p> </p>
<subsection name="Required elements"> <subsection name="Required elements">
<p> <p>
@ -178,13 +188,15 @@
</subsection> </subsection>
<subsection name="Namespace"> <subsection name="Namespace">
<p> <p>
It is recommended that you include a namespace declaration in your In order to be valid, your <code>project.xml</code> file needs
project root: to include a namespace declaration in the project root element:
</p> </p>
<source><![CDATA[<project xmlns="http://maven.apache.org/POM/3.0.0">]]></source> <source><![CDATA[<project xmlns="http://maven.apache.org/POM/3.0.0">]]></source>
<p> <p>
but this is currently not enforced by the validation routine. or
</p> </p>
<source><![CDATA[<project xmlns="http://maven.apache.org/POM/3.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/3.0.0 http://maven.apache.org/maven-v3_0_0.xsd">]]></source>
</subsection> </subsection>
</section> </section>
</body> </body>