<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[187357] trunk/Tools</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/187357">187357</a></dd>
<dt>Author</dt> <dd>basile_clement@apple.com</dd>
<dt>Date</dt> <dd>2015-07-24 13:22:58 -0700 (Fri, 24 Jul 2015)</dd>
</dl>

<h3>Log Message</h3>
<pre>Call fixChangeLogPatch when generating patches from webkit-patch
https://bugs.webkit.org/show_bug.cgi?id=147248

Reviewed by Geoffrey Garen.

When two consecutive patches are from the same author, diff tools
create wrong-looking diffs for ChangeLog files where the apparent added
author is actually the previous patch's author line, making it awkward
to read - and things only get worse when committing a patch and a
followup fix for the same bug shortly after.

We have a perl function in VCSUtils.pm, fixChangeLogPatch, to corrects
this, which we use in perl scripts (svn-create-patch et al). But it is
not used by webkit-patch, which is a python script, and thus creates
&quot;bad&quot; diffs.

In the long term, we should probably port fixChangeLogPatch to python -
but in the short term, let's make webkit-patch call perl to run
fixChangeLogPatch. We are already making various external calls there
anyway.

* Scripts/webkitpy/common/checkout/scm/git.py:
(Git.create_patch):
* Scripts/webkitpy/common/checkout/scm/scm.py:
(SCM.fix_changelog_patch):
* Scripts/webkitpy/common/checkout/scm/svn.py:
(SVN.create_patch):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptswebkitpycommoncheckoutscmgitpy">trunk/Tools/Scripts/webkitpy/common/checkout/scm/git.py</a></li>
<li><a href="#trunkToolsScriptswebkitpycommoncheckoutscmscmpy">trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm.py</a></li>
<li><a href="#trunkToolsScriptswebkitpycommoncheckoutscmsvnpy">trunk/Tools/Scripts/webkitpy/common/checkout/scm/svn.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (187356 => 187357)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog        2015-07-24 19:48:26 UTC (rev 187356)
+++ trunk/Tools/ChangeLog        2015-07-24 20:22:58 UTC (rev 187357)
</span><span class="lines">@@ -1,3 +1,33 @@
</span><ins>+2015-07-24  Basile Clement  &lt;basile_clement@apple.com&gt;
+
+        Call fixChangeLogPatch when generating patches from webkit-patch
+        https://bugs.webkit.org/show_bug.cgi?id=147248
+
+        Reviewed by Geoffrey Garen.
+
+        When two consecutive patches are from the same author, diff tools
+        create wrong-looking diffs for ChangeLog files where the apparent added
+        author is actually the previous patch's author line, making it awkward
+        to read - and things only get worse when committing a patch and a
+        followup fix for the same bug shortly after.
+
+        We have a perl function in VCSUtils.pm, fixChangeLogPatch, to corrects
+        this, which we use in perl scripts (svn-create-patch et al). But it is
+        not used by webkit-patch, which is a python script, and thus creates
+        &quot;bad&quot; diffs.
+
+        In the long term, we should probably port fixChangeLogPatch to python -
+        but in the short term, let's make webkit-patch call perl to run
+        fixChangeLogPatch. We are already making various external calls there
+        anyway.
+
+        * Scripts/webkitpy/common/checkout/scm/git.py:
+        (Git.create_patch):
+        * Scripts/webkitpy/common/checkout/scm/scm.py:
+        (SCM.fix_changelog_patch):
+        * Scripts/webkitpy/common/checkout/scm/svn.py:
+        (SVN.create_patch):
+
</ins><span class="cx"> 2015-07-24  Dean Johnson  &lt;dean_johnson@apple.com&gt;
</span><span class="cx"> 
</span><span class="cx">         commit-queue flags in webkit-patch are confusing
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpycommoncheckoutscmgitpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/common/checkout/scm/git.py (187356 => 187357)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/common/checkout/scm/git.py        2015-07-24 19:48:26 UTC (rev 187356)
+++ trunk/Tools/Scripts/webkitpy/common/checkout/scm/git.py        2015-07-24 20:22:58 UTC (rev 187357)
</span><span class="lines">@@ -321,7 +321,9 @@
</span><span class="cx">         command += [&quot;--&quot;]
</span><span class="cx">         if changed_files:
</span><span class="cx">             command += changed_files
</span><del>-        return self.prepend_svn_revision(self.run(command, decode_output=False, cwd=self.checkout_root))
</del><ins>+        return self.fix_changelog_patch(
+                self.prepend_svn_revision(
+                    self.run(command, decode_output=False, cwd=self.checkout_root)))
</ins><span class="cx"> 
</span><span class="cx">     def _run_git_svn_find_rev(self, revision_or_treeish, branch=None):
</span><span class="cx">         # git svn find-rev requires SVN revisions to begin with the character 'r'.
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpycommoncheckoutscmscmpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm.py (187356 => 187357)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm.py        2015-07-24 19:48:26 UTC (rev 187356)
+++ trunk/Tools/Scripts/webkitpy/common/checkout/scm/scm.py        2015-07-24 20:22:58 UTC (rev 187357)
</span><span class="lines">@@ -77,6 +77,12 @@
</span><span class="cx">                            return_stderr=return_stderr,
</span><span class="cx">                            decode_output=decode_output)
</span><span class="cx"> 
</span><ins>+    def fix_changelog_patch(self, diff):
+        return self.run(
+                ['perl', '-e', 'use VCSUtils; print(fixChangeLogPatch(join(&quot;&quot;, &lt;STDIN&gt;))-&gt;{&quot;patch&quot;});'],
+                cwd=self._filesystem.join(self.checkout_root, 'Tools', 'Scripts'),
+                input=diff, decode_output=False)
+
</ins><span class="cx">     # SCM always returns repository relative path, but sometimes we need
</span><span class="cx">     # absolute paths to pass to rm, etc.
</span><span class="cx">     def absolute_path(self, repository_relative_path):
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpycommoncheckoutscmsvnpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/common/checkout/scm/svn.py (187356 => 187357)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/common/checkout/scm/svn.py        2015-07-24 19:48:26 UTC (rev 187356)
+++ trunk/Tools/Scripts/webkitpy/common/checkout/scm/svn.py        2015-07-24 20:22:58 UTC (rev 187357)
</span><span class="lines">@@ -273,9 +273,10 @@
</span><span class="cx">         elif changed_files == None:
</span><span class="cx">             changed_files = []
</span><span class="cx">         script_path = self._filesystem.join(self.checkout_root, &quot;Tools&quot;, &quot;Scripts&quot;, &quot;svn-create-patch&quot;)
</span><del>-        return self.run([script_path, &quot;--no-style&quot;] + changed_files,
-            cwd=self.checkout_root, return_stderr=False,
-            decode_output=False)
</del><ins>+        return self.fix_changelog_patch(
+                self.run([script_path, &quot;--no-style&quot;] + changed_files,
+                    cwd=self.checkout_root, return_stderr=False,
+                    decode_output=False))
</ins><span class="cx"> 
</span><span class="cx">     def committer_email_for_revision(self, revision):
</span><span class="cx">         return self._run_svn([&quot;propget&quot;, &quot;svn:author&quot;, &quot;--revprop&quot;, &quot;-r&quot;, revision]).rstrip()
</span></span></pre>
</div>
</div>

</body>
</html>