git-gui: Offer quick access to the HTML formatted documentation.
[gitweb.git] / git-gui.sh
index 0982da569045afae4ec1059816cefa71c30fcbb8..c168826ecc4559de0f569b5794b5f83ce49a0a87 100755 (executable)
@@ -60,6 +60,17 @@ proc is_many_config {name} {
        }
 }
 
+proc is_config_true {name} {
+       global repo_config
+       if {[catch {set v $repo_config($name)}]} {
+               return 0
+       } elseif {$v eq {true} || $v eq {1} || $v eq {yes}} {
+               return 1
+       } else {
+               return 0
+       }
+}
+
 proc load_config {include_global} {
        global repo_config global_config default_config
 
@@ -187,13 +198,13 @@ proc warn_popup {msg} {
        eval $cmd
 }
 
-proc info_popup {msg} {
+proc info_popup {msg {parent .}} {
        set title [appname]
        if {[reponame] ne {}} {
                append title " ([reponame])"
        }
        tk_messageBox \
-               -parent . \
+               -parent $parent \
                -icon info \
                -type ok \
                -title $title \
@@ -983,8 +994,8 @@ proc commit_tree {} {
        global HEAD commit_type file_states ui_comm repo_config
        global ui_status_value pch_error
 
-       if {![lock_index update]} return
        if {[committer_ident] eq {}} return
+       if {![lock_index update]} return
 
        # -- Our in memory state should match the repository.
        #
@@ -2129,16 +2140,19 @@ proc do_delete_branch {} {
                -font font_ui
        listbox $w.list.l \
                -height 10 \
-               -width 50 \
+               -width 70 \
                -selectmode extended \
+               -yscrollcommand [list $w.list.sby set] \
                -font font_ui
        foreach h $all_heads {
                if {$h ne $current_branch} {
                        $w.list.l insert end $h
                }
        }
-       pack $w.list.l -fill both -pady 5 -padx 5
-       pack $w.list -fill both -pady 5 -padx 5
+       scrollbar $w.list.sby -command [list $w.list.l yview]
+       pack $w.list.sby -side right -fill y
+       pack $w.list.l -side left -fill both -expand 1
+       pack $w.list -fill both -expand 1 -pady 5 -padx 5
 
        labelframe $w.validate \
                -text {Delete Only If} \
@@ -2510,8 +2524,9 @@ proc do_push_anywhere {} {
                -font font_ui
        listbox $w.source.l \
                -height 10 \
-               -width 50 \
+               -width 70 \
                -selectmode extended \
+               -yscrollcommand [list $w.source.sby set] \
                -font font_ui
        foreach h $all_heads {
                $w.source.l insert end $h
@@ -2519,8 +2534,10 @@ proc do_push_anywhere {} {
                        $w.source.l select set end
                }
        }
-       pack $w.source.l -fill both -pady 5 -padx 5
-       pack $w.source -fill both -pady 5 -padx 5
+       scrollbar $w.source.sby -command [list $w.source.l yview]
+       pack $w.source.sby -side right -fill y
+       pack $w.source.l -side left -fill both -expand 1
+       pack $w.source -fill both -expand 1 -pady 5 -padx 5
 
        labelframe $w.dest \
                -text {Destination Repository} \
@@ -2591,6 +2608,293 @@ proc do_push_anywhere {} {
        tkwait window $w
 }
 
+######################################################################
+##
+## merge
+
+proc can_merge {} {
+       global HEAD commit_type file_states
+
+       if {[string match amend* $commit_type]} {
+               info_popup {Cannot merge while amending.
+
+You must finish amending this commit before
+starting any type of merge.
+}
+               return 0
+       }
+
+       if {[committer_ident] eq {}} {return 0}
+       if {![lock_index merge]} {return 0}
+
+       # -- Our in memory state should match the repository.
+       #
+       repository_state curType curHEAD curMERGE_HEAD
+       if {$commit_type ne $curType || $HEAD ne $curHEAD} {
+               info_popup {Last scanned state does not match repository state.
+
+Another Git program has modified this repository
+since the last scan.  A rescan must be performed
+before a merge can be performed.
+
+The rescan will be automatically started now.
+}
+               unlock_index
+               rescan {set ui_status_value {Ready.}}
+               return 0
+       }
+
+       foreach path [array names file_states] {
+               switch -glob -- [lindex $file_states($path) 0] {
+               _O {
+                       continue; # and pray it works!
+               }
+               U? {
+                       error_popup "You are in the middle of a conflicted merge.
+
+File [short_path $path] has merge conflicts.
+
+You must resolve them, add the file, and commit to
+complete the current merge.  Only then can you
+begin another merge.
+"
+                       unlock_index
+                       return 0
+               }
+               ?? {
+                       error_popup "You are in the middle of a change.
+
+File [short_path $path] is modified.
+
+You should complete the current commit before
+starting a merge.  Doing so will help you abort
+a failed merge, should the need arise.
+"
+                       unlock_index
+                       return 0
+               }
+               }
+       }
+
+       return 1
+}
+
+proc visualize_local_merge {w} {
+       set revs {}
+       foreach i [$w.source.l curselection] {
+               lappend revs [$w.source.l get $i]
+       }
+       if {$revs eq {}} return
+       lappend revs --not HEAD
+       do_gitk $revs
+}
+
+proc start_local_merge_action {w} {
+       global HEAD ui_status_value current_branch
+
+       set cmd [list git merge]
+       set names {}
+       set revcnt 0
+       foreach i [$w.source.l curselection] {
+               set b [$w.source.l get $i]
+               lappend cmd $b
+               lappend names $b
+               incr revcnt
+       }
+
+       if {$revcnt == 0} {
+               return
+       } elseif {$revcnt == 1} {
+               set unit branch
+       } elseif {$revcnt <= 15} {
+               set unit branches
+       } else {
+               tk_messageBox \
+                       -icon error \
+                       -type ok \
+                       -title [wm title $w] \
+                       -parent $w \
+                       -message "Too many branches selected.
+
+You have requested to merge $revcnt branches
+in an octopus merge.  This exceeds Git's
+internal limit of 15 branches per merge.
+
+Please select fewer branches.  To merge more
+than 15 branches, merge the branches in batches.
+"
+               return
+       }
+
+       set msg "Merging $current_branch, [join $names {, }]"
+       set ui_status_value "$msg..."
+       set cons [new_console "Merge" $msg]
+       console_exec $cons $cmd [list finish_merge $revcnt]
+       bind $w <Destroy> {}
+       destroy $w
+}
+
+proc finish_merge {revcnt w ok} {
+       console_done $w $ok
+       if {$ok} {
+               set msg {Merge completed successfully.}
+       } else {
+               if {$revcnt != 1} {
+                       info_popup "Octopus merge failed.
+
+Your merge of $revcnt branches has failed.
+
+There are file-level conflicts between the
+branches which must be resolved manually.
+
+The working directory will now be reset.
+
+You can attempt this merge again
+by merging only one branch at a time." $w
+
+                       set fd [open "| git read-tree --reset -u HEAD" r]
+                       fconfigure $fd -blocking 0 -translation binary
+                       fileevent $fd readable [list reset_hard_wait $fd]
+                       set ui_status_value {Aborting... please wait...}
+                       return
+               }
+
+               set msg {Merge failed.  Conflict resolution is required.}
+       }
+       unlock_index
+       rescan [list set ui_status_value $msg]
+}
+
+proc do_local_merge {} {
+       global current_branch
+
+       if {![can_merge]} return
+
+       set w .merge_setup
+       toplevel $w
+       wm geometry $w "+[winfo rootx .]+[winfo rooty .]"
+
+       label $w.header \
+               -text "Merge Into $current_branch" \
+               -font font_uibold
+       pack $w.header -side top -fill x
+
+       frame $w.buttons
+       button $w.buttons.visualize -text Visualize \
+               -font font_ui \
+               -command [list visualize_local_merge $w]
+       pack $w.buttons.visualize -side left
+       button $w.buttons.create -text Merge \
+               -font font_ui \
+               -command [list start_local_merge_action $w]
+       pack $w.buttons.create -side right
+       button $w.buttons.cancel -text {Cancel} \
+               -font font_ui \
+               -command [list destroy $w]
+       pack $w.buttons.cancel -side right -padx 5
+       pack $w.buttons -side bottom -fill x -pady 10 -padx 10
+
+       labelframe $w.source \
+               -text {Source Branches} \
+               -font font_ui
+       listbox $w.source.l \
+               -height 10 \
+               -width 70 \
+               -selectmode extended \
+               -yscrollcommand [list $w.source.sby set] \
+               -font font_ui
+       scrollbar $w.source.sby -command [list $w.source.l yview]
+       pack $w.source.sby -side right -fill y
+       pack $w.source.l -side left -fill both -expand 1
+       pack $w.source -fill both -expand 1 -pady 5 -padx 5
+
+       set cmd [list git for-each-ref]
+       lappend cmd {--format=%(objectname) %(refname)}
+       lappend cmd refs/heads
+       lappend cmd refs/remotes
+       set fr_fd [open "| $cmd" r]
+       fconfigure $fr_fd -translation binary
+       while {[gets $fr_fd line] > 0} {
+               set line [split $line { }]
+               set sha1([lindex $line 0]) [lindex $line 1]
+       }
+       close $fr_fd
+
+       set to_show {}
+       set fr_fd [open "| git rev-list --all --not HEAD"]
+       while {[gets $fr_fd line] > 0} {
+               if {[catch {set ref $sha1($line)}]} continue
+               regsub ^refs/(heads|remotes)/ $ref {} ref
+               lappend to_show $ref
+       }
+       close $fr_fd
+
+       foreach ref [lsort -unique $to_show] {
+               $w.source.l insert end $ref
+       }
+
+       bind $w <Visibility> "grab $w"
+       bind $w <Key-Escape> "unlock_index;destroy $w"
+       bind $w <Destroy> unlock_index
+       wm title $w "[appname] ([reponame]): Merge"
+       tkwait window $w
+}
+
+proc do_reset_hard {} {
+       global HEAD commit_type file_states
+
+       if {[string match amend* $commit_type]} {
+               info_popup {Cannot abort while amending.
+
+You must finish amending this commit.
+}
+               return
+       }
+
+       if {![lock_index abort]} return
+
+       if {[string match *merge* $commit_type]} {
+               set op merge
+       } else {
+               set op commit
+       }
+
+       if {[ask_popup "Abort $op?
+
+Aborting the current $op will cause
+*ALL* uncommitted changes to be lost.
+
+Continue with aborting the current $op?"] eq {yes}} {
+               set fd [open "| git read-tree --reset -u HEAD" r]
+               fconfigure $fd -blocking 0 -translation binary
+               fileevent $fd readable [list reset_hard_wait $fd]
+               set ui_status_value {Aborting... please wait...}
+       } else {
+               unlock_index
+       }
+}
+
+proc reset_hard_wait {fd} {
+       global ui_comm
+
+       read $fd
+       if {[eof $fd]} {
+               close $fd
+               unlock_index
+
+               $ui_comm delete 0.0 end
+               $ui_comm edit modified false
+
+               catch {file delete [gitdir MERGE_HEAD]}
+               catch {file delete [gitdir rr-cache MERGE_RR]}
+               catch {file delete [gitdir SQUASH_MSG]}
+               catch {file delete [gitdir MERGE_MSG]}
+               catch {file delete [gitdir GITGUI_MSG]}
+
+               rescan {set ui_status_value {Abort completed.  Ready.}}
+       }
+}
+
 ######################################################################
 ##
 ## icons
@@ -3462,52 +3766,59 @@ proc do_options {} {
        pack $w.repo -side left -fill both -expand 1 -pady 5 -padx 5
        pack $w.global -side right -fill both -expand 1 -pady 5 -padx 5
 
+       set optid 0
        foreach option {
-               {b pullsummary {Show Pull Summary}}
-               {b trustmtime  {Trust File Modification Timestamps}}
-               {i diffcontext {Number of Diff Context Lines}}
-               {t newbranchtemplate {New Branch Name Template}}
+               {b merge.summary {Summarize Merge Commits}}
+               {i-1..5 merge.verbosity {Merge Verbosity}}
+
+               {b gui.trustmtime  {Trust File Modification Timestamps}}
+               {i-1..99 gui.diffcontext {Number of Diff Context Lines}}
+               {t gui.newbranchtemplate {New Branch Name Template}}
                } {
                set type [lindex $option 0]
                set name [lindex $option 1]
                set text [lindex $option 2]
+               incr optid
                foreach f {repo global} {
-                       switch $type {
+                       switch -glob -- $type {
                        b {
-                               checkbutton $w.$f.$name -text $text \
-                                       -variable ${f}_config_new(gui.$name) \
+                               checkbutton $w.$f.$optid -text $text \
+                                       -variable ${f}_config_new($name) \
                                        -onvalue true \
                                        -offvalue false \
                                        -font font_ui
-                               pack $w.$f.$name -side top -anchor w
+                               pack $w.$f.$optid -side top -anchor w
                        }
-                       i {
-                               frame $w.$f.$name
-                               label $w.$f.$name.l -text "$text:" -font font_ui
-                               pack $w.$f.$name.l -side left -anchor w -fill x
-                               spinbox $w.$f.$name.v \
-                                       -textvariable ${f}_config_new(gui.$name) \
-                                       -from 1 -to 99 -increment 1 \
-                                       -width 3 \
+                       i-* {
+                               regexp -- {-(\d+)\.\.(\d+)$} $type _junk min max
+                               frame $w.$f.$optid
+                               label $w.$f.$optid.l -text "$text:" -font font_ui
+                               pack $w.$f.$optid.l -side left -anchor w -fill x
+                               spinbox $w.$f.$optid.v \
+                                       -textvariable ${f}_config_new($name) \
+                                       -from $min \
+                                       -to $max \
+                                       -increment 1 \
+                                       -width [expr {1 + [string length $max]}] \
                                        -font font_ui
-                               bind $w.$f.$name.v <FocusIn> {%W selection range 0 end}
-                               pack $w.$f.$name.v -side right -anchor e -padx 5
-                               pack $w.$f.$name -side top -anchor w -fill x
+                               bind $w.$f.$optid.v <FocusIn> {%W selection range 0 end}
+                               pack $w.$f.$optid.v -side right -anchor e -padx 5
+                               pack $w.$f.$optid -side top -anchor w -fill x
                        }
                        t {
-                               frame $w.$f.$name
-                               label $w.$f.$name.l -text "$text:" -font font_ui
-                               entry $w.$f.$name.v \
+                               frame $w.$f.$optid
+                               label $w.$f.$optid.l -text "$text:" -font font_ui
+                               entry $w.$f.$optid.v \
                                        -borderwidth 1 \
                                        -relief sunken \
                                        -width 20 \
-                                       -textvariable ${f}_config_new(gui.$name) \
+                                       -textvariable ${f}_config_new($name) \
                                        -font font_ui
-                               pack $w.$f.$name.l -side left -anchor w
-                               pack $w.$f.$name.v -side left -anchor w \
+                               pack $w.$f.$optid.l -side left -anchor w
+                               pack $w.$f.$optid.v -side left -anchor w \
                                        -fill x -expand 1 \
                                        -padx 5
-                               pack $w.$f.$name -side top -anchor w -fill x
+                               pack $w.$f.$optid -side top -anchor w -fill x
                        }
                        }
                }
@@ -3838,8 +4149,9 @@ proc apply_config {} {
        }
 }
 
+set default_config(merge.summary) false
+set default_config(merge.verbosity) 2
 set default_config(gui.trustmtime) false
-set default_config(gui.pullsummary) true
 set default_config(gui.diffcontext) 5
 set default_config(gui.newbranchtemplate) {}
 set default_config(gui.fontui) [font configure font_ui]
@@ -3865,6 +4177,7 @@ if {!$single_commit} {
 }
 .mbar add cascade -label Commit -menu .mbar.commit
 if {!$single_commit} {
+       .mbar add cascade -label Merge -menu .mbar.merge
        .mbar add cascade -label Fetch -menu .mbar.fetch
        .mbar add cascade -label Push -menu .mbar.push
 }
@@ -4039,17 +4352,6 @@ lappend disable_on_lock \
 lappend disable_on_lock \
        [list .mbar.commit entryconf [.mbar.commit index last] -state]
 
-# -- Transport menus
-#
-if {!$single_commit} {
-       menu .mbar.fetch
-       menu .mbar.push
-
-       .mbar.push add command -label {Push...} \
-               -command do_push_anywhere \
-               -font font_ui
-}
-
 if {[is_MacOSX]} {
        # -- Apple Menu (Mac OS X only)
        #
@@ -4099,17 +4401,57 @@ if {[is_MacOSX]} {
        lappend disable_on_lock \
                [list .mbar.tools entryconf [.mbar.tools index last] -state]
        }
+}
 
-       # -- Help Menu
-       #
-       .mbar add cascade -label Help -menu .mbar.help
-       menu .mbar.help
+# -- Help Menu
+#
+.mbar add cascade -label Help -menu .mbar.help
+menu .mbar.help
 
+if {![is_MacOSX]} {
        .mbar.help add command -label "About [appname]" \
                -command do_about \
                -font font_ui
 }
 
+set browser {}
+catch {set browser $repo_config(instaweb.browser)}
+set doc_path [file dirname [exec git --exec-path]]
+set doc_path [file join $doc_path Documentation index.html]
+
+if {[is_Windows]} {
+       set doc_path [exec cygpath --windows $doc_path]
+}
+
+if {$browser eq {}} {
+       if {[is_MacOSX]} {
+               set browser open
+       } elseif {[is_Windows]} {
+               set program_files [file dirname [exec cygpath --windir]]
+               set program_files [file join $program_files {Program Files}]
+               set firefox [file join $program_files {Mozilla Firefox} firefox.exe]
+               set ie [file join $program_files {Internet Explorer} IEXPLORE.EXE]
+               if {[file exists $firefox]} {
+                       set browser $firefox
+               } elseif {[file exists $ie]} {
+                       set browser $ie
+               }
+               unset program_files firefox ie
+       }
+}
+
+if {[file isfile $doc_path]} {
+       set doc_url "file:$doc_path"
+} else {
+       set doc_url {http://www.kernel.org/pub/software/scm/git/docs/}
+}
+
+if {$browser ne {}} {
+       .mbar.help add command -label {Online Documentation} \
+               -command [list exec $browser $doc_url &] \
+               -font font_ui
+}
+unset browser doc_path doc_url
 
 # -- Branch Control
 #
@@ -4130,6 +4472,28 @@ pack .branch.l1 -side left
 pack .branch.cb -side left -fill x
 pack .branch -side top -fill x
 
+if {!$single_commit} {
+       menu .mbar.merge
+       .mbar.merge add command -label {Local Merge...} \
+               -command do_local_merge \
+               -font font_ui
+       lappend disable_on_lock \
+               [list .mbar.merge entryconf [.mbar.merge index last] -state]
+       .mbar.merge add command -label {Abort Merge...} \
+               -command do_reset_hard \
+               -font font_ui
+       lappend disable_on_lock \
+               [list .mbar.merge entryconf [.mbar.merge index last] -state]
+
+
+       menu .mbar.fetch
+
+       menu .mbar.push
+       .mbar.push add command -label {Push...} \
+               -command do_push_anywhere \
+               -font font_ui
+}
+
 # -- Main Window Layout
 #
 panedwindow .vpane -orient vertical