2d745d89dc
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@354629 13f79535-47bb-0310-9956-ffa450edef68
204 lines
6.3 KiB
XML
204 lines
6.3 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
/*
|
|
* Copyright 2001-2005 The Apache Software Foundation.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
-->
|
|
|
|
<document>
|
|
|
|
<properties>
|
|
<title>Validation</title>
|
|
</properties>
|
|
|
|
<body>
|
|
<section name="Validating your POM">
|
|
<p>
|
|
The <code>pom:validate</code> goal performs a validation of your
|
|
project descriptor (<code>project.xml</code>, pom) against an xsd
|
|
schema. The general form of a project descriptor can be found
|
|
on the main Maven
|
|
<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>
|
|
<subsection name="Namespace">
|
|
<p>
|
|
In order to be valid, your <code>project.xml</code> file needs
|
|
to include a namespace declaration in the project root element:
|
|
</p>
|
|
<source><![CDATA[<project xmlns="http://maven.apache.org/POM/3.0.0">]]></source>
|
|
<p>
|
|
or
|
|
</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 name="Required elements">
|
|
<p>
|
|
The validation routine works differently for stand-alone
|
|
poms and poms that extend other ones (child poms).
|
|
The following table shows which
|
|
top-level elements (<em>i.e.</em>, elements just below the
|
|
<code><project></code> root) are required in each case.
|
|
</p>
|
|
<table>
|
|
<tr>
|
|
<th>Element name</th>
|
|
<th>Required in stand-alone pom?</th>
|
|
<th>Required in child pom?</th>
|
|
</tr>
|
|
<tr>
|
|
<td><code><extend/></code></td>
|
|
<td>N/A</td><td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><pomVersion/></code></td>
|
|
<td>Yes</td><td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><id/></code></td>
|
|
<td>Yes</td><td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><groupId/></code></td>
|
|
<td>Yes</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><artifactId/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><name/></code></td>
|
|
<td>Yes</td><td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><currentVersion/></code></td>
|
|
<td>Yes</td><td>Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><description/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><shortDescription/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><url/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><logo/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><issueTrackingUrl/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><inceptionYear/></code></td>
|
|
<td>Yes</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><gumpRepositoryId/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><siteAddress/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><siteDirectory/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><distributionSite/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><distributionDirectory/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><mailingLists></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><developers></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><contributors></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><licenses></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><versions></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><branches></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><packageGroups></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><reports></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><repository></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><organization></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><properties></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><package/></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><build></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code><dependencies></code></td>
|
|
<td>No</td><td>No</td>
|
|
</tr>
|
|
</table>
|
|
</subsection>
|
|
</section>
|
|
</body>
|
|
</document>
|