From: Jakub Narebski <jnareb@gmail.com>
To: Ramkumar Ramachandra <artagnon@gmail.com>
Cc: Git List <git@vger.kernel.org>
Subject: Re: [PATCH] Documentation: Document diff.<tool>.* and filter.<driver>.* in config
Date: Fri, 01 Apr 2011 02:18:28 -0700 (PDT) [thread overview]
Message-ID: <m3ipuy49fg.fsf@localhost.localdomain> (raw)
In-Reply-To: <1301647658-28047-1-git-send-email-artagnon@gmail.com>
Ramkumar Ramachandra <artagnon@gmail.com> writes:
> Although the gitattributes page contains comprehensive information
> about these configuration options, they should be included in the
> config documentation for completeness.
Good idea.
> +diff.<tool>.command::
> + Defines a human-readable name for a custom low-level diff
> + tool. See linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.xfuncname::
> + Defines the command that implements a custom low-level merge
> + tool. See linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.textconv::
> + Names a low-level merge tool to be used when performing an
> + internal merge between common ancestors. See
> + linkgit:gitattributes[5] for details.
> +
> +diff.<tool>.cachetextconv::
> + Names a low-level merge tool to be used when performing an
> + internal merge between common ancestors. See
> + linkgit:gitattributes[5] for details.
> +
WTF?!? You have seriously messed up matching description to config
variables.
The human readable-name for a custom diff tool or file-level (contents)
merge driver is the '<tool>' part of e.g. `diff.<tool>.command`, not the
value of said config variable.
It should IMVHO be something like this:
+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>.xfuncname::
+ Specifies a regular expression that matches a line that you
+ would want to appear as hunk header for files with `diff=<tool>`
+ gitattribute, similarly to `--show-function-line=REGEXP` option
+ of GNU 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>.cachetextconv::
+ Set to true to enable caching of text conversion. See
+ linkgit:gitattributes[5] for details.
There is also `diff.<tool>.wordRegex` to be described. And probably some
more (I didn't check which of gitattribute-related config variables are
already described).
> +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.
This one is correct.
--
Jakub Narebski
Poland
ShadeHawk on #git
next prev parent reply other threads:[~2011-04-01 9:18 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 [this message]
2011-04-01 10:43 ` [PATCH v2] " Ramkumar Ramachandra
2011-04-01 13:50 ` Jakub Narebski
2011-04-01 13:56 ` Michael J Gruber
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=m3ipuy49fg.fsf@localhost.localdomain \
--to=jnareb@gmail.com \
--cc=artagnon@gmail.com \
--cc=git@vger.kernel.org \
/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).