umagesh 2003/06/04 05:18:55
Modified: docs ant_task_guidelines.html
Added: . patch.xml
Log:
Suggest using Ant to generate a patch file for Ant.
Revision Changes Path
1.1 ant/patch.xml
Index: patch.xml
===================================================================
<?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>
1.11 +24 -2 ant/docs/ant_task_guidelines.html
Index: ant_task_guidelines.html
===================================================================
RCS file: /home/cvs/ant/docs/ant_task_guidelines.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- ant_task_guidelines.html 10 Feb 2003 14:44:21 -0000 1.10
+++ ant_task_guidelines.html 4 Jun 2003 12:18:55 -0000 1.11
@@ -355,12 +355,34 @@
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
