From 79d8017b7421cd78251c53ece3f1d5e48cfb3c45 Mon Sep 17 00:00:00 2001 From: ltheussl Date: Tue, 18 Oct 2005 22:38:17 +0000 Subject: [PATCH] Documentation updates git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@326283 13f79535-47bb-0310-9956-ffa450edef68 --- pom/xdocs/goals.xml | 7 +- pom/xdocs/index.xml | 9 +- pom/xdocs/navigation.xml | 1 + pom/xdocs/properties.xml | 2 +- pom/xdocs/validation.xml | 191 +++++++++++++++++++++++++++++++++++++++ 5 files changed, 204 insertions(+), 6 deletions(-) create mode 100644 pom/xdocs/validation.xml diff --git a/pom/xdocs/goals.xml b/pom/xdocs/goals.xml index 0198a252..e76342af 100644 --- a/pom/xdocs/goals.xml +++ b/pom/xdocs/goals.xml @@ -27,7 +27,7 @@ pom - Validate the Maven XML project descriptor + Just calls pom:validate. pom:contentvalidate @@ -38,7 +38,10 @@ pom:validate - Validate the Maven XML project descriptor + + Validate the Maven XML project descriptor. + See Validation. + diff --git a/pom/xdocs/index.xml b/pom/xdocs/index.xml index eaee8f7c..0cc0a7a5 100644 --- a/pom/xdocs/index.xml +++ b/pom/xdocs/index.xml @@ -33,10 +33,13 @@

WARNING: for the pom:validate goal to work, your project descriptor (project.xml) 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 SAXParseException (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 Validation for more details.

diff --git a/pom/xdocs/navigation.xml b/pom/xdocs/navigation.xml index e1fa4812..5cee25ef 100644 --- a/pom/xdocs/navigation.xml +++ b/pom/xdocs/navigation.xml @@ -27,6 +27,7 @@ + diff --git a/pom/xdocs/properties.xml b/pom/xdocs/properties.xml index 2d7fc109..baf25f41 100644 --- a/pom/xdocs/properties.xml +++ b/pom/xdocs/properties.xml @@ -23,7 +23,7 @@
-

There are no settings to customize this plugin

+

There are no settings to customize this plugin.

diff --git a/pom/xdocs/validation.xml b/pom/xdocs/validation.xml new file mode 100644 index 00000000..5c7eafa3 --- /dev/null +++ b/pom/xdocs/validation.xml @@ -0,0 +1,191 @@ + + + + + + + Validation + + + +
+

+ The pom:validate goal performs a validation of your + project descriptor (project.xml, pom) against an xsd + schema. The general form of a project descriptor can be found + on the main Maven + site. +

+ +

+ 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 (i.e., elements just below the + <project> root) are required in each case. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Element nameRequired in stand-alone pom?Required in child pom?
<extend/>N/AYes
<pomVersion/>YesYes
<id/>YesYes
<groupId/>YesNo
<artifactId/>NoNo
<name/>YesYes
<currentVersion/>YesYes
<description/>NoNo
<shortDescription/>NoNo
<url/>NoNo
<logo/>NoNo
<issueTrackingUrl/>NoNo
<inceptionYear/>YesNo
<gumpRepositoryId/>NoNo
<siteAddress/>NoNo
<siteDirectory/>NoNo
<distributionSite/>NoNo
<distributionDirectory/>NoNo
<mailingLists>NoNo
<developers>NoNo
<contributors>NoNo
<licenses>NoNo
<versions>NoNo
<branches>NoNo
<packageGroups>NoNo
<reports>NoNo
<repository>NoNo
<organization>NoNo
<properties>NoNo
<package/>NoNo
<build>NoNo
<dependencies>NoNo
+ + +

+ It is recommended that you include a namespace declaration in your + project root: +

+ ]]> +

+ but this is currently not enforced by the validation routine. +

+ +
+ +