You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by br...@apache.org on 2008/08/06 03:52:54 UTC
svn commit: r683084 - in /maven/site/trunk/src/site: apt/guides/
apt/guides/development/ fml/ resources/
Author: brett
Date: Tue Aug 5 18:52:53 2008
New Revision: 683084
URL: http://svn.apache.org/viewvc?rev=683084&view=rev
Log:
update development guides and make snapshot messages clearer
Removed:
maven/site/trunk/src/site/apt/guides/development/guide-plugin-snapshot-repositories.apt
Modified:
maven/site/trunk/src/site/apt/guides/development/guide-building-m2.apt
maven/site/trunk/src/site/apt/guides/development/guide-helping.apt
maven/site/trunk/src/site/apt/guides/development/guide-testing-development-plugins.apt
maven/site/trunk/src/site/apt/guides/index.apt
maven/site/trunk/src/site/fml/general.fml
maven/site/trunk/src/site/resources/.htaccess
Modified: maven/site/trunk/src/site/apt/guides/development/guide-building-m2.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-building-m2.apt?rev=683084&r1=683083&r2=683084&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/development/guide-building-m2.apt (original)
+++ maven/site/trunk/src/site/apt/guides/development/guide-building-m2.apt Tue Aug 5 18:52:53 2008
@@ -104,116 +104,33 @@
svn propget svn:externals
-------------------
-* Building Maven 2.0
+* Building Maven
-** Building Maven 2.0 With Maven Installed
+** Building Maven With Maven Installed
If you already have Maven installed, it can be faster to build a new version with Maven, rather than a clean bootstrap.
- You may need to add the snapshots repository to your settings:
-
-+---+
-<settings>
- <profiles>
- <profile>
- <repositories>
- <repository>
- <id>apache.snapshots</id>
- <name>Apache Snapshot Repository</name>
- <url>http://people.apache.org/repo/m2-snapshot-repository</url>
- <releases>
- <enabled>false</enabled>
- </releases>
- </repository>
- </repositories>
- <pluginRepositories>
- <pluginRepository>
- <id>apache.snapshots</id>
- <name>Apache Snapshot Repository</name>
- <url>http://people.apache.org/repo/m2-snapshot-repository</url>
- <releases>
- <enabled>false</enabled>
- </releases>
- </pluginRepository>
- </pluginRepositories>
- <id>m2.snapshotbuild</id>
- </profile>
- </profiles>
- <activeProfiles>
- <activeProfile>m2.snapshotbuild</activeProfile>
- </activeProfiles>
-</settings>
-+---+
-
- To do this, run from the <<<maven-2.0.x>>> directory:
+ To do this, run from the <<<components>>> or <<<maven-2.0.x>>> directory:
----
mvn install
----
- The assemblies will be created in <<<target>>> and can be unzipped to the location where you'd like Maven installed.
-
-** Building Maven 2.0 Without Maven Installed
-
- Once you have checked out the code, change into the <<<maven-2.0.x>>> directory that was created.
- You may want to setup a different environment to install Maven to, other than your normal installation of a
- release, so set the <<<M2_HOME>>> environment variable accordingly, e.g.:
-
-----
-export M2_HOME=/usr/local/maven-2.0.6-SNAPSHOT
-PATH=$M2_HOME/bin:$PATH
-----
-
- or
-
-----
-set M2_HOME=c:\maven-2.0.6-SNAPSHOT
-set PATH=%M2_HOME%\bin;%PATH%
-----
-
- From this, run the <<<bootstrap>>> command for your system:
-
-----
-sh bootstrap.sh
-----
-
- or
-
-----
-bootstrap.bat
-----
-
- First, the code will be built, and a Maven installation created. If you have checked out all the trunks so that the plugins
- exist in <<<../plugins>>>, the plugins will also be rebuilt and installed in the local repository.
- Finally, a set of integration tests will run.
-
- Note that it isn't necessary to have a previous version (alpha-X...) of maven 2 installed before bootstrap.
-
- If you have any problems or get any failures during the run, please report them to the
- {{{/mail-lists.html} Maven Developers List}}.
-
-* Building Maven 2.1
-
-** Building Maven 2.1 With Maven Installed
-
- Once you have checked out the code, change into the <<<maven-components>>>
- directory. (If you checked out <<<trunks>>>, then it will be the
- <<<components>>> directory.)
-
- Then execute the following command:
+ Optionally, you can use the following to run the full (long) suite of integration tests:
----
-mvn install
+mvn install -Prun-its
----
- This will build, test and install all libraries in the local repository and
- produce the binary distribution under <<<maven-embedder/target/maven-2.1-SNAPSHOT-bin.*>>>
- that can be unzipped to the location where you'd like Maven installed.
+ The assemblies will be created in <<<apache-maven/target>>> for Maven 2.0.x or <<<maven-distribution>>> for Maven 2.1,
+ and can be unzipped to the location where you'd like Maven installed.
-** Building Maven 2.1 Without Maven Installed
+** Building Maven Without Maven Installed
If you do not have Maven installed, you can use
- {{{http://ant.apache.org}Apache Ant}} to build Maven 2.1.
+ {{{http://ant.apache.org}Apache Ant}} to build Maven.
+
+ Once you have checked out the code, change into the <<<components>>> or <<<maven-2.0.x>>> directory that was created.
Set the M2_HOME environment variable to the location that should contain
Maven. This directory <<must>> be named after the Maven version you want to
@@ -221,27 +138,28 @@
----
export M2_HOME=/usr/local/maven-2.1-SNAPSHOT
+PATH=$M2_HOME/bin:$PATH
----
or
----
set M2_HOME=c:\maven-2.1-SNAPSHOT
+set PATH=%M2_HOME%\bin;%PATH%
----
- Once you have checked out the code, change into the <<<maven-components>>>
- directory. (If you checked out <<<trunks>>>, then it will be the
- <<<components>>> directory.)
-
- From this, just run <<<ant>>> which will execute the default <<<all>>> target.
+ From this, run the <<<ant>>> command:
----
ant
----
- This will download dependencies, build Maven 2.1, and install it into the
+ This will download dependencies, build Maven, and install it into the
directory you specified as <<<M2_HOME>>> above.
+ If you have any problems or get any failures during the run, please report them to the
+ {{{/mail-lists.html} Maven Developers List}}.
+
For more information, consult the project help in the Ant build file.
----
Modified: maven/site/trunk/src/site/apt/guides/development/guide-helping.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-helping.apt?rev=683084&r1=683083&r2=683084&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/development/guide-helping.apt (original)
+++ maven/site/trunk/src/site/apt/guides/development/guide-helping.apt Tue Aug 5 18:52:53 2008
@@ -41,7 +41,7 @@
* {{{./guide-testing-releases.html} test releases}} help test releases that are being voted on (see the dev@maven.apache.org {{{../../mail-lists.html} mailing list}} for release votes
- * {{{./guide-plugin-snapshot-repositories.html} test snapshot plugins}} help test the latest development versions of plugins and report issues
+ * {{{./guide-testing-development-plugins.html} test snapshot plugins}} help test the latest development versions of plugins and report issues
* 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 {{{http://docs.codehaus.org/display/MAVENUSER/} wiki}}, or you can volunteer to help collate and
Modified: maven/site/trunk/src/site/apt/guides/development/guide-testing-development-plugins.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-testing-development-plugins.apt?rev=683084&r1=683083&r2=683084&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/development/guide-testing-development-plugins.apt (original)
+++ maven/site/trunk/src/site/apt/guides/development/guide-testing-development-plugins.apt Tue Aug 5 18:52:53 2008
@@ -13,14 +13,20 @@
If a bug you are encountering has been reported as fixed but not yet released, you can confirm that it has been fixed
for you. Or perhaps you just like to live on the bleeding edge.
- <Note:> This is <<not>> recommended as an everyday or in production practice!
+ You are highly encouraged to join the development list for the project and provide your feedback, or help promote release
+ of the plugin in question.
+
+ <Note:> This is <<not>> recommended as an everyday or in production practice! Snapshots are for testing purposes only and
+ are not official releases. For more information, see {{{http://www.apache.org/dev/release.html#what} the Releases FAQ}}.
* How do I do this?
- Development versions of Maven plugins are periodically published to the repository: {{http://people.apache.org/repo/m2-snapshot-repository/}}
+ Development versions of Maven plugins are periodically published to the repository: {{http://people.apache.org/repo/m2-snapshot-repository/}}.
<Note:> Currently, this is not done automatically by our continuous integration setup. This is coming soon.
+ Other sites may publish there own - for example, the Mojo project hosts theirs at {{http://snapshots.repository.codehaus.org/}}
+
The first step is to include this in your project:
-------
@@ -36,10 +42,6 @@
</project>
-------
- <Note:> If you are using the goals from the command line on a number of projects, you should include this in your
- <<<settings.xml>>> file instead. See {{{../mini/guide-configuring-maven.html}Guide to configuring Maven}}
- for more info.
-
After this is included, there are three ways to use the updated versions:
* Set the appropriate version in the plugin, eg <<<2.0.1-SNAPSHOT>>>
@@ -69,13 +71,58 @@
</project>
-------
- <Note:> These last two techniques mean that <every> plugin will be updated to the latest snapshot version. Finer grained
- control will be available in future versions.
+ <Note:> These last two techniques mean that <every> plugin will be updated to the latest snapshot version.
+
+ The development version will stop being used if the <<<\<pluginRepository\>>>> element is removed from your POM
+ and the version is set back to the release version. If you are using the command line or an unspecified version,
+ you will also need to remove the version from the local repository.
+
+* Using Settings without Modifying the Project
+
+ If you are using the goals from the command line on a number of projects, you should include this in your
+ <<<settings.xml>>> file instead.
+
+ You need to modify your <<<~/.m2/settings.xml>>> file to include two new profiles
+ and then when you need access to the plugin snapshots use <<<-Papache>>>.
+ The profile only needs to be enabled once so that the plugins can be downloaded into you local repository. Once
+ in your local repository Maven can succesfully resolve the dependencies and
+ the profile no longer needs to be activated.
+
++---
+<settings>
+ ...
+ <profiles>
+ <profile>
+ <id>apache</id>
+ <pluginRepositories>
+ <pluginRepository>
+ <id>apache.org</id>
+ <name>Maven Plugin Snapshots</name>
+ <url>http://people.apache.org/repo/m2-snapshot-repository</url>
+ <releases>
+ <enabled>false</enabled>
+ </releases>
+ <snapshots>
+ <enabled>true</enabled>
+ </snapshots>
+ </pluginRepository>
+ </pluginRepositories>
+ </profile>
+ </profiles>
+ ...
+</settings>
++---
+
+ When invoking Maven for Apache profile, do it like this:
+
++---
+mvn -Papache <phase|goal>
++---
-* How do I stop doing this?
+* Using a Repository Manager
- The development version will stop being used if the <<<\<pluginRepository\>>>> element is removed from your POM or
- <<<settings.xml>>> (regardless of what is in your local repository).
+ In addition to the above you may want to use a repository manager so that you can retain the builds you have been using.
+ For information on this technique, see the {{{guide-testing-releases.html} Guide to Testing Staged Releases}}.
* How do I make changes to the source and test development versions of the plugins?
Modified: maven/site/trunk/src/site/apt/guides/index.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/index.apt?rev=683084&r1=683083&r2=683084&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/index.apt (original)
+++ maven/site/trunk/src/site/apt/guides/index.apt Tue Aug 5 18:52:53 2008
@@ -138,8 +138,6 @@
* {{{./development/guide-m2-development.html}Developing Maven}}
- * {{{./development/guide-plugin-snapshot-repositories.html}Plugin Snapshot Repositories}}
-
* {{{./development/guide-plugin-documentation.html}The Plugin Documentation Standard}}
* {{{./development/guide-documentation-style.html}Maven Documentation Style}}
Modified: maven/site/trunk/src/site/fml/general.fml
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/fml/general.fml?rev=683084&r1=683083&r2=683084&view=diff
==============================================================================
--- maven/site/trunk/src/site/fml/general.fml (original)
+++ maven/site/trunk/src/site/fml/general.fml Tue Aug 5 18:52:53 2008
@@ -320,7 +320,7 @@
<p>
You need to update your settings.xml file using the
- <a href="guides/development/guide-plugin-snapshot-repositories.html">
+ <a href="guides/development/guide-testing-development-plugins.html">
Guide to Plugin Snapshot Repositories</a>
</p>
</answer>
Modified: maven/site/trunk/src/site/resources/.htaccess
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/resources/.htaccess?rev=683084&r1=683083&r2=683084&view=diff
==============================================================================
--- maven/site/trunk/src/site/resources/.htaccess (original)
+++ maven/site/trunk/src/site/resources/.htaccess Tue Aug 5 18:52:53 2008
@@ -25,3 +25,4 @@
RedirectMatch permanent ^/plugins/maven-clover-plugin/ins(.+)$ http://maven.apache.org/plugins/maven-clover-plugin/2.4/ins$1
RedirectMatch permanent ^/plugins/maven-clover-plugin/int(.+)$ http://maven.apache.org/plugins/maven-clover-plugin/2.4/int$1
+Redirect Permanent /guides/development/guide-plugin-snapshot-repositories.html http://maven.apache.org/guides/development/guide-testing-development-plugins.html