Skip to content

Commit 390c348

Browse files
angavrilovgitster
authored andcommitted
Documentation: Describe git-gui Tools menu configuration options.
Now git gui has a customizable Tools menu, so this adds information about variables that are used to configure it. Signed-off-by: Alexander Gavrilov <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2fad532 commit 390c348

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

Documentation/config.txt

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,57 @@ gui.blamehistoryctx::
839839
Context` menu item is invoked from 'git gui blame'. If this
840840
variable is set to zero, the whole history is shown.
841841

842+
guitool.<name>.cmd::
843+
Specifies the shell command line to execute when the corresponding item
844+
of the linkgit:git-gui[1] `Tools` menu is invoked. This option is
845+
mandatory for every tool. The command is executed from the root of
846+
the working directory, and in the environment it receives the name of
847+
the tool as 'GIT_GUITOOL', the name of the currently selected file as
848+
'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if
849+
the head is detached, 'CUR_BRANCH' is empty).
850+
851+
guitool.<name>.needsfile::
852+
Run the tool only if a diff is selected in the GUI. It guarantees
853+
that 'FILENAME' is not empty.
854+
855+
guitool.<name>.noconsole::
856+
Run the command silently, without creating a window to display its
857+
output.
858+
859+
guitool.<name>.norescan::
860+
Don't rescan the working directory for changes after the tool
861+
finishes execution.
862+
863+
guitool.<name>.confirm::
864+
Show a confirmation dialog before actually running the tool.
865+
866+
guitool.<name>.argprompt::
867+
Request a string argument from the user, and pass it to the tool
868+
through the 'ARGS' environment variable. Since requesting an
869+
argument implies confirmation, the 'confirm' option has no effect
870+
if this is enabled. If the option is set to 'true', 'yes', or '1',
871+
the dialog uses a built-in generic prompt; otherwise the exact
872+
value of the variable is used.
873+
874+
guitool.<name>.revprompt::
875+
Request a single valid revision from the user, and set the
876+
'REVISION' environment variable. In other aspects this option
877+
is similar to 'argprompt', and can be used together with it.
878+
879+
guitool.<name>.revunmerged::
880+
Show only unmerged branches in the 'revprompt' subdialog.
881+
This is useful for tools similar to merge or rebase, but not
882+
for things like checkout or reset.
883+
884+
guitool.<name>.title::
885+
Specifies the title to use for the prompt dialog. The default
886+
is the tool name.
887+
888+
guitool.<name>.prompt::
889+
Specifies the general prompt string to display at the top of
890+
the dialog, before subsections for 'argprompt' and 'revprompt'.
891+
The default value includes the actual command.
892+
842893
help.browser::
843894
Specify the browser that will be used to display help in the
844895
'web' format. See linkgit:git-help[1].

0 commit comments

Comments
 (0)