svn commit: r370889 - /maven/components/trunk/maven-model/maven.mdo

[ca...@apache.org]

Author: carlos
Date: Fri Jan 20 11:25:38 2006
New Revision: 370889

URL: http://svn.apache.org/viewcvs?rev=370889&view=rev
Log:
Improve pom annotations
PR: MNG-1479
Submitted By: Jeff Jensen

Modified:
    maven/components/trunk/maven-model/maven.mdo

Modified: maven/components/trunk/maven-model/maven.mdo
URL: http://svn.apache.org/viewcvs/maven/components/trunk/maven-model/maven.mdo?rev=370889&r1=370888&r2=370889&view=diff
==============================================================================
--- maven/components/trunk/maven-model/maven.mdo (original)
+++ maven/components/trunk/maven-model/maven.mdo Fri Jan 20 11:25:38 2006
@@ -132,7 +132,21 @@
         <field>
           <name>packaging</name>
           <version>4.0.0</version>
-          <description><![CDATA[The type of artifact this project produces.]]></description>
+          <description><![CDATA[
+            The type of artifact this project produces.
+            The main types are:
+            <ul>
+              <li>jar</li>
+              <li>war</li>
+              <li>ear</li>
+              <li>pom</li>
+            </ul>
+            <p>
+            However, plugins can create their own packaging, and
+            therefore their own packaging types,
+            so this list can not contain all possible types.
+            </p>
+          ]]></description>
           <type>String</type>
           <defaultValue>jar</defaultValue>
         </field>
@@ -1297,7 +1311,7 @@
           <name>scope</name>
           <version>4.0.0</version>
           <description><![CDATA[
-            The scope of the dependency - compile, runtime, test. Used to
+            The scope of the dependency - compile, runtime, test, system. Used to
             calculate the various classpaths used for testing, etc. and for 
             determining which artifacts to include in a distribution of this
             project. For more information, see 
@@ -1313,8 +1327,13 @@
         <field>
           <name>systemPath</name>
           <version>4.0.0</version>
-          <description>FOR SYSTEM SCOPE ONLY. This specifies the path on the filesystem for this
-            dependency.</description>
+          <description>
+            FOR SYSTEM SCOPE ONLY.
+            This specifies the path on the filesystem for this dependency.
+            Requires an absolute path for the value, not relative.
+            Use a property that gives the machine specific absolute path,
+            e.g. ${java.home}.
+          </description>
           <type>String</type>
         </field>
         <field>
@@ -1811,7 +1830,24 @@
         <field>
           <name>relativePath</name>
           <version>4.0.0</version>
-          <description><![CDATA[The relative path of the parent-pom within the project hierarchy]]></description>
+          <description><![CDATA[
+            The relative path of the parent-pom within the project hierarchy.
+            The default value is ../pom.xml.
+            <p>
+            Normally, Maven looks for the parent pom first in the default location,
+            then the local repository, and lastly in the remote repo.
+            </p>
+            <p>
+            relativePath allows you to select a different location,
+            for example when your structure is flat, or deeper without an intermediate parent pom.
+            </p>
+            <p>
+            However, the group and artifact ID is still required,
+            as when the parent is coming from the repository,
+            it must look for the parent in the repository, and so on.
+            This feature is only for enhancing the development in a local checkout of that project.
+            </p>
+          ]]></description>
           <type>String</type>
           <defaultValue>../pom.xml</defaultValue>
         </field>