From: Michael J Gruber <git@drmicha.warpmail.net>
To: Ramkumar Ramachandra <artagnon@gmail.com>
Cc: Git list <git@vger.kernel.org>, Jakub Narebski <jnareb@gmail.com>
Subject: Re: [PATCH v2] Documentation: Document diff.<tool>.* and filter.<driver>.* in config
Date: Fri, 01 Apr 2011 15:56:32 +0200 [thread overview]
Message-ID: <4D95D990.1050306@drmicha.warpmail.net> (raw)
In-Reply-To: <1301654600-8901-1-git-send-email-artagnon@gmail.com>
Ramkumar Ramachandra venit, vidit, dixit 01.04.2011 12:43:
> Although the gitattributes page contains comprehensive information
> about these configuration options, they should be included in the
> config documentation for completeness.
>
> Helped-by: Jakub Narebski <jnareb@gmail.com>
> Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
> ---
> The first iteration of this patch contained completely wrong
> descriptions for diff.<tool>.* options. Thanks to Jakub for pointing
> them out, and for pointing out that I left out a a few options
> undocumented (found in userdiff.c).
>
> Documentation/config.txt | 46 ++++++++++++++++++++++++++++++++++++++++++++++
> 1 files changed, 46 insertions(+), 0 deletions(-)
>
> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index 8ea55d4..b2ec4e1 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -875,6 +875,42 @@ diff.tool::
> the same valid values as `merge.tool` minus "tortoisemerge"
> and plus "kompare".
>
> +diff.<tool>.command::
> + Defines command to be called to generate diff for files with
> + `diff=<tool>` gitattribute. See linkgit:gitattributes[5] for
> + details.
> +
> +diff.<tool>.funcname::
> + Specifies a regular expression that matches a line to use as
> + the hunk header for files with `diff=<tool>` gitattribute. A
> + built-in pattern may also be used. See
> + linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.xfuncname::
> + Same as 'diff.<tool>.funcname', except that an extended
> + regular expression can be specified in this case.
> +
> +diff.<tool>.binary::
> + Set to true to treat files files with `diff=<tool>`
> + gitattribute as binary for the purposes of diff. See
> + linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.textconv::
> + Defines command to be called to generate text-converted version
> + of a binary file with `diff=<tool>` gitattribute. The result of
> + the conversion is used to generate human-readable diff. See
> + linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.wordregex::
> + Specifies the regular expression to use to customize the rules
> + that `git diff --word-diff` uses to split words in a line.
> + See linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.cachetextconv::
> + Set to true to enable caching of text conversion outputs for
> + files with `diff=<tool>` gitattribute. See
> + linkgit:gitattributes[5] for details.
> +
I am sorry, but I dislike this for several reasons. First, the wording:
"to use to customize" and the like are no fun to read, and there are
several articles missing.
More importantly: Those config options are not about difftools! Having
diff.<tool>.* before difftool.* is grossly misleading. The options above
are all about external diff drivers. So, diff.<driver>.* would be
appropriate here, esp. when looking at merge.*
> difftool.<tool>.path::
> Override the path for the given tool. This is useful in case
> your tool is not in the PATH.
> @@ -973,6 +1009,16 @@ format.signoff::
> the rights to submit this work under the same open source license.
> Please see the 'SubmittingPatches' document for further discussion.
>
> +filter.<driver>.clean::
> + Defines the command to be used to convert the contents of
> + worktree file upon checkin. See linkgit:gitattributes[5] for
> + details.
> +
> +filter.<driver>.smudge::
> + Defines the command to be used to convert the blob object to
> + worktree file upon checkout. See linkgit:gitattributes[5] for
> + details.
> +
> gc.aggressiveWindow::
> The window size parameter used in the delta compression
> algorithm used by 'git gc --aggressive'. This defaults
next prev parent reply other threads:[~2011-04-01 14:00 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-04-01 8:47 [PATCH] Documentation: Document diff.<tool>.* and filter.<driver>.* in config Ramkumar Ramachandra
2011-04-01 9:18 ` Jakub Narebski
2011-04-01 10:43 ` [PATCH v2] " Ramkumar Ramachandra
2011-04-01 13:50 ` Jakub Narebski
2011-04-01 13:56 ` Michael J Gruber [this message]
2011-04-03 14:25 ` [PATCH v3 0/3] Document diff and filter drivers " Ramkumar Ramachandra
2011-04-03 14:25 ` [PATCH 1/3] Documentation: Add filter.<driver>.* to config Ramkumar Ramachandra
2011-04-04 8:46 ` Michael J Gruber
2011-04-03 14:25 ` [PATCH 2/3] Documentation: Add diff.<driver>.* " Ramkumar Ramachandra
2011-04-04 8:54 ` Michael J Gruber
2011-04-04 17:24 ` Junio C Hamano
2011-04-03 14:25 ` [PATCH 3/3] Documentation: Allow custom diff tools to be specified in 'diff.tool' Ramkumar Ramachandra
2011-04-04 8:55 ` Michael J Gruber
2011-04-06 9:57 ` [PATCH v4 0/4] Document diff and filter drivers in config Ramkumar Ramachandra
2011-04-06 9:57 ` [PATCH 1/4] Documentation: Add filter.<driver>.* to config Ramkumar Ramachandra
2011-04-06 11:27 ` Michael J Gruber
2011-04-06 12:51 ` Ramkumar Ramachandra
2011-04-06 16:50 ` Junio C Hamano
2011-04-06 18:09 ` Ramkumar Ramachandra
2011-04-07 11:57 ` Michael J Gruber
2011-04-07 16:19 ` Ramkumar Ramachandra
2011-04-06 9:57 ` [PATCH 2/4] Documentation: Add diff.<driver>.* " Ramkumar Ramachandra
2011-04-06 9:57 ` [PATCH 3/4] Documentation: Allow custom diff tools to be specified in 'diff.tool' Ramkumar Ramachandra
2011-04-06 9:57 ` [PATCH 4/4] Documentation: Minor language improvements to merge-config Ramkumar Ramachandra
2011-04-06 18:46 ` [PATCH v5 0/4] Document diff and filter drivers in config Ramkumar Ramachandra
2011-04-06 18:46 ` [PATCH 1/4] Documentation: Add filter.<driver>.* to config Ramkumar Ramachandra
2011-04-06 18:46 ` [PATCH 2/4] Documentation: Add diff.<driver>.* " Ramkumar Ramachandra
2011-04-06 19:48 ` Junio C Hamano
2011-04-07 3:03 ` Ramkumar Ramachandra
2011-04-06 18:46 ` [PATCH 3/4] Documentation: Allow custom diff tools to be specified in 'diff.tool' Ramkumar Ramachandra
2011-04-06 18:46 ` [PATCH 4/4] Documentation: Minor language improvements to merge-config Ramkumar Ramachandra
2011-04-07 12:47 ` [PATCH v4 0/4] Document diff and filter drivers in config Michael J Gruber
2011-04-07 12:48 ` Michael J Gruber
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4D95D990.1050306@drmicha.warpmail.net \
--to=git@drmicha.warpmail.net \
--cc=artagnon@gmail.com \
--cc=git@vger.kernel.org \
--cc=jnareb@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).