o Adding some more notes on how to create patches.

git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@265788 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Trygve Laugstol 2005-09-01 21:54:52 +00:00
parent 6cf731be0e
commit 17de4b0c7d
3 changed files with 15 additions and 2 deletions

View File

@ -59,6 +59,10 @@ Developing Maven 2
* Name the file <<<MNG-<issue number>-<artifact id>.patch>>>. * Name the file <<<MNG-<issue number>-<artifact id>.patch>>>.
* When adding the patch add a comment to the JIRA suggesting the commit message. For information on what to include
in a commit message please take a look at the existing commit messages. Currently the commit mails are sent to
{{{http://mail-archives.apache.org/mod_mbox/maven-dev/}dev@maven.apache.org}} with the subject prefix "svn commit".
[] []
An example on how to create a patch from the command line: An example on how to create a patch from the command line:
@ -69,7 +73,7 @@ $ svn diff > MNG-123-maven-core.patch
If you are picking up an issue with a existing patch attached to the issue you can apply the patch to your working 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 <<<wget>>> and <<<patch>>> commands will only be available if you are directory directly from JIRA like this. The <<<wget>>> and <<<patch>>> commands will only be available if you are
on a UNIX platform or Cygwin on windows. on a UNIX platform or using Cygwin on windows.
--- ---
$ wget -O - -q <URL to the patch from JIRA> | patch -p0 $ wget -O - -q <URL to the patch from JIRA> | patch -p0
@ -81,6 +85,14 @@ $ wget -O - -q <URL to the patch from JIRA> | patch -p0
$ patch -p0 < MNG-123.patch $ patch -p0 < MNG-123.patch
--- ---
A couple of notes:
* 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.
* Make sure that you follow our code style.
* Other useful Subversion commands while developing * 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 If you've done a chunk of work and you would like ditch your changes and start from scratch use this command to

View File

@ -82,7 +82,7 @@ Plugin Overview
[[2]] {{{plugin-management.html}Managing plugin configuration in large [[2]] {{{plugin-management.html}Managing plugin configuration in large
projects}} projects}}
[[3]] {{{plugin-configuration.html}Configuring plugins}} [[3]] {{{getting-started.html#configuring_plugins}Configuring plugins}}
* Comparison to Maven 1.x Plugins * Comparison to Maven 1.x Plugins

View File

@ -136,6 +136,7 @@
been done. been done.
</p> </p>
</subsection> </subsection>
<a name="configuring_plugins"/>
<subsection name="Configuring Plugins"> <subsection name="Configuring Plugins">
<p> <p>
What if you would like to customise whether a plugins is enabled, or how a plugin operates? What if you would like to customise whether a plugins is enabled, or how a plugin operates?