From e0afa9b0aae6d36bf140b2cca6d7e795e93b3c49 Mon Sep 17 00:00:00 2001
From: Magesh Umasankar <umagesh@apache.org>
Date: Wed, 4 Jun 2003 12:18:55 +0000
Subject: [PATCH] Suggest using Ant to generate a patch file for Ant.

git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@274644 13f79535-47bb-0310-9956-ffa450edef68
---
 docs/ant_task_guidelines.html | 26 +++++++++++++++++++--
 patch.xml                     | 43 +++++++++++++++++++++++++++++++++++
 2 files changed, 67 insertions(+), 2 deletions(-)
 create mode 100644 patch.xml

diff --git a/docs/ant_task_guidelines.html b/docs/ant_task_guidelines.html
index 50cb12918..96ac76830 100644
--- a/docs/ant_task_guidelines.html
+++ b/docs/ant_task_guidelines.html
@@ -355,12 +355,34 @@ The basic mechanism is to mail it to the dev mailing list.
 It helps to be on this list, as you will see other submissions, and
 any debate about your own submission.
 <p>
-
+You may create your patch file using either of the following approaches.
+The committers recommend you to take the first approach.
+<p>
+<ul>
+<li> <h3>Approach 1 - The Ant Way</h3>
+<p>
+Use Ant to generate a patch file to Ant:
+<pre class="code">
+ant -f patch.xml
+</pre>
+This will create a file named patch.tar.gz that will contain a unified
+diff of files that have been modified and also include files that have
+been added.  Review the file for completeness and correctness.  This approach
+is recommended because it standardizes the way in which patch files are
+constructed.  It also eliminates the chance of you missing to submit new files
+that constitute part of the patch.
+<p>
+<li><h3>Approach 2 - The Manual Way</h3>
+<p>
 Patches to existing files should be generated with
 <code>cvs diff -u filename</code>
  and save the output to a file. If you want to get
 the changes made to multiple files in a directory , just use <code>cvs
-diff -u</code>. The patches should be sent as an attachment to a message titled [PATCH]
+diff -u</code>.  Then, Tar and GZip the patch file as well as any new files
+that you have added.
+</ul>
+<p>
+The patches should be sent as an attachment to a message titled [PATCH]
 and distinctive one-line summary in the subject of the patch. The
 filename/task and the change usually suffices. It's important to include
 the changes as an attachment, as too many mailers reformat the text
diff --git a/patch.xml b/patch.xml
new file mode 100644
index 000000000..339b8b9ca
--- /dev/null
+++ b/patch.xml
@@ -0,0 +1,43 @@
+<?xml version="1.0"?>
+
+<!--
+  =======================================================================
+    Apache Ant own build file
+
+   Copyright (c) 2003 The Apache Software Foundation.  All rights
+   reserved.
+
+  =======================================================================
+-->
+<project name="create-patch" default="patchpackage" basedir=".">
+    <property environment="env"/>
+    <property name="patch.package" value="patch.tar.gz"/>
+    <property name="patch.file" value="patch.txt"/>
+
+    <condition property="cvs.found">
+      <or>
+        <available file="cvs"     filepath="${env.PATH}"/>
+        <available file="cvs.exe" filepath="${env.PATH}"/>
+        <available file="cvs.exe" filepath="${env.Path}"/>
+      </or>
+    </condition>
+
+    <target name="createpatch" if="cvs.found">
+        <cvs command="-q diff -u" output="${patch.file}"/>
+    </target>
+
+    <target name="newfiles" depends="createpatch">
+        <delete file="${patch.package}"/>
+        <cvs command="-q diff -N" output="${patch.file}.tmp"/>
+        <replace file="${patch.file}.tmp" token="? " value=""/>
+    </target>
+
+    <target name="patchpackage" depends="newfiles">
+        <tar basedir="${basedir}"
+            tarfile="${patch.package}"
+            compression="gzip"
+            includesfile="${patch.file}.tmp"
+            excludes="${patch.file}.tmp"/>
+        <delete file="${patch.file}.tmp"/>
+    </target>
+</project>