From 17de4b0c7d721d58d082e7d1162149f3713dcf9b Mon Sep 17 00:00:00 2001 From: Trygve Laugstol Date: Thu, 1 Sep 2005 21:54:52 +0000 Subject: [PATCH] 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 --- .../src/site/apt/developers/development-guide.apt | 14 +++++++++++++- maven-site/src/site/apt/plugin-overview.apt | 2 +- maven-site/src/site/xdoc/getting-started.xml | 1 + 3 files changed, 15 insertions(+), 2 deletions(-) diff --git a/maven-site/src/site/apt/developers/development-guide.apt b/maven-site/src/site/apt/developers/development-guide.apt index b5d58e54f1..576bb741fe 100644 --- a/maven-site/src/site/apt/developers/development-guide.apt +++ b/maven-site/src/site/apt/developers/development-guide.apt @@ -59,6 +59,10 @@ Developing Maven 2 * Name the file <<-.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: @@ -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 directory directly from JIRA like this. The <<>> and <<>> 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 | patch -p0 @@ -81,6 +85,14 @@ $ wget -O - -q | patch -p0 $ 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 If you've done a chunk of work and you would like ditch your changes and start from scratch use this command to diff --git a/maven-site/src/site/apt/plugin-overview.apt b/maven-site/src/site/apt/plugin-overview.apt index 7ffb5c5394..e01ba79eea 100644 --- a/maven-site/src/site/apt/plugin-overview.apt +++ b/maven-site/src/site/apt/plugin-overview.apt @@ -82,7 +82,7 @@ Plugin Overview [[2]] {{{plugin-management.html}Managing plugin configuration in large projects}} - [[3]] {{{plugin-configuration.html}Configuring plugins}} + [[3]] {{{getting-started.html#configuring_plugins}Configuring plugins}} * Comparison to Maven 1.x Plugins diff --git a/maven-site/src/site/xdoc/getting-started.xml b/maven-site/src/site/xdoc/getting-started.xml index 9c82359f9a..33cb2b38a8 100644 --- a/maven-site/src/site/xdoc/getting-started.xml +++ b/maven-site/src/site/xdoc/getting-started.xml @@ -136,6 +136,7 @@ been done.

+

What if you would like to customise whether a plugins is enabled, or how a plugin operates?