svn commit: r1062449 - /aries/site/trunk/content/development/maven-best-practice-in-aries.mdtext

[zo...@apache.org]

Author: zoe
Date: Sun Jan 23 15:14:11 2011
New Revision: 1062449

URL: http://svn.apache.org/viewvc?rev=1062449&view=rev
Log:
update best practice for mvn

Modified:
    aries/site/trunk/content/development/maven-best-practice-in-aries.mdtext

Modified: aries/site/trunk/content/development/maven-best-practice-in-aries.mdtext
URL: http://svn.apache.org/viewvc/aries/site/trunk/content/development/maven-best-practice-in-aries.mdtext?rev=1062449&r1=1062448&r2=1062449&view=diff
==============================================================================
--- aries/site/trunk/content/development/maven-best-practice-in-aries.mdtext (original)
+++ aries/site/trunk/content/development/maven-best-practice-in-aries.mdtext Sun Jan 23 15:14:11 2011
@@ -6,23 +6,23 @@ Title: Maven best practice in Aries
 <a name="MavenbestpracticeinAries-Overallstructure"></a>
 ### Overall structure
 
-The Aries project is a collection of loosely couple sub-projects, therefore
-it must be possible to build each project on its own. This implies:
+The Aries project is a collection of loosely couple modules, therefore
+it must be possible to build each module on its own. This implies:
 
-1. A parent pom that isn't at the root of the SVN trunk
-1. Each sub-project has enough pom info so that it can be released
-independently
-1. default-parent has dependency management for basic osgi-dependencies that
+1. A parent pom that isn't at the root of the SVN trunk.
+1. Each module has enough pom info so that it can be released
+independently.
+1. parent/default-parent has dependency management for basic osgi-dependencies that
 all projects are almost certain to use (this includes PAX dependencies for
-testing)
-1. Each sub-project has legal files in its checkout root
-1. Each sub-project has an SCM element in its pom, but no others do.
-1. Each subproject has dependency management for everything included in it. 
-In addition, it has its subprojects listed in dependency management.  This
+testing).
+1. Each module has legal files in its checkout root.
+1. Each module has an SCM element in its top level pom and _not_ in any other pom in the module.
+1. Each module has dependency management for everything included in it. 
+In addition, it has its sub-projects listed in dependency management.  This
 means that
-1. modules in a subproject don't need to include versions for use of other
+   1. sub-project poms should not include versions for use of other
 modules
-1. you can get dependency management for all the modules in a subproject by
+   1. you can get dependency management for all the modules in a subproject by
 depending on the subproject pom with scope import  (see the samples pom for
 an example).
 1. As a result of the above, modules don't have any versions in any
@@ -34,6 +34,7 @@ dependency elements
 1. Alphabetic ordering in dependency management
 1. Include a brief description of the project
 1. Commenting in platform dependencies, see samples assembly projects.
+1. Use ${project.version} _not_ ${version} for Maven 3 compatibility.
 
 <a name="MavenbestpracticeinAries-GroupandArtifactnames"></a>
 ### Group and Artifact names