# [PATCH] Documentation: Describe git-gui Tools menu configuration options. 2 messages from 2008-12-14 to 2008-12-15. Participants: Alexander Gavrilov, Junio C Hamano. Thread: https://gitlist.dev/t/16728 ## Alexander Gavrilov, 2008-12-14 19:44 Subject: [PATCH] Documentation: Describe git-gui Tools menu configuration options. Message-ID: <200812142244.32438.angavrilov@gmail.com> URL: https://gitlist.dev/e/200812142244.32438.angavrilov%40gmail.com ``` 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 --- Documentation/config.txt | 51 ++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 51 insertions(+), 0 deletions(-) diff --git a/Documentation/config.txt b/Documentation/config.txt index b233fe5..2a06a3c 100644 --- a/Documentation/config.txt +++ b/Documentation/config.txt @@ -839,6 +839,57 @@ gui.blamehistoryctx:: Context` menu item is invoked from 'git gui blame'. If this variable is set to zero, the whole history is shown. +guitool..cmd:: + Specifies the shell command line to execute when the corresponding item + of the linkgit:git-gui[1] `Tools` menu is invoked. This option is + mandatory for every tool. The command is executed from the root of + the working directory, and in the environment it receives the name of + the tool as 'GIT_GUITOOL', the name of the currently selected file as + 'FILENAME', and the name of the current branch as 'CUR_BRANCH' (if + the head is detached, 'CUR_BRANCH' is empty). + +guitool..needsfile:: + Run the tool only if a diff is selected in the GUI. It guarantees + that 'FILENAME' is not empty. + +guitool..noconsole:: + Run the command silently, without creating a window to display its + output. + +guitool..norescan:: + Don't rescan the working directory for changes after the tool + finishes execution. + +guitool..confirm:: + Show a confirmation dialog before actually running the tool. + +guitool..argprompt:: + Request a string argument from the user, and pass it to the tool + through the 'ARGS' environment variable. Since requesting an + argument implies confirmation, the 'confirm' option has no effect + if this is enabled. If the option is set to 'true', 'yes', or '1', + the dialog uses a built-in generic prompt; otherwise the exact + value of the variable is used. + +guitool..revprompt:: + Request a single valid revision from the user, and set the + 'REVISION' environment variable. In other aspects this option + is similar to 'argprompt', and can be used together with it. + +guitool..revunmerged:: + Show only unmerged branches in the 'revprompt' subdialog. + This is useful for tools similar to merge or rebase, but not + for things like checkout or reset. + +guitool..title:: + Specifies the title to use for the prompt dialog. The default + is the tool name. + +guitool..prompt:: + Specifies the general prompt string to display at the top of + the dialog, before subsections for 'argprompt' and 'revprompt'. + The default value includes the actual command. + help.browser:: Specify the browser that will be used to display help in the 'web' format. See linkgit:git-help[1]. -- 1.6.0.4.30.gf4240 ``` ## Junio C Hamano, 2008-12-15 00:43 Subject: Re: [PATCH] Documentation: Describe git-gui Tools menu configuration options. Message-ID: <7vhc561d5n.fsf@gitster.siamese.dyndns.org> URL: https://gitlist.dev/e/7vhc561d5n.fsf%40gitster.siamese.dyndns.org In-Reply-To: <200812142244.32438.angavrilov@gmail.com> ``` Alexander Gavrilov writes: > Now git gui has a customizable Tools menu, so this adds > information about variables that are used to configure it. I'll apply this as-is to include in -rc3; git-gui users please proofread and send in any updates/fixes if necessary. ```