[40979] trunk/doc-new/guide/xml/portfiledev.xml

[markd at macports.org]

Revision: 40979
          http://trac.macports.org/changeset/40979
Author:   markd at macports.org
Date:     2008-10-19 21:03:28 -0700 (Sun, 19 Oct 2008)
Log Message:
-----------
Edit the recent change to Creating Source Code Patches section.  I'll contact 
simon@ to see if his original intent has been followed.

Modified Paths:
--------------
    trunk/doc-new/guide/xml/portfiledev.xml

Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml	2008-10-20 02:39:47 UTC (rev 40978)
+++ trunk/doc-new/guide/xml/portfiledev.xml	2008-10-20 04:03:28 UTC (rev 40979)
@@ -536,9 +536,8 @@
       author so the modifications may be included in the next version of the
       application.</para>
 
-      <para>You should create one patch file for each file to be patched,
-      though it is permissible to use existing patches you find that patch
-      multiple files. Patchfile filenames should uniquely distinguish the file
+      <para>Generally speaking, you should create one patch file for each file
+      to be patched. Patchfile filenames should uniquely distinguish the file
       and generally be of the form
       <filename>patch-</filename><replaceable>&lt;directory&gt;</replaceable>-<replaceable>&lt;filename&gt;.diff</replaceable>,
       as shown in this example:
@@ -546,11 +545,25 @@
       apply with "patch -p0'' from the working source directory of the
       port.</para>
 
-      <para>If fixing an issues needs changes in multiple files all changes
-      should be stored in one patch file. The patch should then be named after
-      the issue which is fixed,
-      <filename>patch-</filename><replaceable>&lt;issue&gt;.diff</replaceable>.</para>
+      <para>You may use patch files that patch multiple files under these
+      conditions:</para>
 
+      <itemizedlist>
+        <listitem>
+          <para>You find existing patch files that do so</para>
+        </listitem>
+
+        <listitem>
+          <para>If fixing a particular problem or bug requires changes in
+          multiple files -in those cases the patch filename should reference
+          the problem or bug, for example:
+          <filename>patch-</filename><replaceable>&lt;destroot_variable_fix&gt;.diff</replaceable></para>
+        </listitem>
+      </itemizedlist>
+
+      <para>To create a patch to modify a single file, follow the steps
+      below.</para>
+
       <orderedlist>
         <listitem>
           <para>Locate the file you wish to patch in its original location
@@ -782,4 +795,4 @@
       ${name}-src-${version}</para>
     </section>
   </section>
-</chapter>
+</chapter>
\ No newline at end of file
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20081019/3fd11afe/attachment.html