Author: rafale
Date: Fri Feb 22 13:48:16 2008
New Revision: 630331
URL: http://svn.apache.org/viewvc?rev=630331&view=rev
Log:
Doc: improved usage documentation on create-from-project
Modified:
maven/archetype/trunk/src/site/apt/advanced-usage.apt
maven/archetype/trunk/src/site/apt/usage.apt
Modified: maven/archetype/trunk/src/site/apt/advanced-usage.apt
URL:
http://svn.apache.org/viewvc/maven/archetype/trunk/src/site/apt/advanced-usage.apt?rev=630331&r1=630330&r2=630331&view=diff
==============================================================================
--- maven/archetype/trunk/src/site/apt/advanced-usage.apt (original)
+++ maven/archetype/trunk/src/site/apt/advanced-usage.apt Fri Feb 22 13:48:16
2008
@@ -29,4 +29,47 @@
Archetype creation
-~~TODO: add content
\ No newline at end of file
+ Creating an archetype from an existing project involves three steps :
+
+ * the archetype resolution
+
+ * the archetype installation:deployment
+
+ * the archetype usage
+
+ []
+
+
+Usage
+
+ Calling <<<mvn archetype:create-from-project>>> the plugin first resolves
+ the package by guessing the project directory.
+
+ It then generates the directory tree of the archetype in the
+ <<<target/generated-sources/archetype>>> directory.
+
++---
+ ADD SOME SAMPLE
++---
+
+ Then move to that generated directory and call <<<mvn install>>> on the
+ created archetype.
+
++---
+ ADD SOME SAMPLE
++---
+
+ Finally move to a fresh directory and use your archetype.
+
+
+Configuration
+
+ The <<<create-from-project>>> mojo enable the user to provide some sensible
+ configuration using the system properties or a property file.
+
+ The system properties permits the user to define the groupId, artifactId,
+ version of the created archetype. They also permits to override the
resolved
+ package and to create a partial archetype.
+
+ When used, the property file takes precedence on the system properties.
+ It is also the only way to define additional properties in the archetype.
Modified: maven/archetype/trunk/src/site/apt/usage.apt
URL:
http://svn.apache.org/viewvc/maven/archetype/trunk/src/site/apt/usage.apt?rev=630331&r1=630330&r2=630331&view=diff
==============================================================================
--- maven/archetype/trunk/src/site/apt/usage.apt (original)
+++ maven/archetype/trunk/src/site/apt/usage.apt Fri Feb 22 13:48:16 2008
@@ -164,3 +164,9 @@
11 directories, 3 files
+---
+Backward compatibility
+
+ For backward compatibility with the Archetype Plugin version 1.0-alpha-7,
+ we keeped the old create goal which can be called using
+ <<<mvn archetype:create>>>. See {{{#}the old documentation}} for further
+ reading.
\ No newline at end of file
