[MNG-5076] improved documentation of lifecycle.xml
Submitted by: Benson Margulies
applied with modifications

git-svn-id: 
https://svn.apache.org/repos/asf/maven/maven-2/branches/maven-2.2.x@1096335 
13f79535-47bb-0310-9956-ffa450edef68


Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/8643b0de
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/8643b0de
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/8643b0de

Branch: refs/heads/maven-2.2.x
Commit: 8643b0de17112c1a58475f59ca1bda2c11acf933
Parents: 268caef
Author: Herve Boutemy <hbout...@apache.org>
Authored: Sun Apr 24 15:53:08 2011 +0000
Committer: Herve Boutemy <hbout...@apache.org>
Committed: Sun Apr 24 15:53:08 2011 +0000

----------------------------------------------------------------------
 maven-plugin-descriptor/src/main/mdo/lifecycle.mdo |    5 ++-
 maven-plugin-descriptor/src/site/site.xml          |   28 ++++++++++++++-
 2 files changed, 30 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/maven/blob/8643b0de/maven-plugin-descriptor/src/main/mdo/lifecycle.mdo
----------------------------------------------------------------------
diff --git a/maven-plugin-descriptor/src/main/mdo/lifecycle.mdo 
b/maven-plugin-descriptor/src/main/mdo/lifecycle.mdo
index 2d8f2da..2335d15 100644
--- a/maven-plugin-descriptor/src/main/mdo/lifecycle.mdo
+++ b/maven-plugin-descriptor/src/main/mdo/lifecycle.mdo
@@ -24,7 +24,8 @@ under the License.
   <id>lifecycle-mappings</id>
   <name>LifecycleMappings</name>
   <description><![CDATA[
-    Configuration of custom lifecycle mappings for the plugin.
+    Configuration of custom lifecycle mappings for the plugin, as generally 
stored in
+    <code>META-INF/maven/lifecycle.xml</code> in a plugin's jar artifact.
   ]]></description>
   <defaults>
     <default>
@@ -36,7 +37,7 @@ under the License.
     <class rootElement="true" xml.tagName="lifecycles" 
xsd.compositor="sequence">
       <name>LifecycleConfiguration</name>
       <version>1.0.0</version>
-      <description>Root element of the lifecycle.xml file.</description>
+      <description><![CDATA[Root element of the <code>lifecycle.xml</code> 
file.]]></description>
       <fields>
         <field>
           <name>lifecycles</name>

http://git-wip-us.apache.org/repos/asf/maven/blob/8643b0de/maven-plugin-descriptor/src/site/site.xml
----------------------------------------------------------------------
diff --git a/maven-plugin-descriptor/src/site/site.xml 
b/maven-plugin-descriptor/src/site/site.xml
index 15f431a..85de241 100644
--- a/maven-plugin-descriptor/src/site/site.xml
+++ b/maven-plugin-descriptor/src/site/site.xml
@@ -1,5 +1,31 @@
-<project>
+<?xml version="1.0" encoding="UTF-8"?>
+
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you 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.
+-->
+
+<project xmlns="http://maven.apache.org/DECORATION/1.0.0";
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
+  xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.0 
http://maven.apache.org/xsd/decoration-1.0.0.xsd";>
   <body>
+    <menu name="Reference">
+      <item name="lifecycle.xml" href="lifecycle-mappings.html"/>
+    </menu>
     <menu ref="parent"/>
     <menu ref="reports"/>
   </body>

Reply via email to