You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by bu...@apache.org on 2012/12/10 09:17:44 UTC
svn commit: r841370 [16/47] - in /websites/staging/maven/trunk/content: ./
ant/ background/ css/ developers/ developers/conventions/
developers/release/ developers/website/ docs/ docs/2.0.1/ docs/2.0.10/
docs/2.0.11/ docs/2.0.2/ docs/2.0.3/ docs/2.0.4/...
Added: websites/staging/maven/trunk/content/guides/development/guide-building-m2.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-building-m2.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-building-m2.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,297 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Guide to Building Maven</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Brett Porter
+Jason van Zyl" />
+ <meta name="Date-Creation-yyyymmdd" content="20090801" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Guide to Building Maven
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Building Maven<a name="Building_Maven"></a></h2><div class="section"><h3>Why would I want to build Maven?<a name="Why_would_I_want_to_build_Maven"></a></h3><p>Building Maven yourself is for one of two reasons:</p><ul><li>to try out a bleeding edge feature or bugfix (issues can be found in <a class="externalLink" href="http://jira.codehaus.org/browse/MNG"> JIRA</a>),</li><li>to fix a problem you are having and submit a patch to the developers team.</li></ul><p>Note, that you don't need to bootstrap Maven for day to day use, or to develop plugins. While we encourage getting involved and fixing bugs that you find, for day to day use we recommend using the latest release.</p></div><div class="section"><h3>Checking out the sources<a name="Checking_out_the_sources"></a></h3><p>All of the source code for Maven and its related libraries is in <a class="externalLink" href="http://subversion.apache.org/"> Subversion</a>. You can <a class
="externalLink" href="http://svn.apache.org/viewvc/maven/"> browse the repository</a>, or checkout specific modules directly.</p><p>To build Maven 3 (the current stable branch), you need the <tt>trunk</tt> of the <tt>maven-3</tt> module. To check that out, run the command:</p><div><pre>svn co https://svn.apache.org/repos/asf/maven/maven-3/trunk/ maven-3</pre></div><p>To build Maven 2, you need the <tt>maven-2.2.x</tt> branch of the <tt>maven-2</tt> module. To check that out, run the command:</p><div><pre>svn co https://svn.apache.org/repos/asf/maven/maven-2/branches/maven-2.2.x maven-2.2.x</pre></div><p>Alternatively, you can check out all Maven projects in one directory using:</p><div><pre>svn co https://svn.apache.org/repos/asf/maven/trunks maven</pre></div><p>If you have checked out <tt>trunks</tt>, the <tt>maven-2.2.x</tt> directory will contain the Maven 2.2 source code, and the <tt>maven-3</tt> directory will contain the 3.0 source code. Note that neither directory con
tains any of the plugins.</p><p><b>Note</b>: For Windows users, the checkout could be not complete with the following message:</p><div><pre>svn: Can't open file 'XXX': The system cannot find the path specified.</pre></div><p>The problem is that while Windows allows filenames up to 256 characters the maximum path length it allows is 260 characters. You will be able to check it out to the root directory without problem.</p><div class="section"><h4>Other Modules<a name="Other_Modules"></a></h4><p>Other modules you might be interested in related to Maven development are:</p><ul><li><tt>core-integration-testing/trunk</tt> - <a href="/core-its/">Maven Core Integration Tests</a>, to deeply test your Maven build.</li><li><tt>plugins/trunk</tt> - The sources of the <a href="/plugins/">Maven plugins</a>. These can be individually installed, or built together.</li><li><tt>plugin-tools/trunk</tt> - <a href="/plugin-tools/">Set of tools for Maven plugins</a> like test harness.</li><li><t
t>release/trunk</tt> - Release manager and plugin.</li><li><tt>site/trunk</tt> - The Maven website.</li><li><tt>skins/trunk</tt> - <a href="/skins/">Skins</a> for generated site used by site plugin.</li><li>Some Maven sub projects<ul><li><tt>wagon/trunk</tt> - <a href="/wagon/">Maven Wagon</a>, used by the artifact code and others for providing the transport layer to get and put artifacts in a repository.</li><li><tt>scm/trunk</tt> - <a href="/scm/">Maven SCM</a>, a generic API to communicate with various different SCM providers, used by Continuum and the release and SCM plugins.</li><li><tt>doxia/trunk</tt> - The <a href="/doxia/">Doxia</a> site generation library used by several report plugins and site plugin.</li><li><tt>surefire/trunk</tt> - The <a href="/surefire/}Surefire">/surefire/}Surefire</a> test runner.</li></ul></li><li><tt>shared/trunk</tt> - <a href="/shared/">Collection of shared libraries</a> like file/path handling.</li><li><tt>sandbox/trunk</tt> - Sandbox
codes.</li><li><a class="externalLink" href="http://svn.plexus.codehaus.org/plexus/"> Plexus</a> - the IoC container used by Maven.</li></ul><p>If you're <a class="externalLink" href="http://svn.apache.org/viewvc/maven/trunks/">looking at the <tt>trunks</tt> directory with ViewVC</a>, there is seemingly nothing there. We use <a class="externalLink" href="http://svnbook.red-bean.com/en/1.0/ch07s03.html">externals definitions</a> to link together all the trunks into one logical location for convenience. If you want to see what is being linked into one logical location you can use the following command:</p><div><pre>svn propget svn:externals</pre></div></div></div><div class="section"><h3>Building Maven<a name="Building_Maven"></a></h3><div class="section"><h4>Building Maven With Maven Installed<a name="Building_Maven_With_Maven_Installed"></a></h4><p>If you already have Maven installed, it can be faster to build a new version with Maven, rather than a clean bootstrap.</p><p>To
do this, run from the <tt>maven-3</tt> or <tt>maven-2.2.x</tt> directory:</p><div><pre>mvn install</pre></div><p>Optionally, you can use the following to run the full (long) suite of integration tests; see below.</p><p>The assemblies will be created in <tt>apache-maven/target</tt> for Maven 2.0.x or <tt>maven-distribution</tt> for Maven 2.1, and can be unzipped to the location where you'd like Maven installed.</p></div><div class="section"><h4>Running the full integration tests<a name="Running_the_full_integration_tests"></a></h4><p>Before checking in a change or submitting a patch, it's a good idea to run the integration tests. These live in their own directory in subversion, as noted above: <tt>core-integration-testing/trunk</tt>. Using your local build of Maven, run:</p><div><pre>mvn install -Prun-its</pre></div></div><div class="section"><h4>Building Maven Without Maven Installed<a name="Building_Maven_Without_Maven_Installed"></a></h4><p>If you do not have Maven instal
led, you can use <a class="externalLink" href="http://ant.apache.org">Apache Ant</a> to build Maven.</p><p>Once you have checked out the code, change into the <tt>maven-3</tt> or <tt>maven-2.2.x</tt> directory that was created.</p><p>Set the M2_HOME environment variable to the location that should contain Maven. This directory <b>must</b> be named after the Maven version you want to build and install, for example <tt>/usr/local/maven-2.2-SNAPSHOT</tt>.</p><div><pre>export M2_HOME=/usr/local/maven-2.2-SNAPSHOT
+PATH=$M2_HOME/bin:$PATH</pre></div><p>or</p><div><pre>set M2_HOME=c:\maven-2.2-SNAPSHOT
+set PATH=%M2_HOME%\bin;%PATH%</pre></div><p>From this, run the <tt>ant</tt> command:</p><div><pre>ant</pre></div><p>This will download dependencies, build Maven, and install it into the directory you specified as <tt>M2_HOME</tt> above.</p><p>If you have any problems or get any failures during the run, please report them to the <a href="../../mail-lists.html"> Maven Developers List</a>.</p><p>For more information, consult the project help in the Ant build file.</p><div><pre>ant -projecthelp</pre></div><p>The result is included here for convenience:</p><div class="source"><pre>Buildfile: build.xml
+
+ The first time you build Maven from source, you have to build Maven without
+ Maven. This Ant script builds a minimal Maven, just enough to re-launch
+ Maven again in this directory and generate an installation assembly. Then we
+ extract the assembly and re-run the Maven build one more time, this time
+ with the full generated Maven.
+
+ To run this script, you must set the M2_HOME environment variable or the
+ maven.home property to the location that should contain Maven. This
+ directory *must* be named after the maven version you want to install, e.g.
+ /usr/local/maven-2.1-SNAPSHOT.
+
+ You can set the maven.repo.local property to specify a custom location for
+ your local repository for the bootstrap process.
+
+Main targets:
+
+ classpath-pre constructs a classpath reference containing our dependencies,
+ and verifies that all files are present
+
+ clean-bootstrap cleans up generated bootstrap classes
+
+ compile-boot compiles the bootstrap sources
+
+ extract-assembly extracts the maven assembly into maven.home
+
+ generate-sources generates Java sources from Modello mdo model files
+
+ maven-assembly generates the Maven installation assembly using the bootstrap
+ Maven
+
+ maven-compile compiles Maven using the bootstrap Maven, skipping automated
+ tests
+
+ pull copies all required dependencies from the Maven remote
+ repository into your local repository. Set the 'skip.pull'
+ property to skip this step, but only if you're sure you
+ already have all of the dependencies downloaded to
+ your local repository
+
+ run-full-maven runs the full extracted Maven, now with tests
+
+Default target: all</pre></div></div></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/guides/development/guide-documentation-style.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-documentation-style.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-documentation-style.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,266 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Guide To Maven Documentation Style</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Dennis Lundberg" />
+ <meta name="Date-Creation-yyyymmdd" content="20080712" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Guide To Maven Documentation Style
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Guide To Maven Documentation Style<a name="Guide_To_Maven_Documentation_Style"></a></h2><div class="section"><h3>Where did the style came from?<a name="Where_did_the_style_came_from"></a></h3><p>The documentation style guide was created to make our documentation more consistent and also to apply best practices to the documentation as well. The standard has just been started and will expand over time based on the suggestions made on the Maven dev mailing list. It is a community consensus of how we should write our documentation.</p><p>Each rule in this guide should come with a motivation as to why it exists. References to external sources are encouraged.</p></div><div class="section"><h3>Date format<a name="Date_format"></a></h3><p>How people format a date varies around the world, sometimes making it hard for people to understand each other. The solution to this problem comes in the form of the ISO-8601 standard.</p><p>A date in
our documentation must follow this standard:</p><p><b>YYYY-MM-DD</b></p><p>where <b>YYYY</b> is the year in the Gregorian calendar, <b>MM</b> is the month of the year between 01 (January) and 12 (December), and <b>DD</b> is the day of the month between 01 and 31.</p><p><b>Note</b>: All documentation meta-data should respect this convention, for instance for this given APT document:</p><div class="source"><pre> ------
+ Guide To Maven Documentation Style
+ ------
+ Dennis Lundberg
+ ------
+ 2008-07-03
+ ------</pre></div><div class="section"><h4>References<a name="References"></a></h4><ul><li><a class="externalLink" href="http://www.w3.org/QA/Tips/iso-date">W3C Quality Web Tips</a></li><li><a class="externalLink" href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780">ISO-8601</a></li><li><a class="externalLink" href="http://en.wikipedia.org/wiki/ISO_8601">Wikipedia</a></li></ul><!-- NOTE: Add more rules here. Follow the heading style of the rule above. --></div></div><div class="section"><h3>POM Snippet<a name="POM_Snippet"></a></h3><p>A POM file must use 2 spaces for each indentation. Because POM snippets are often used in documentation to show the user how to configure something, it is important that these snippets aren't too wide. If the are too wide it will make the page difficult to read on a smaller screen.</p><p>When you use a snippet of XML from the POM as an example in your documentation, you need to make sure that the example
is properly indented. A user should be able to copy and paste the example into their own POM without the need to change the indentation afterwards.</p><p>Also, you should declare all parent POM elements to improve the comprehension. You could use ellipsis (i.e. ...) if you don't want to specify elements.</p><div class="section"><h4>Example<a name="Example"></a></h4><p>The following is an example of how the distribution management of the Maven site is configured.</p><div class="source"><pre><project>
+ ...
+ <distributionManagement>
+ <site>
+ <id>apache.website</id>
+ <url>scp://people.apache.org/www/maven.apache.org/</url>
+ </site>
+ </distributionManagement>
+ ...
+</project></pre></div><p>As you can see above the <tt><distributionManagement></tt> element is indented once (=2 spaces), the <tt><site></tt> element in indented twice (=4 spaces) and the <tt><id></tt> is indented three times (=6 spaces).</p></div></div><div class="section"><h3>Naming Documentation Files<a name="Naming_Documentation_Files"></a></h3><p>All file names should replace space by a minus (-), for instance for this given APT document:</p><div class="source"><pre> guide-documentation-style.apt</pre></div></div><div class="section"><h3>Updating Documentation Files<a name="Updating_Documentation_Files"></a></h3><p>A good practice is to update the date (with the correct date format) when you are updating documentation files.</p></div><div class="section"><h3>Write Thinking<a name="Write_Thinking"></a></h3><p>Here are some pointers about English rules when typing material:</p><ul><li><a class="externalLink" href="http://en.wikipedia.org/wiki/Wikip
edia:Manual_of_Style">Wikipedia:Manual of Style</a>, specifically <a class="externalLink" href="http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation">Punctuation Part</a></li><li><a class="externalLink" href="http://developer.gnome.org/projects/gtp/style-guides/pdf/styleguide-C.pdf">Linguistic Style Guidelines</a>, specifically the "Grammatical Guidelines" chapter.</li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/guides/development/guide-helping.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-helping.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-helping.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,252 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Guide to helping with Maven</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Brett Porter
+Jason van Zyl" />
+ <meta name="Date-Creation-yyyymmdd" content="20080703" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Guide to helping with Maven
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <strong>How to Contribute</strong>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Guide to helping with Maven<a name="Guide_to_helping_with_Maven"></a></h2><p>As with any open source project, there are several ways you can help:</p><ul><li>Join the <a href="../../mail-lists.html">mailing list</a> and answer other user's questions</li><li>Report bugs, feature requests and other issues in the <a href="../../issue-tracking.html">issue tracking</a> application.</li><li><a href="./guide-building-m2.html"> Build Maven</a> for yourself, in order to fix bugs.</li><li><a href="./guide-m2-development.html#Creating_and_submitting_a_patch">Submit patches</a> to reported issues (both those you find, or that others have filed)</li><li><a href="./guide-testing-releases.html"> test releases</a> help test releases that are being voted on (see the dev@maven.apache.org <a href="../../mail-lists.html"> mailing list</a> for release votes</li><li><a href="./guide-testing-development-plugins.html"> test snapshot plugins</a> help t
est the latest development versions of plugins and report issues</li><li>Help with the documentation by pointing out areas that are lacking or unclear, and if you are so inclined, submitting patches to correct it. You can quickly contribute rough thoughts to the <a class="externalLink" href="http://docs.codehaus.org/display/MAVENUSER/"> wiki</a>, or you can volunteer to help collate and organise information that is already there.</li></ul><p>Your participation in the community is much appreciated!</p></div><div class="section"><h2>Why Would I Want to Help?<a name="Why_Would_I_Want_to_Help"></a></h2><p>There are several reasons these are good things.</p><ul><li>By answering other people's questions, you can learn more for yourself</li><li>By submitting your own fixes, they get incorporated faster</li><li>By reporting issues, you ensure that bugs don't get missed, or forgotten</li><li>You are giving back to a community that has given you software for free</li></ul></div><div c
lass="section"><h2>How do I Join the Project?<a name="How_do_I_Join_the_Project"></a></h2><p>Projects at Apache operate under a meritocracy, meaning those that the developers notice participating to a high extent will be invited to join the project as a committer.</p><p>This is as much based on personality and ability to work with other developers and the community as it is with proven technical ability. Being unhelpful to other users, or obviously looking to become a committer for bragging rights and nothing else is frowned upon, as is asking to be made a committer without having contributed sufficiently to be invited.</p></div><div class="section"><h2>Developers Conventions<a name="Developers_Conventions"></a></h2><p>There are a number of conventions used in the project, which contributors and developers alike should follow for consistency's sake.</p><ul><li><a href="../../developers/conventions/code.html">Maven Code Style And Convention</a></li><li><a href="../../develope
rs/conventions/jira.html">Maven JIRA Convention</a></li><li><a href="../../developers/conventions/svn.html">Maven SVN Convention</a></li><li><a href="../../developers/release/releasing.html">Releasing a maven project</a></li></ul></div><div class="section"><h2>Resources for committers<a name="Resources_for_committers"></a></h2><ul><li><a class="externalLink" href="http://www.apache.org/dev/"> Developer Resources</a></li><li><a class="externalLink" href="http://www.apache.org/foundation/"> About the Apache Software Foundation</a></li><li><a class="externalLink" href="http://www.apache.org/dev/committers.html"> Committer FAQ</a></li><li><a class="externalLink" href="http://people.apache.org/~vgritsenko/stats/projects/maven.html"> Web Stats</a></li><li><a class="externalLink" href="http://people.apache.org/~coar/mlists.html#maven.apache.org"> Mailing List Stats</a></li><li><a class="externalLink" href="http://wiki.apache.org/"> Apache Wiki</a></li></ul></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>
Added: websites/staging/maven/trunk/content/guides/development/guide-m2-development.html
==============================================================================
--- websites/staging/maven/trunk/content/guides/development/guide-m2-development.html (added)
+++ websites/staging/maven/trunk/content/guides/development/guide-m2-development.html Mon Dec 10 08:17:24 2012
@@ -0,0 +1,259 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Dec 10, 2012
+ | Rendered using Apache Maven Stylus Skin 1.5
+-->
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>Maven - Guide to Developing Maven</title>
+ <style type="text/css" media="all">
+ @import url("../../css/maven-base.css");
+ @import url("../../css/maven-theme.css");
+ @import url("../../css/site.css");
+ </style>
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print" />
+ <meta name="author" content="Emmanuel Venisse
+Trygve Laugstol
+Brett Porter" />
+ <meta name="Date-Creation-yyyymmdd" content="20080704" />
+ <meta name="Date-Revision-yyyymmdd" content="20121210" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
+
+<script type="text/javascript">_uacct = "UA-140879-1";
+ urchinTracker();</script>
+ </head>
+ <body class="composite">
+ <div id="banner">
+ <a href="../.././" id="bannerLeft">
+ <img src="../../images/apache-maven-project-2.png" alt="" />
+ </a>
+ <span id="bannerRight">
+ <img src="../../images/maven-logo-2.gif" alt="" />
+ </span>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="breadcrumbs">
+
+ <div class="xleft">
+ <a href="http://www.apache.org/" class="externalLink">Apache</a>
+ >
+ <a href="../../index.html">Maven</a>
+ >
+ Guide to Developing Maven
+ </div>
+ <div class="xright">
+ Last Published: 2012-12-10
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ <div id="leftColumn">
+ <div id="navcolumn">
+
+ <h5>Main</h5>
+ <ul>
+ <li class="none">
+ <a href="../../index.html">Welcome</a>
+ </li>
+ </ul>
+ <h5>Get Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../download.html">Download</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/3.0.4/release-notes.html">Release Notes (3.0.4)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.2.1/release-notes.html">Release Notes (2.2.1)</a>
+ </li>
+ <li class="none">
+ <a href="../../docs/2.0.11/release-notes.html">Release Notes (2.0.11)</a>
+ </li>
+ <li class="none">
+ <a href="../../license.html">License</a>
+ </li>
+ </ul>
+ <h5>IDE Integration</h5>
+ <ul>
+ <li class="none">
+ <a href="../../eclipse-plugin.html">Eclipse</a>
+ </li>
+ <li class="none">
+ <a href="../../netbeans-module.html">NetBeans</a>
+ </li>
+ </ul>
+ <h5>About Maven</h5>
+ <ul>
+ <li class="none">
+ <a href="../../what-is-maven.html">What is Maven?</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-features.html">Features</a>
+ </li>
+ <li class="none">
+ <a href="../../general.html">FAQ (official)</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/FAQs-1" class="externalLink">FAQ (unofficial)</a>
+ </li>
+ </ul>
+ <h5>Documentation</h5>
+ <ul>
+ <li class="none">
+ <a href="../../plugins/index.html">Maven Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/index.html">Index (category)</a>
+ </li>
+ <li class="none">
+ <a href="../../run-maven/index.html">Running Maven</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../users/index.html">User Centre</a>
+ </li>
+ <li class="collapsed">
+ <a href="../../plugin-developers/index.html">Plugin Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../repository/index.html">Maven Repository Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../developers/index.html">Maven Developer Centre</a>
+ </li>
+ <li class="none">
+ <a href="../../articles.html">Books and Resources</a>
+ </li>
+ <li class="none">
+ <a href="http://docs.codehaus.org/display/MAVENUSER/Home" class="externalLink">Wiki</a>
+ </li>
+ </ul>
+ <h5>Community</h5>
+ <ul>
+ <li class="none">
+ <a href="../../community.html">Community Overview</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/development/guide-helping.html">How to Contribute</a>
+ </li>
+ <li class="none">
+ <a href="../../guides/mini/guide-maven-evangelism.html">Maven Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../users/getting-help.html">Getting Help</a>
+ </li>
+ <li class="none">
+ <a href="../../issue-tracking.html">Issue Tracking</a>
+ </li>
+ <li class="none">
+ <a href="../../source-repository.html">Source Repository</a>
+ </li>
+ <li class="none">
+ <a href="../../team-list.html">The Maven Team</a>
+ </li>
+ </ul>
+ <h5>Project Documentation</h5>
+ <ul>
+ <li class="collapsed">
+ <a href="../../project-info.html">Project Information</a>
+ </li>
+ </ul>
+ <h5>Maven Projects</h5>
+ <ul>
+ <li class="none">
+ <a href="../../ant-tasks/index.html">Ant Tasks</a>
+ </li>
+ <li class="none">
+ <a href="../../archetype/index.html">Archetype</a>
+ </li>
+ <li class="none">
+ <a href="../../doxia/index.html">Doxia</a>
+ </li>
+ <li class="none">
+ <a href="../../jxr/index.html">JXR</a>
+ </li>
+ <li class="none">
+ <a href="../../maven-1.x/index.html">Maven 1.x</a>
+ </li>
+ <li class="none">
+ <a href="../../index.html">Maven 2 & 3</a>
+ </li>
+ <li class="none">
+ <a href="../../pom/index.html">Parent POMs</a>
+ </li>
+ <li class="none">
+ <a href="../../plugins/index.html">Plugins</a>
+ </li>
+ <li class="none">
+ <a href="../../plugin-tools/index.html">Plugin Tools</a>
+ </li>
+ <li class="none">
+ <a href="../../scm/index.html">SCM</a>
+ </li>
+ <li class="none">
+ <a href="../../shared/index.html">Shared Components</a>
+ </li>
+ <li class="none">
+ <a href="../../skins/index.html">Skins</a>
+ </li>
+ <li class="none">
+ <a href="../../surefire/index.html">Surefire</a>
+ </li>
+ <li class="none">
+ <a href="../../wagon/index.html">Wagon</a>
+ </li>
+ </ul>
+ <h5>ASF</h5>
+ <ul>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/how-it-works.html" class="externalLink">How Apache Works</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/" class="externalLink">Foundation</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsoring Apache</a>
+ </li>
+ <li class="none">
+ <a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a>
+ </li>
+ </ul>
+ <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
+ <img alt="Built by Maven" src="../../images/logos/maven-feather.png"/>
+ </a>
+
+ </div>
+ </div>
+ <div id="bodyColumn">
+ <div id="contentBox">
+ <!-- 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. --><!-- NOTE: For help with the syntax of this file, see: --><!-- http://maven.apache.org/doxia/referen
ces/apt-format.html --><div class="section"><h2>Developing Maven<a name="Developing_Maven"></a></h2><p>This document describes how to get started into developing Maven itself. There is a separate page describing how to <a href="./guide-building-m2.html">building Maven</a>.</p><div class="section"><h3>Finding some work to do<a name="Finding_some_work_to_do"></a></h3><p>First of all you need something to work on! Unless you have found a particular issue you would like to work on the Maven team has categorized a few issues that we could use <i>your</i> help to solve them.</p><p>JIRA has RSS feeds available if you'd like to include those in your favorite feed aggregator.</p><p>We categorize the issues in three different categories:</p><ul><li><b><a class="externalLink" href="http://jira.codehaus.org/secure/IssueNavigator.jspa?pid=10500&resolutionIds=-1&customfield_10010=Novice&sorter/field=priority&sorter/order=ASC&sorter/field=issuekey&sorter/order=ASC&a
mp;tempMax=25&reset=true">Novice</a></b>: No previous exposure to the code needed. <i>(<a class="externalLink" href="http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&pid=10500&resolutionIds=-1&customfield_10010=Novice&sorter/field=priority&sorter/order=ASC&sorter/field=issuekey&sorter/order=ASC&tempMax=25&reset=true&decorator=none">rss feed</a>)</i></li><li><b><a class="externalLink" href="http://jira.codehaus.org/secure/IssueNavigator.jspa?pid=10500&resolutionIds=-1&customfield_10010=Intermediate&sorter/field=priority&sorter/order=ASC&sorter/field=issuekey&sorter/order=ASC&tempMax=25&reset=true">Intermediate</a></b>: Exposure to Maven pluins and/or internals required. <i>(<a class="externalLink" href="http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&pid=10500&resolutionIds=-1&customfield_10010=Intermediate&sorter/field=priority&sorter/order=ASC&sorter/
field=issuekey&sorter/order=ASC&tempMax=25&reset=true&decorator=none">rss feed</a>)</i></li><li><b><a class="externalLink" href="http://jira.codehaus.org/secure/IssueNavigator.jspa?pid=10500&resolutionIds=-1&customfield_10010=Expert&sorter/field=priority&sorter/order=ASC&sorter/field=issuekey&sorter/order=ASC&tempMax=25&reset=true">Expert</a></b>: Good knowledge of Maven internals and it's dependencies required. <i>(<a class="externalLink" href="http://jira.codehaus.org/secure/IssueNavigator.jspa?view=rss&pid=10500&resolutionIds=-1&customfield_10010=Expert&sorter/field=priority&sorter/order=ASC&sorter/field=issuekey&sorter/order=ASC&tempMax=25&reset=true&decorator=none">rss feed</a>)</i></li></ul><p>When you find a issue you would like to work on add a comment in the issue log so the core developers and other people looking for work know that someone is already working on it.</p></div><di
v class="section"><h3>Where's the source?<a name="Wheres_the_source"></a></h3><p>You'll need to check out two trees from subversion:</p><ul><li><a class="externalLink" href="https://svn.apache.org/repos/asf/maven/maven-3/trunk">https://svn.apache.org/repos/asf/maven/maven-3/trunk</a> The trunk for the core of Maven-3.</li><li><a class="externalLink" href="https://svn.apache.org/repos/asf/maven/core-integration-testing/trunk">https://svn.apache.org/repos/asf/maven/core-integration-testing/trunk</a> The corresponding integration test set.</li></ul></div><div class="section"><h3>Don't forget tests!<a name="Dont_forget_tests"></a></h3><p>You will find many unit tests in the maven-3 tree. If at all possible, create or modify a unit test to demonstrate the problem, and then validate your fix.</p><p>If the problem case can't be set up in the unit tests, add an integration test.</p><p>Before submitting a patch, in any case, you should run all of the integration tests. The tests requ
ire an empty local repository.</p><p>Ant version 1.8+ is recommended.</p><div class="source"><pre>cd maven-3-trunk
+export M2_HOME=/place-to-put-test-maven-root
+ant all (or with -Dmaven.home=/place-to-put-test-maven-root )
+cd ../core-integration-testing
+rm -rf /tmp/it.repo
+/place-to-put-test-maven-root/bin/mvn -Prun-its -B -U clean install -Dmaven.repo.local=/tmp/it.repo -Dmaven.home=/place-to-put-test-maven-root</pre></div><p>To run a single test, change the last command line to:</p><div class="source"><pre>cd ../core-integration-testing/core-it-suite
+[whatever]/mvn -Dtest=yourit [other options]</pre></div></div><div class="section"><h3><a name="Creating_and_submitting_a_patch">Creating and submitting a patch</a></h3><p>When you have either completed an issue or just want some feedback on the work you have done, create a patch and attach the patch to the issue in question. We have a couple of guidelines when creating patches:</p><ul><li>Patch the trunk, not a tag. Otherwise, your patch is outdated the moment you create it and might not be applicable to the development head.</li><li>Always create the patch from the root of the Maven project, i.e. where the <tt>pom.xml</tt> file is.</li><li>If this was a new piece of work without a JIRA issue, create a JIRA issue for it now.</li><li>Name the file <tt>MNG-<issue number>-<artifact id>.patch</tt>.</li><li>Attach the patch to the JIRA issue you were working on (do not paste its content in as a comment though). When adding the patch add a comment to the issue explain
ing what it does. Shortly after, someone will apply the patch and close the issue.</li></ul><p>An example on how to create a patch from the command line:</p><div><pre>$ svn diff > MNG-123-maven-core.patch</pre></div><p>If you are picking up an issue with a existing patch attached to the issue you can apply the patch to your working directory directly from JIRA like this. The <tt>wget</tt> and <tt>patch</tt> commands will only be available if you are on a UNIX platform or using Cygwin on windows.</p><div><pre>$ wget -O - -q <URL to the patch from JIRA> | patch -p0</pre></div><p>If the patch is in a local file <tt>MNG-123.patch</tt> and you want to apply that use this command:</p><div><pre>$ patch -p0 < MNG-123.patch</pre></div><p>A couple of notes:</p><ul><li>If you are using another tool for creating patches, make sure that the patch doesn't include absolute paths. Including absolute paths in the patch will make the useless for us as we most likely don't have the
same directory structure as you.</li><li>Make sure that you follow our code style, see <a href="#Further_Links">Further Links</a>.</li></ul></div><div class="section"><h3>Patch acceptance criteria<a name="Patch_acceptance_criteria"></a></h3></div></div><div class="section"><h2>There are a number of criteria that a patch will be judged on:<a name="There_are_a_number_of_criteria_that_a_patch_will_be_judged_on:"></a></h2><ul><li>Whether it works and does what is intended. This one is probably obvious!</li><li>Whether it fits the spirit of the project. Some patches may be rejected as they take the project in a different direction to that which the current development community has chosen. This is usually discussed on an issue well before a patch is contributed, so if you are unsure, discuss it there or on the mailing lists first. Feel free to continue discussing it (with new justification) if you disagree, or appeal to a wider audience on the mailing lists.</li><li>Whether it c
ontains tests. It is expected that any patches relating to functionality will be accompanied by unit tests and/or integration tests. It is strongly desired (and will be requested) for bug fixes too, but will not be the basis for not applying it. At a bare minimum, the change should not decrease the amount of automated test coverage. As a community, we are focusing on increasing the current coverage, as there are several areas that do not receive automated testing.</li><li>Whether it contains documentation. All new functionality needs to be documented for users, even if it is very rough for someone to expand on later. While rough is acceptable, incomplete is not. As with automated testing, as a community we are striving to increase the current coverage of documentation.</li></ul></div><div class="section"><h2>Above all, don't be discouraged. These are the same requirements the current committers should hold each other to as well. And remember, your contributions are always we
lcome!<a name="Above_all_dont_be_discouraged._These_are_the_same_requirements_the_current_committers_should_hold_each_other_to_as_well._And_remember_your_contributions_are_always_welcome"></a></h2><div class="section"><h3>Related Projects<a name="Related_Projects"></a></h3><p>Maven has a few dependencies on other projects.</p><ul><li><b>Plexus</b><p>Plexus is a full-fledged container supporting different kinds of component lifecycles. It's native lifecycle is like any other modern IoC container, using field injection of both requirements and configuration. All core Maven functionality are Plexus components.</p><p>You can <a class="externalLink" href="http://plexus.codehaus.org">read more about Plexus</a>.</p></li><li><b>Modello</b><p>Modello is a simple tool for representing an object model and generate code and resources from the model. Maven is using Modello to generate all Java objects, XML readers and writers, XML Schema and HTML documentation.</p><p>You can <a class="ex
ternalLink" href="http://modello.codehaus.org">read more about Modello</a>.</p></li><li><b>Surefire</b><p>Surefire is a testing framework. It can run regular JUnit tests so you won't have to change anything in your code to use it. It support scripting tests in BeanShell and Jython and has special "batteries" for writing acceptance and functional tests for the web and for testing XML-RPC code.</p><p>You can <a class="externalLink" href="http://maven.apache.org/surefire/">read more about Surefire</a>.</p></li><li><b>Doxia</b><p>Doxia is Maven's documentation engine. It has a sink and parser API that can be used to plug in support for input and output documents.</p><p>You can read more about <a class="externalLink" href="http://maven.apache.org/doxia/">Doxia</a> and the currently supported <a class="externalLink" href="http://maven.apache.org/doxia/references/index.html">document formats</a>.</p></li><li><b>Mojo</b><p>"Mojo" is really two things when it come
s to Maven. It is both Maven's plug-in API but also a separate Codehaus project hosting these plugins.</p><p><a class="externalLink" href="http://mojo.codehaus.org">The Mojo Project</a> is a plugin forge for all non-core Maven plugins. As we try to keep the Mojos as independent of Maven as possible to increase their reuse we try to keep them a bit away from Maven itself. There is also a lower bar for becoming a part of the project.</p></li></ul></div><div class="section"><h3>Sub Projects<a name="Sub_Projects"></a></h3><div class="section"><h4>Maven SCM<a name="Maven_SCM"></a></h4><p>Maven SCM (Source Control Management) is an reusable API which is independent of Maven itself and it is used by the SCM related Maven Plugins. The core part of Maven itself doesn't depend on Maven SCM.</p><p>You can <a class="externalLink" href="http://maven.apache.org/scm/">read more about Scm</a>.</p></div><div class="section"><h4>Maven Wagon<a name="Maven_Wagon"></a></h4><p>Maven Wagon is also
a standalone API that deals with transporting files and directories. Maven Core uses the Wagon API to download and upload artifacts and artifact metadata and the site plug-in uses it to publish the site.</p><p>You can <a class="externalLink" href="http://maven.apache.org/wagon/">read more about Wagon</a>.</p></div></div><div class="section"><h3><a name="Further_Links">Further Links</a></h3><ul><li><a href="../../developers/conventions/code.html">Maven Code Style And Code Convention</a></li><li><a href="../../developers/conventions/jira.html">Maven JIRA Convention</a></li><li><a href="../../developers/conventions/svn.html">Maven SVN Convention</a></li></ul></div></div>
+ </div>
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ <div id="footer">
+ <div class="xright">
+ © 2002-2012
+ The Apache Software Foundation
+
+ - <a href="http://maven.apache.org/privacy-policy.html">Privacy Policy</a>.
+ Apache Maven, Maven, Apache, the Apache feather logo, and the Apache Maven project logos are trademarks of The Apache Software Foundation.
+ </div>
+ <div class="clear">
+ <hr/>
+ </div>
+ </div>
+ </body>
+</html>