threads / patch / 21380

patchgitk: Use the --submodule option for diffs

Subject: [PATCH] gitk: Use the --submodule option for diffs

## tl;dr

6 messages between Oct 27, 2009 and Nov 3, 2009. Diffs are folded; open one to read it.

replies: 5people: 4as markdown or json

Jens Lehmann· Oct 27, 2009, 14:59 UTC · lore

Instead of just showing not-quite-helpful SHA-1 pairs display the first lines of the corresponding commit messages in the submodule (similar to the output of 'git submodule summary').

Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
---

This patch applies to 'next' and uses the new --submodule option of git diff to achieve a more meaningful output of submodule differences in gitk.

Any objections against making this the default?

(for those interested: a version of git gui with similar functionality is available in 'master' of Shawn's repo but not yet merged).

 gitk-git/gitk |   23 +++++++++++++++++++----
 1 files changed, 19 insertions(+), 4 deletions(-)
Show changes to gitk-git/gitk +19 −4
diff --git a/gitk-git/gitk b/gitk-git/gitk
index a0214b7..5e2572d 100644
--- a/gitk-git/gitk
+++ b/gitk-git/gitk
@@ -7207,7 +7207,7 @@ proc diffcmd {ids flags} {
     if {$i >= 0} {
 	if {[llength $ids] > 1 && $j < 0} {
 	    # comparing working directory with some specific revision
-	    set cmd [concat | git diff-index $flags]
+	    set cmd [concat | git diff-index --submodule $flags]
 	    if {$i == 0} {
 		lappend cmd -R [lindex $ids 1]
 	    } else {
@@ -7215,13 +7215,13 @@ proc diffcmd {ids flags} {
 	    }
 	} else {
 	    # comparing working directory with index
-	    set cmd [concat | git diff-files $flags]
+	    set cmd [concat | git diff-files --submodule $flags]
 	    if {$j == 1} {
 		lappend cmd -R
 	    }
 	}
     } elseif {$j >= 0} {
-	set cmd [concat | git diff-index --cached $flags]
+	set cmd [concat | git diff-index --cached --submodule $flags]
 	if {[llength $ids] > 1} {
 	    # comparing index with specific revision
 	    if {$i == 0} {
@@ -7234,7 +7234,7 @@ proc diffcmd {ids flags} {
 	    lappend cmd HEAD
 	}
     } else {
-	set cmd [concat | git diff-tree -r $flags $ids]
+	set cmd [concat | git diff-tree -r --submodule $flags $ids]
     }
     return $cmd
 }
@@ -7481,6 +7481,21 @@ proc getblobdiffline {bdf ids} {
 	    set diffnparents [expr {[string length $ats] - 1}]
 	    set diffinhdr 0

+	} elseif {![string compare -length 10 "Submodule " $line]} {
+	    # start of a new submodule
+	    if {[string compare [$ctext get "end - 4c" end] "\n \n\n"]} {
+		$ctext insert end "\n";     # Add newline after commit message
+	    }
+	    set curdiffstart [$ctext index "end - 1c"]
+	    lappend ctext_file_names ""
+	    set fname [string range $line 10 [expr [string last " " $line] - 1]]
+	    lappend ctext_file_lines $fname
+	    makediffhdr $fname $ids
+	    $ctext insert end "\n$line\n" filesep
+	} elseif {![string compare -length 3 "  >" $line]} {
+	    $ctext insert end "$line\n" dresult
+	} elseif {![string compare -length 3 "  <" $line]} {
+	    $ctext insert end "$line\n" d0
 	} elseif {$diffinhdr} {
 	    if {![string compare -length 12 "rename from " $line]} {
 		set fname [string range $line [expr 6 + [string first " from " $line] ] end]

-- 
1.6.5.2.182.g338ab.dirty
Johannes Schindelin· Oct 27, 2009, 15:41 UTC · re: Jens Lehmann · lore

Re: [PATCH] gitk: Use the --submodule option for diffs

Hi,
On Tue, 27 Oct 2009, Jens Lehmann wrote:
Show 12 quoted lines
> Instead of just showing not-quite-helpful SHA-1 pairs display the first
> lines of the corresponding commit messages in the submodule (similar to
> the output of 'git submodule summary').
> 
> Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
> ---
> 
> This patch applies to 'next' and uses the new --submodule option of git
> diff to achieve a more meaningful output of submodule differences in
> gitk.
> 
> Any objections against making this the default?
Certainly not from me.  It would help people in my day-job project.

Ciao, Dscho

Paul Mackerras· Oct 28, 2009, 04:03 UTC · re: Jens Lehmann · lore

Re: [PATCH] gitk: Use the --submodule option for diffs

Jens Lehmann writes:
Show 10 quoted lines
> Instead of just showing not-quite-helpful SHA-1 pairs display the first
> lines of the corresponding commit messages in the submodule (similar to
> the output of 'git submodule summary').
> 
> Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
> ---
> 
> This patch applies to 'next' and uses the new --submodule option of git
> diff to achieve a more meaningful output of submodule differences in
> gitk.
(That sentence should have been in the commit message.)
> Any objections against making this the default?

What version of git is the first to have the --submodule option? Since it's a new option we should make gitk use it only if the underlying git is new enough, like we do with the --textconv option.

Also, the commit message is a bit sparse; it doesn't mention that this affects the diff display, for instance.

Paul.
Jens Lehmann· Oct 28, 2009, 11:40 UTC · re: Paul Mackerras · lore

[PATCH v2] gitk: Use the --submodule option for displaying diffs when available

Instead of just showing not-quite-helpful SHA-1 pairs in the diff display of a submodule gitk will display the first lines of the corresponding commit messages (similar to the output of 'git submodule summary') when the underlying git installation supports this. That makes it much easier to evaluate the changes, as it eliminates the need to start a gitk inside the submodule and use the superprojects hashes there to find out what the commits are about.

This patch applies to 'next' - which will be 1.6.6 or 1.7.0 when merged - and uses the new --submodule option of git diff when a version of 1.6.6 or higher is detected to achieve a more human readable output of submodule differences in gitk.

Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
---

Thanks for the review of the first version of this patch. I tried to address all the issues raised and moved the additions of the --submodule flag to the getblobdiffs procedure, where the --textconv flag is handled too.

 gitk-git/gitk |   21 ++++++++++++++++++++-
 1 files changed, 20 insertions(+), 1 deletions(-)
Show changes to gitk-git/gitk +20 −1
diff --git a/gitk-git/gitk b/gitk-git/gitk
index a0214b7..b06cac7 100644
--- a/gitk-git/gitk
+++ b/gitk-git/gitk
@@ -7343,7 +7343,11 @@ proc getblobdiffs {ids} {
     if {[package vcompare $git_version "1.6.1"] >= 0} {
 	set textconv "--textconv"
     }
-    set cmd [diffcmd $ids "-p $textconv -C --cc --no-commit-id -U$diffcontext"]
+    set submodule {}
+    if {[package vcompare $git_version "1.6.6"] >= 0} {
+	set submodule "--submodule"
+    }
+    set cmd [diffcmd $ids "-p $textconv $submodule  -C --cc --no-commit-id -U$diffcontext"]
     if {$ignorespace} {
 	append cmd " -w"
     }
@@ -7481,6 +7485,21 @@ proc getblobdiffline {bdf ids} {
 	    set diffnparents [expr {[string length $ats] - 1}]
 	    set diffinhdr 0

+	} elseif {![string compare -length 10 "Submodule " $line]} {
+	    # start of a new submodule
+	    if {[string compare [$ctext get "end - 4c" end] "\n \n\n"]} {
+		$ctext insert end "\n";     # Add newline after commit message
+	    }
+	    set curdiffstart [$ctext index "end - 1c"]
+	    lappend ctext_file_names ""
+	    set fname [string range $line 10 [expr [string last " " $line] - 1]]
+	    lappend ctext_file_lines $fname
+	    makediffhdr $fname $ids
+	    $ctext insert end "\n$line\n" filesep
+	} elseif {![string compare -length 3 "  >" $line]} {
+	    $ctext insert end "$line\n" dresult
+	} elseif {![string compare -length 3 "  <" $line]} {
+	    $ctext insert end "$line\n" d0
 	} elseif {$diffinhdr} {
 	    if {![string compare -length 12 "rename from " $line]} {
 		set fname [string range $line [expr 6 + [string first " from " $line] ] end]

-- 
1.6.5.2.182.g3d976.dirty
Paul Mackerras· Nov 3, 2009, 11:32 UTC · re: Jens Lehmann · lore

Re: [PATCH v2] gitk: Use the --submodule option for displaying diffs when available

Jens Lehmann writes:
Show 14 quoted lines
> Instead of just showing not-quite-helpful SHA-1 pairs in the diff display
> of a submodule gitk will display the first lines of the corresponding
> commit messages (similar to the output of 'git submodule summary') when
> the underlying git installation supports this. That makes it much easier
> to evaluate the changes, as it eliminates the need to start a gitk inside
> the submodule and use the superprojects hashes there to find out what the
> commits are about.
> 
> This patch applies to 'next' - which will be 1.6.6 or 1.7.0 when merged -
> and uses the new --submodule option of git diff when a version of 1.6.6 or
> higher is detected to achieve a more human readable output of submodule
> differences in gitk.
> 
> Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
Thanks, applied.
Paul.
Junio C Hamano· Oct 28, 2009, 07:19 UTC · re: Jens Lehmann · lore

Re: [PATCH] gitk: Use the --submodule option for diffs

Jens Lehmann <Jens.Lehmann@web.de> writes:
Show 12 quoted lines
> Instead of just showing not-quite-helpful SHA-1 pairs display the first
> lines of the corresponding commit messages in the submodule (similar to
> the output of 'git submodule summary').
>
> Signed-off-by: Jens Lehmann <Jens.Lehmann@web.de>
> ---
>
> This patch applies to 'next' and uses the new --submodule option of git
> diff to achieve a more meaningful output of submodule differences in
> gitk.
>
> Any objections against making this the default?

It looks like you are not making this the default, but are making it mandatory. That's quite different.

As long as gitk ships with matching version of git, I do not think it is a huge problem to force "diff" to always run with --submodule option, but if that is what the patch does, I'd prefer to see the patch says so, instead of giving a false impression that there may be a way to disable it if one wants to.

Looking at the patched text, I had to wonder where these $flags come from. The callers of "diffcmd" give it to you, and I am not sure if all of them want -p format diffs. Specifically, what does gettreediffs do? Does it make sense to give --submodule to that invocation?

Yes, I know --submodule happens to be a no-op in non-patch format diffs, but I do not think that is by design. It is something somebody may notice and correct it later, at which time this patch will be broken.

I also suspect that this might break getpatchid, but as long as all the patches consistently change/break ids it would be Ok.

← back to recent threads