Author: vsiveton
Date: Fri Jul 4 05:46:12 2008
New Revision: 674033
URL: http://svn.apache.org/viewvc?rev=674033&view=rev
Log:
o move a section related to svn commands
o improved APT
Modified:
maven/site/trunk/src/site/apt/developers/conventions/svn.apt
maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
Modified: maven/site/trunk/src/site/apt/developers/conventions/svn.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/developers/conventions/svn.apt?rev=674033&r1=674032&r2=674033&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/developers/conventions/svn.apt (original)
+++ maven/site/trunk/src/site/apt/developers/conventions/svn.apt Fri Jul 4
05:46:12 2008
@@ -82,3 +82,36 @@
+-----+
where <<XXX>> is the wanted version
+
+* Other useful Subversion commands while developing
+
+ If you've done a chunk of work and you would like ditch your changes and
start from scratch use this command to
+ revert to the original checkout:
+
+---
+$ svn revert -R .
+---
+
+ The <<<-R>>> argument means that the command will recurse down all
directories and revert all changes.
+
+ Before committing code to the Subversion repository we always set the
<<<svn:ignore>>> property on the directory
+ to prevent some files and directories to be checked in. We always exclude the
IDE project files and the <<<target/>>>
+ directory. Instead of keeping all of the excludes in mind all the time it's
useful to put them all in a file and
+ reference the file with the <<<-F>>> option:
+
+---
+$ svn propset svn:ignore -F ~/bin/svnignore .
+---
+
+ An example svnignore file:
+
+---
+target
+*~
+*.log
+.classpath
+.project
+*.ipr
+*.iws
+*.iml
+---
Modified:
maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
URL:
http://svn.apache.org/viewvc/maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt?rev=674033&r1=674032&r2=674033&view=diff
==============================================================================
--- maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
(original)
+++ maven/site/trunk/src/site/apt/guides/development/guide-m2-development.apt
Fri Jul 4 05:46:12 2008
@@ -5,7 +5,7 @@
Trygve Laugstol
Brett Porter
------
- 2008-07-03
+ 2008-07-04
------
~~ Licensed to the Apache Software Foundation (ASF) under one
@@ -103,40 +103,9 @@
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.
- * Make sure that you follow our code style.
+ * Make sure that you follow our code style, see {{{#Further_Links}Further
Links}}.
-* Other useful Subversion commands while developing
-
- If you've done a chunk of work and you would like ditch your changes and
start from scratch use this command to
- revert to the original checkout:
-
----
-$ svn revert -R .
----
-
- The <<<-R>>> argument means that the command will recurse down all
directories and revert all changes.
-
- Before committing code to the Subversion repository we always set the
<<<svn:ignore>>> property on the directory
- to prevent some files and directories to be checked in. We always exclude the
IDE project files and the <<<target/>>>
- directory. Instead of keeping all of the excludes in mind all the time it's
useful to put them all in a file and
- reference the file with the <<<-F>>> option:
-
----
-$ svn propset svn:ignore -F ~/bin/svnignore .
----
-
- An example svnignore file:
-
----
-target
-*~
-*.log
-.classpath
-.project
-*.ipr
-*.iws
-*.iml
----
+ []
* Patch acceptance criteria
@@ -158,6 +127,8 @@
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.
+ []
+
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 welcome!
@@ -165,7 +136,7 @@
Maven 2 has a few dependencies on other projects.
- * Plexus
+ * <<Plexus>>
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
@@ -173,14 +144,14 @@
You can {{{http://plexus.codehaus.org}read more about Plexus}}.
- * Modello
+ * <<Modello>>
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.
You can {{{http://modello.codehaus.org}read more about Modello}}.
- * Surefire
+ * <<Surefire>>
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
@@ -188,7 +159,7 @@
You can {{{http://maven.apache.org/surefire/}read more about Surefire}}.
- * Doxia
+ * <<Doxia>>
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.
@@ -196,7 +167,7 @@
You can read more about {{{http://maven.apache.org/doxia/}Doxia}} and the
currently supported
{{{http://maven.apache.org/doxia/references/index.html}document formats}}.
- * Mojo
+ * <<Mojo>>
"Mojo" is really two things when it comes to Maven. It is both Maven's
plug-in API but also a separate Codehaus
project hosting these plugins.
@@ -205,6 +176,8 @@
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.
+ []
+
* Sub Projects
** Maven SCM
@@ -217,12 +190,12 @@
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.
-* Further Links
+* {Further Links}
- * {{{../../developers/code.html}Maven Code Style And Code Convention}}
+ * {{{../../developers/conventions/code.html}Maven Code Style And Code
Convention}}
- * {{{../../developers/jira.html}Maven Jira Convention}}
+ * {{{../../developers/conventions/jira.html}Maven Jira Convention}}
- * {{{../../developers/svn.html}Maven SVN Convention}}
+ * {{{../../developers/conventions/svn.html}Maven SVN Convention}}
[]
