[PATCH] Documentation: Update to SubmittingPatches

[PATCH] Documentation: Update to SubmittingPatches

[Ian McDonald]

from ian McDonald

Use of git-diff

Signed-off-by: Ian McDonald <imcdnzl@gmail.com>
---
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 237d54c..b8d746a 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -20,10 +20,24 @@ SECTION 1 - CREATING AND SENDING YOUR CH



-1) "diff -up"
-------------
+1) Creating a diff file
+-----------------------

-Use "diff -up" or "diff -uprN" to create patches.
+You can use git-diff which makes your life easy. If you want it to be more
+difficult then carry on reading.
+
+Make sure your patch does not include any extra files which do not
+belong in a patch submission.  Make sure to review your patch -after-
+generated it with diff(1), to ensure accuracy.
+
+If your changes produce a lot of deltas, you may want to look into
+splitting them into individual patches which modify things in
+logical stages.  This will facilitate easier reviewing by other
+kernel developers, very important if you want your patch accepted.
+There are a number of scripts which can aid in this:
+
+Use "diff -up" or "diff -uprN" to create patches
+------------------------------------------------

 All changes to the Linux kernel occur in the form of patches, as
 generated by diff(1).  When creating your patch, make sure to create it
@@ -61,16 +75,6 @@ patch.  The "dontdiff" file is included
 2.6.12 and later.  For earlier kernel versions, you can get it
 from <http://www.xenotime.net/linux/doc/dontdiff>.

-Make sure your patch does not include any extra files which do not
-belong in a patch submission.  Make sure to review your patch -after-
-generated it with diff(1), to ensure accuracy.
-
-If your changes produce a lot of deltas, you may want to look into
-splitting them into individual patches which modify things in
-logical stages.  This will facilitate easier reviewing by other
-kernel developers, very important if you want your patch accepted.
-There are a number of scripts which can aid in this:
-
 Quilt:
 http://savannah.nongnu.org/projects/quilt

Re: [PATCH] Documentation: Update to SubmittingPatches

[Junio C Hamano]

Ian McDonald <imcdnzl@gmail.com> writes:

> from ian McDonald
>
> Use of git-diff
>
> Signed-off-by: Ian McDonald <imcdnzl@gmail.com>
> ---
> +You can use git-diff which makes your life easy....

Even easier might be to suggest git-format-patch(1).

Re: [PATCH] Documentation: Update to SubmittingPatches

[Ian McDonald]

> > Use of git-diff
> >
> > Signed-off-by: Ian McDonald <imcdnzl@gmail.com>
> > ---
> > +You can use git-diff which makes your life easy....
>
> Even easier might be to suggest git-format-patch(1).
>
>
Yes git-format-patch looks easier if doing full git development. If
just working on one bug fix git-diff is probably easier. I'll
reference both and resubmit.

Ian
--
Ian McDonald
http://wand.net.nz/~iam4
WAND Network Research Group
University of Waikato
New Zealand