Re: [PATCH] docs: remove outdated suggestion to make patches with "diff -urp" or "git diff"

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 29.06.2016 21:40, Laine Stump wrote:
> I can't think of any good reason to do either of those, and having the
> examples there will just lead to unusable patch emails from people who
> can't be bothered to read the entire page.
> ---
> 
> I'm sure there are other problems with this file, but this one really
> jupmed out at me when I was suggesting to someone that they look to
> this page for proper procedures.
> 
>  docs/hacking.html.in | 12 +-----------
>  1 file changed, 1 insertion(+), 11 deletions(-)
> 
> diff --git a/docs/hacking.html.in b/docs/hacking.html.in
> index a471d88..5f19143 100644
> --- a/docs/hacking.html.in
> +++ b/docs/hacking.html.in
> @@ -23,21 +23,11 @@
>          automatically pulls the latest version of each translation
>          file from zanata.</li>
>  
> -      <li><p>Post patches in unified diff format, with git rename
> +      <li><p>Post patches using "git send-email", 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/ &gt; libvirt-myfeature.patch
> -</pre>
> -        <p>
> -          or:
> -        </p>
> -<pre>
> -  git diff &gt; libvirt-myfeature.patch
> -</pre>
>          <p>Also, for code motion patches, you may find that <code>git
>          diff --patience</code> provides an easier-to-read patch.
>          However, the usual workflow of libvirt developer is:</p>
> 

I agree with Jirka's ACK, but please include the HACKING file change too. Even
though it's a generated file from docs/hacking.html.in, we keep it in the repo
too (so that newbies have something to read right after they clone the repo,
prior building it).

diff --git a/HACKING b/HACKING
index 0aba279..3656411 100644
--- a/HACKING
+++ b/HACKING
@@ -23,19 +23,11 @@ libvirt-python) online <http://libvirt.org/git/>.
 join the appropriate language team. The libvirt release process automatically
 pulls the latest version of each translation file from zanata.
 
-(4) Post patches in unified diff format, with git rename detection enabled. You
+(4) Post patches using "git send-email", 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
-
-or:
-
-  git diff > libvirt-myfeature.patch
-
 Also, for code motion patches, you may find that "git diff --patience"
 provides an easier-to-read patch. However, the usual workflow of libvirt
 developer is:


Michal

--
libvir-list mailing list
libvir-list@xxxxxxxxxx
https://www.redhat.com/mailman/listinfo/libvir-list



[Index of Archives]     [Virt Tools]     [Libvirt Users]     [Lib OS Info]     [Fedora Users]     [Fedora Desktop]     [Fedora SELinux]     [Big List of Linux Books]     [Yosemite News]     [KDE Users]     [Fedora Tools]