threads / patch / 45056

patchDocument the --no-gui option in difftool

Subject: [PATCH] Document the --no-gui option in difftool

## tl;dr

2 messages between Feb 6, 2017 and Feb 6, 2017. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Denton Liu· Feb 6, 2017, 03:41 UTC · lore

Prior to this, the `--no-gui` option was not documented in the manpage. This commit introduces this into the manpage

Signed-off-by: Denton Liu <liu.denton@gmail.com>
---
 Documentation/git-difftool.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Show changes to Documentation/git-difftool.txt +3 −1

diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 224fb3090..a2661d9cc 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -87,9 +87,11 @@ instead.  `--no-symlinks` is the default on Windows.
 
 -g::
 --gui::
+--no-gui::
 	When 'git-difftool' is invoked with the `-g` or `--gui` option
 	the default diff tool will be read from the configured
-	`diff.guitool` variable instead of `diff.tool`.
+	`diff.guitool` variable instead of `diff.tool`. The `--no-gui`
+	option can be used to override this setting.
 
 --[no-]trust-exit-code::
 	'git-difftool' invokes a diff tool individually on each file.

-- 
2.12.0.rc0.208.g81c5d00b2

Junio C Hamano· Feb 6, 2017, 18:53 UTC · re: Denton Liu · lore

Re: [PATCH] Document the --no-gui option in difftool

Denton Liu <liu.denton@gmail.com> writes:

Show 17 quoted lines

> diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
> index 224fb3090..a2661d9cc 100644
> --- a/Documentation/git-difftool.txt
> +++ b/Documentation/git-difftool.txt
> @@ -87,9 +87,11 @@ instead.  `--no-symlinks` is the default on Windows.
>  
>  -g::
>  --gui::
> +--no-gui::
>  	When 'git-difftool' is invoked with the `-g` or `--gui` option
>  	the default diff tool will be read from the configured
> -	`diff.guitool` variable instead of `diff.tool`.
> +	`diff.guitool` variable instead of `diff.tool`. The `--no-gui`
> +	option can be used to override this setting.
>  
>  --[no-]trust-exit-code::
>  	'git-difftool' invokes a diff tool individually on each file.

Reading the whole of this file before applying this patch, I notice that we have descriptions of negative forms only for some but not all options. "--[no-]symlinks" and "--[no-]trust-exit-code" are already there, but not this one.

Shouldn't the patch be more like

    ---gui::
    +--[no-]gui::

to be consistent with its existing friends, though?