[libvirt] [PATCH 2/1] docs: mention git rename detection

Eric Blake eblake at redhat.com
Fri Jan 11 00:40:57 UTC 2013


I've noticed a number of people sending patches with file
renames not compressed, so we might as well document how to
set this up.  (Git won't do it by default, for back-compat
reasons)

* docs/hacking.html.in: Add git config tip.
* HACKING: Regenerate.
---
 HACKING              | 7 ++++++-
 docs/hacking.html.in | 8 ++++++--
 2 files changed, 12 insertions(+), 3 deletions(-)

diff --git a/HACKING b/HACKING
index 1b4dea3..11f08ff 100644
--- a/HACKING
+++ b/HACKING
@@ -14,7 +14,12 @@ General tips for contributing patches
 (1) Discuss any large changes on the mailing list first. Post patches early and
 listen to feedback.

-(2) Post patches in unified diff format. A command similar to this should work:
+(2) Post patches in unified diff format, with git rename detection enabled. You
+need a one-time setup of:
+
+  git config diff.renames true
+
+After that, a command similar to this should work:

   diff -urp libvirt.orig/ libvirt.modified/ > libvirt-myfeature.patch

diff --git a/docs/hacking.html.in b/docs/hacking.html.in
index 17136f0..69520f0 100644
--- a/docs/hacking.html.in
+++ b/docs/hacking.html.in
@@ -9,8 +9,12 @@
       <li>Discuss any large changes on the mailing list first.  Post patches
         early and listen to feedback.</li>

-      <li><p>Post patches in unified diff format.  A command similar to this
-        should work:</p>
+      <li><p>Post patches in unified diff format, with git rename
+        detection enabled.  You need a one-time setup of:</p>
+<pre>
+  git config diff.renames true
+</pre>
+        <p>After that, a command similar to this should work:</p>
 <pre>
   diff -urp libvirt.orig/ libvirt.modified/ > libvirt-myfeature.patch
 </pre>
-- 
1.8.0.2




More information about the libvir-list mailing list