Documentation updates
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@326283 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl committed
1 parent
28e297eae9
commit
79d8017b74
5 files changed
+204
-6
No files matched your search
+5
-2
@@ -27,7 +27,7 @@
|
||||
<goals>
|
||||
<goal>
|
||||
<name>pom</name>
|
||||
<description>Validate the Maven XML project descriptor</description>
|
||||
<description>Just calls <code>pom:validate</code>.</description>
|
||||
</goal>
|
||||
<goal>
|
||||
<name>pom:contentvalidate</name>
|
||||
@@ -38,7 +38,10 @@
|
||||
</goal>
|
||||
<goal>
|
||||
<name>pom:validate</name>
|
||||
<description>Validate the Maven XML project descriptor</description>
|
||||
<description>
|
||||
Validate the Maven XML project descriptor.
|
||||
See <a href="validation.html">Validation</a>.
|
||||
</description>
|
||||
</goal>
|
||||
</goals>
|
||||
</body>
|
||||
|
||||
+6
-3
@@ -33,10 +33,13 @@
|
||||
<p>
|
||||
<strong>WARNING</strong>: for the <code>pom:validate</code> goal
|
||||
to work, your project descriptor (<code>project.xml</code>) has
|
||||
to be at leat parsable and well-formed in the first place
|
||||
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 <code>SAXParseException</code> (and hopefully
|
||||
a useful error message) before any plugin starts to work.
|
||||
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>
|
||||
</body>
|
||||
|
||||
@@ -27,6 +27,7 @@
|
||||
<menu name="Overview">
|
||||
<item href="/goals.html" name="Goals"/>
|
||||
<item href="/properties.html" name="Properties"/>
|
||||
<item href="/validation.html" name="Validation"/>
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
@@ -23,7 +23,7 @@
|
||||
</properties>
|
||||
<body>
|
||||
<section name="Maven POM Plugin Settings">
|
||||
<p>There are no settings to customize this plugin</p>
|
||||
<p>There are no settings to customize this plugin.</p>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
@@ -0,0 +1,191 @@
|
||||
<?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/reference/project-descriptor.html">site</a>.
|
||||
</p>
|
||||
<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 (<emph>i.e.</emph>, 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>
|
||||
<subsection name="Namespace">
|
||||
<p>
|
||||
It is recommended that you include a namespace declaration in your
|
||||
project root:
|
||||
</p>
|
||||
<source><![CDATA[<project xmlns="http://maven.apache.org/POM/3.0.0">]]></source>
|
||||
<p>
|
||||
but this is currently not enforced by the validation routine.
|
||||
</p>
|
||||
</subsection>
|
||||
</section>
|
||||
</body>
|
||||
</document>
|
||||
Reference in new issue
Block a user