Skip to contentSkip to conversation

gitk: add "Hightlight commit name" menu entry

PATCH In review Raphael Gallais-Pou 3 participants 6 messages Jan 30, 2024 – Mar 25, 2024

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gitk: add "Hightlight commit name" menu entry

When working with diverged branches, some patches can appear several times on different branches without having the need to merge those branches. On the other hand you may have to port a specific patch on another branch you are working on. The search with a SHA1 cannot be applied here since they would differ.

This patch adds an entry in the main context menu to highlight every instance of a commit.

---
 gitk-git/gitk | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)
gitk-git/gitk +20 -3
index 7a087f123d..4b15230a16 100755
@@ -2672,6 +2672,7 @@ proc makewindow {} {
         {mc "Make patch" command mkpatch}
         {mc "Create tag" command mktag}
         {mc "Copy commit reference" command copyreference}
+	{mc "Highlight commit name" command highlightcommitname}
         {mc "Write commit to file" command writecommit}
         {mc "Create new branch" command mkbranch}
         {mc "Cherry-pick this commit" command cherrypick}
@@ -9002,13 +9003,13 @@ proc rowmenu {x y id} {
     if {$id ne $nullid && $id ne $nullid2} {
         set menu $rowctxmenu
         if {$mainhead ne {}} {
-            $menu entryconfigure 8 -label [mc "Reset %s branch to here" $mainhead] -state normal
+            $menu entryconfigure 9 -label [mc "Reset %s branch to here" $mainhead] -state normal
         } else {
-            $menu entryconfigure 8 -label [mc "Detached head: can't reset" $mainhead] -state disabled
+            $menu entryconfigure 9 -label [mc "Detached head: can't reset" $mainhead] -state disabled
         }
-        $menu entryconfigure 10 -state $mstate
         $menu entryconfigure 11 -state $mstate
         $menu entryconfigure 12 -state $mstate
+        $menu entryconfigure 13 -state $mstate
     } else {
         set menu $fakerowmenu
     }
@@ -9481,6 +9482,22 @@ proc copyreference {} {
     clipboard append $reference
 }
 
+proc highlightcommitname {} {
+    global rowmenuid autosellen findstring gdttype
+
+    set format "%s"
+    set cmd [list git show -s --pretty=format:$format --date=short]
+    if {$autosellen < 40} {
+        lappend cmd --abbrev=$autosellen
+    }
+    set reference [eval exec $cmd $rowmenuid]
+    set findstring $reference
+    set gdttype [mc "containing:"]
+
+    clipboard clear
+    clipboard append $reference
+}
+
 proc writecommit {} {
     global rowmenuid wrcomtop commitinfo wrcomcmd NS
 
Signature · 1 line
2.43.0
#1 lore raw

Hi,

Gentle ping since I haven't received any reviews or comment on this patch. :)

Do you guys actually take patches for the gitk tool ? I feel like there is not much features added on this.

Regards,
Raphaël

Le 30/01/2024 à 09:53, Raphael Gallais-Pou a écrit :

Quoted 66 lines

When working with diverged branches, some patches can appear several times on different branches without having the need to merge those branches. On the other hand you may have to port a specific patch on another branch you are working on. The search with a SHA1 cannot be applied here since they would differ.

This patch adds an entry in the main context menu to highlight every instance of a commit.

---
  gitk-git/gitk | 23 ++++++++++++++++++++---
  1 file changed, 20 insertions(+), 3 deletions(-)
gitk-git/gitk +20 -3
index 7a087f123d..4b15230a16 100755
@@ -2672,6 +2672,7 @@ proc makewindow {} {
          {mc "Make patch" command mkpatch}
          {mc "Create tag" command mktag}
          {mc "Copy commit reference" command copyreference}
+	{mc "Highlight commit name" command highlightcommitname}
          {mc "Write commit to file" command writecommit}
          {mc "Create new branch" command mkbranch}
          {mc "Cherry-pick this commit" command cherrypick}
@@ -9002,13 +9003,13 @@ proc rowmenu {x y id} {
      if {$id ne $nullid && $id ne $nullid2} {
          set menu $rowctxmenu
          if {$mainhead ne {}} {
-            $menu entryconfigure 8 -label [mc "Reset %s branch to here" $mainhead] -state normal
+            $menu entryconfigure 9 -label [mc "Reset %s branch to here" $mainhead] -state normal
          } else {
-            $menu entryconfigure 8 -label [mc "Detached head: can't reset" $mainhead] -state disabled
+            $menu entryconfigure 9 -label [mc "Detached head: can't reset" $mainhead] -state disabled
          }
-        $menu entryconfigure 10 -state $mstate
          $menu entryconfigure 11 -state $mstate
          $menu entryconfigure 12 -state $mstate
+        $menu entryconfigure 13 -state $mstate
      } else {
          set menu $fakerowmenu
      }
@@ -9481,6 +9482,22 @@ proc copyreference {} {
      clipboard append $reference
  }
 
+proc highlightcommitname {} {
+    global rowmenuid autosellen findstring gdttype
+
+    set format "%s"
+    set cmd [list git show -s --pretty=format:$format --date=short]
+    if {$autosellen < 40} {
+        lappend cmd --abbrev=$autosellen
+    }
+    set reference [eval exec $cmd $rowmenuid]
+    set findstring $reference
+    set gdttype [mc "containing:"]
+
+    clipboard clear
+    clipboard append $reference
+}
+
  proc writecommit {} {
      global rowmenuid wrcomtop commitinfo wrcomcmd NS
 
#2 lore raw
In reply to Raphael Gallais-Pou
Quoted 8 lines · Raphael Gallais-Pou

When working with diverged branches, some patches can appear several times on different branches without having the need to merge those branches. On the other hand you may have to port a specific patch on another branch you are working on. The search with a SHA1 cannot be applied here since they would differ.

This patch adds an entry in the main context menu to highlight every instance of a commit.

Thanks for working on gitk!

Unfortunately, I don't understand the description of your new option. How is this different from the existing "Find containing:" feature? Gitk can already highlights commits that match a specified string. Please explain what gitk does when this new option is selected.

Also, please explain how your code identifies "every instance" of a commit. When I think of a "commit instance" I think of the "git patch-id" command, which I don't see here.

(It looks to me like this is basically a shortcut to auto-fill gitk's "containing:" field with the subject line of the selected commit?)

Quoted 10 lines
---
  gitk-git/gitk | 23 ++++++++++++++++++++---
  1 file changed, 20 insertions(+), 3 deletions(-)
gitk-git/gitk +0 -0
index 7a087f123d..4b15230a16 100755

gitk-git/gitk proc makewindow {} { · line 2675

Quoted 4 lines
gitk-git/gitk +1 -0
@@ -2672,6 +2672,7 @@ proc makewindow {} {
          {mc "Make patch" command mkpatch}
          {mc "Create tag" command mktag}
          {mc "Copy commit reference" command copyreference}
+	{mc "Highlight commit name" command highlightcommitname}

This line is indented with a tab, but it should use spaces.

Quoted 21 lines
gitk-git/gitk +3 -3
          {mc "Write commit to file" command writecommit}
          {mc "Create new branch" command mkbranch}
          {mc "Cherry-pick this commit" command cherrypick}
@@ -9002,13 +9003,13 @@ proc rowmenu {x y id} {
      if {$id ne $nullid && $id ne $nullid2} {
          set menu $rowctxmenu
          if {$mainhead ne {}} {
-            $menu entryconfigure 8 -label [mc "Reset %s branch to here" $mainhead] -state normal
+            $menu entryconfigure 9 -label [mc "Reset %s branch to here" $mainhead] -state normal
          } else {
-            $menu entryconfigure 8 -label [mc "Detached head: can't reset" $mainhead] -state disabled
+            $menu entryconfigure 9 -label [mc "Detached head: can't reset" $mainhead] -state disabled
          }
-        $menu entryconfigure 10 -state $mstate
          $menu entryconfigure 11 -state $mstate
          $menu entryconfigure 12 -state $mstate
+        $menu entryconfigure 13 -state $mstate
      } else {
          set menu $fakerowmenu
      }

gitk-git/gitk proc copyreference {} { · line 9489

Quoted 8 lines
gitk-git/gitk +5 -0
@@ -9481,6 +9482,22 @@ proc copyreference {} {
      clipboard append $reference
  }
 
+proc highlightcommitname {} {
+    global rowmenuid autosellen findstring gdttype
+
+    set format "%s"
+    set cmd [list git show -s --pretty=format:$format --date=short]

Why bother with the $format variable here? Couldn't you just quote the --pretty part?

	"--pretty=format:%s"

(FYI, I am not a TCL/TK coder.)

		M.
Quoted 14 lines
gitk-git/gitk +11 -0
+    if {$autosellen < 40} {
+        lappend cmd --abbrev=$autosellen
+    }
+    set reference [eval exec $cmd $rowmenuid]
+    set findstring $reference
+    set gdttype [mc "containing:"]
+
+    clipboard clear
+    clipboard append $reference
+}
+
  proc writecommit {} {
      global rowmenuid wrcomtop commitinfo wrcomcmd NS
 
#3 lore raw

Hi Marc,

Le 21/03/2024 à 16:51, Marc Branchaud a écrit :

Quoted 11 lines · Raphael Gallais-Pou
Quoted 8 lines

When working with diverged branches, some patches can appear several times on different branches without having the need to merge those branches. On the other hand you may have to port a specific patch on another branch you are working on. The search with a SHA1 cannot be applied here since they would differ.

This patch adds an entry in the main context menu to highlight every instance of a commit.

Quoted 6 lines

Thanks for working on gitk!

Unfortunately, I don't understand the description of your new option. How is this different from the existing "Find containing:" feature? Gitk can already highlights commits that match a specified string. Please explain what gitk does when this new option is selected.

Also, please explain how your code identifies "every instance" of a commit.  When I think of a "commit instance" I think of the "git patch-id" command, which I don't see here.

It is based on the name of the commit. I agree that it is not ideal since the name can change between two versions.

As you stated below it is exactly a shortcut, and now that we are talking about it I think this is not the right right approach to do what I want.

I was not aware of the 'git patch-id' command, but this it clearly a better idea to base the search of the commit instances on it.

One thing that I wonder is that 'git patch-id' seems to be based on standard input. This means that in order to highlight every instances of a commit the algorithm would need to parse each and every patch and then proceed to hash them and compare to the one referenced.

Wouldn't it be a tad long to process ?

Quoted 8 lines

(It looks to me like this is basically a shortcut to auto-fill gitk's "containing:" field with the subject line of the selected commit?)

Quoted 5 lines

---
  gitk-git/gitk | 23 ++++++++++++++++++++---

  1 file changed, 20 insertions(+), 3 deletions(-)
Quoted 11 lines

gitk-git/gitk proc makewindow {} { · line 2675

Quoted 9 lines
gitk-git/gitk +1 -0
index 7a087f123d..4b15230a16 100755
@@ -2672,6 +2672,7 @@ proc makewindow {} {
           {mc "Make patch" command mkpatch}
           {mc "Create tag" command mktag}
           {mc "Copy commit reference" command copyreference}
+    {mc "Highlight commit name" command highlightcommitname}

This line is indented with a tab, but it should use spaces.

I will change my setup to use spaces instead of tabs one this file.

Quoted 30 lines
Quoted 30 lines
gitk-git/gitk +0 -0
           {mc "Write commit to file" command writecommit}
           {mc "Create new branch" command mkbranch}
           {mc "Cherry-pick this commit" command cherrypick}
@@ -9002,13 +9003,13 @@ proc rowmenu {x y id} {
       if {$id ne $nullid && $id ne $nullid2} {

          set menu $rowctxmenu
          if {$mainhead ne {}} {
-            $menu entryconfigure 8 -label [mc "Reset %s branch to here" $mainhead] -state normal
+            $menu entryconfigure 9 -label [mc "Reset %s branch to here" $mainhead] -state normal
          } else {
-            $menu entryconfigure 8 -label [mc "Detached head: can't reset" $mainhead] -state disabled
+            $menu entryconfigure 9 -label [mc "Detached head: can't reset" $mainhead] -state disabled
          }
-        $menu entryconfigure 10 -state $mstate
          $menu entryconfigure 11 -state $mstate
          $menu entryconfigure 12 -state $mstate
+        $menu entryconfigure 13 -state $mstate
      } else {
          set menu $fakerowmenu
      }

gitk-git/gitk +0 -0
@@ -9481,6 +9482,22 @@ proc copyreference {} {

      clipboard append $reference
  }
+proc highlightcommitname {} {
+    global rowmenuid autosellen findstring gdttype

Quoted 8 lines
Quoted 3 lines

+
+    set format "%s"
+    set cmd [list git show -s --pretty=format:$format --date=short]

Why bother with the $format variable here?  Couldn't you just quote the --pretty part?
    "--pretty=format:%s"
(FYI, I am not a TCL/TK coder.)

I also am not a TCL developer. I pretty much duplicated the copyreference{} procedure to get what I wanted.

Best regards,
Raphaël

Quoted 16 lines

        M.

Quoted 13 lines

+    if {$autosellen < 40} {
+        lappend cmd --abbrev=$autosellen
+    }
+    set reference [eval exec $cmd $rowmenuid]
+    set findstring $reference
+    set gdttype [mc "containing:"]

gitk-git/gitk +5 -0
+
+    clipboard clear
+    clipboard append $reference
+}
+

  proc writecommit {} {
      global rowmenuid wrcomtop commitinfo wrcomcmd NS

#4 lore raw
Quoted 14 lines · Raphaël Gallais-Pou

Hi Marc,

Le 21/03/2024 à 16:51, Marc Branchaud a écrit :

Quoted 11 lines · Raphael Gallais-Pou
Quoted 8 lines

When working with diverged branches, some patches can appear several times on different branches without having the need to merge those branches. On the other hand you may have to port a specific patch on another branch you are working on. The search with a SHA1 cannot be applied here since they would differ.

This patch adds an entry in the main context menu to highlight every instance of a commit.

Quoted 8 lines
Quoted 6 lines

Thanks for working on gitk!

Unfortunately, I don't understand the description of your new option. How is this different from the existing "Find containing:" feature? Gitk can already highlights commits that match a specified string. Please explain what gitk does when this new option is selected.

Also, please explain how your code identifies "every instance" of a commit.  When I think of a "commit instance" I think of the "git patch-id" command, which I don't see here.

It is based on the name of the commit. I agree that it is not ideal since the name can change between two versions.

Thanks for clarifying that.

(BTW, on this list we pronounce "the name of the commit" as "the commit subject (line)".)

Quoted 7 lines

As you stated below it is exactly a shortcut, and now that we are talking about it I think this is not the right right approach to do what I want.

I was not aware of the 'git patch-id' command, but this it clearly a better idea to base the search of the commit instances on it.

One thing that I wonder is that 'git patch-id' seems to be based on standard input. This means that in order to highlight every instances of a commit the algorithm would need to parse each and every patch and then proceed to hash them and compare to the one referenced.

Wouldn't it be a tad long to process ?

Absolutely. Maybe "git cherry" would be more appropriate?

		M.
Quoted 79 lines
Quoted 7 lines

(It looks to me like this is basically a shortcut to auto-fill gitk's "containing:" field with the subject line of the selected commit?)

Quoted 5 lines

---
  gitk-git/gitk | 23 ++++++++++++++++++++---

  1 file changed, 20 insertions(+), 3 deletions(-)
Quoted 11 lines

gitk-git/gitk proc makewindow {} { · line 2675

Quoted 9 lines
gitk-git/gitk +1 -0
index 7a087f123d..4b15230a16 100755
@@ -2672,6 +2672,7 @@ proc makewindow {} {
           {mc "Make patch" command mkpatch}
           {mc "Create tag" command mktag}
           {mc "Copy commit reference" command copyreference}
+    {mc "Highlight commit name" command highlightcommitname}

This line is indented with a tab, but it should use spaces.

I will change my setup to use spaces instead of tabs one this file.

Quoted 29 lines
Quoted 29 lines
gitk-git/gitk +0 -0
           {mc "Write commit to file" command writecommit}
           {mc "Create new branch" command mkbranch}
           {mc "Cherry-pick this commit" command cherrypick}
@@ -9002,13 +9003,13 @@ proc rowmenu {x y id} {
       if {$id ne $nullid && $id ne $nullid2} {

          set menu $rowctxmenu
          if {$mainhead ne {}} {
-            $menu entryconfigure 8 -label [mc "Reset %s branch to here" $mainhead] -state normal
+            $menu entryconfigure 9 -label [mc "Reset %s branch to here" $mainhead] -state normal
          } else {
-            $menu entryconfigure 8 -label [mc "Detached head: can't reset" $mainhead] -state disabled
+            $menu entryconfigure 9 -label [mc "Detached head: can't reset" $mainhead] -state disabled
          }
-        $menu entryconfigure 10 -state $mstate
          $menu entryconfigure 11 -state $mstate
          $menu entryconfigure 12 -state $mstate
+        $menu entryconfigure 13 -state $mstate
      } else {
          set menu $fakerowmenu
      }

gitk-git/gitk +0 -0
@@ -9481,6 +9482,22 @@ proc copyreference {} {

      clipboard append $reference
  }
+proc highlightcommitname {} {

Quoted 8 lines
Quoted 4 lines

+    global rowmenuid autosellen findstring gdttype
+
+    set format "%s"
+    set cmd [list git show -s --pretty=format:$format --date=short]

Why bother with the $format variable here?  Couldn't you just quote the --pretty part? "--pretty=format:%s"
(FYI, I am not a TCL/TK coder.)

I also am not a TCL developer. I pretty much duplicated the copyreference{} procedure to get what I wanted.

Best regards,
Raphaël

Quoted 16 lines

         M.

Quoted 13 lines

+    if {$autosellen < 40} {
+        lappend cmd --abbrev=$autosellen
+    }
+    set reference [eval exec $cmd $rowmenuid]
+    set findstring $reference
+    set gdttype [mc "containing:"]

gitk-git/gitk +5 -0
+
+    clipboard clear
+    clipboard append $reference
+}
+

  proc writecommit {} {
      global rowmenuid wrcomtop commitinfo wrcomcmd NS

#5 lore raw
Quoted 2 lines · Marc Branchaud

(BTW, on this list we pronounce "the name of the commit" as "the commit subject (line)".)

Yup. "subject" probably comes from the fact that the title (the first paragraph, folded into a single line) of the commit is used on the "Subject:" header when formatted for e-mail submission, and also 's' in "git log --pretty='%s'" is described as "subject" in the documentation. Other words I've seen used are "commit title" and "oneline description", but "subject" would be the most common, I suspect.

"commit name" on the other hand brings a different concept, i.e., "the commit object name", more strongly to readers' minds, and can be mistaken as what you'd get in "git log --pretty='%H'".