Mailing-List: contact commits-help@commons.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@commons.apache.org
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r1042908 -
 /commons/proper/commons-site/trunk/src/site/xdoc/patches.xml
Date: Tue, 07 Dec 2010 04:16:47 -0000
To: commits@commons.apache.org
From: sebb@apache.org
Message-Id: <20101207041647.44D0A23889E9@eris.apache.org>

Author: sebb
Date: Tue Dec  7 04:16:46 2010
New Revision: 1042908

URL: http://svn.apache.org/viewvc?rev=1042908&view=rev
Log:
Patches should be relative to the project root.

Modified:
    commons/proper/commons-site/trunk/src/site/xdoc/patches.xml

Modified: commons/proper/commons-site/trunk/src/site/xdoc/patches.xml
URL: http://svn.apache.org/viewvc/commons/proper/commons-site/trunk/src/site/xdoc/patches.xml?rev=1042908&r1=1042907&r2=1042908&view=diff
==============================================================================
--- commons/proper/commons-site/trunk/src/site/xdoc/patches.xml (original)
+++ commons/proper/commons-site/trunk/src/site/xdoc/patches.xml Tue Dec  7 04:16:46 2010
@@ -67,7 +67,7 @@
   </p>
   <p>
   Please try and restrict patches to the minimum necessary to implement the change.
-  If there are a lot of irrelevant formatting or other changes, it make it much harder to review
+  If there is a lot of irrelevant formatting or other changes, it makes it much harder to review
   the patch, and it may be rejected.
   </p>
   </subsection>
@@ -105,6 +105,15 @@
   <p>
   The patch should be in unified format. You can create a patch in this format (from Subversion) by using:
   <source>svn diff <em>File</em> > <em>patchfile</em></source><br/>
+  </p>
+  <p>
+  The patch should be created from the project root, i.e. the directory which contains the src/ folder
+  and the main Maven pom.xml file. This ensures that the proper relative path names are included, and
+  makes it easier to apply the patch to the correct file (there can be several files with the same name in a project).
+  If using Eclipse to create the patch, set "Patch Root" to "Project" - not the default "Workspace".
+  [Workspace-relative patches are not portable unless exactly the same project names are used.]
+  </p>
+  <p>
   Try to give your patch files meaningful names. This makes it easier for developers who need to 
   apply a number of different patches. 
   </p>