git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 4/5] userdiff: require explicitly allowing textconv

From
Jeff King <peff@peff.net>
Date
Oct 24, 2008, 02:55 UTC
Message-ID
<20081024025553.GD2831@coredump.intra.peff.net>
In-Reply-To
<20081024024631.GA20365@coredump.intra.peff.net>

Diffs that have been produced with textconv almost certainly cannot be applied, so we want to be careful not to generate them in things like format-patch.

This introduces a new diff options, ALLOW_TEXTCONV, which controls this behavior. It is off by default, but is explicitly turned on for the "log" family of commands, as well as the "diff" porcelain.

Because both text conversion and external diffing are controlled by these diff options, we can get rid of the "plumbing versus porcelain" distinction when reading the config. This was an attempt to control the same thing, but suffered from being too coarse-grained.

Signed-off-by: Jeff King <peff@peff.net>
---
This gives us a nice run-time knob to tweak. There was a lot of
discussion last time around about exactly when text conversion should
happen. The more I think about it, I'm wondering if perhaps this should
be disabled by default, and require "git log --textconv" to activate.

Johannes, you had mentioned some heuristics. Maybe you would like to take a stab at implementing them on top of this?

 builtin-diff.c           |    1 +
 builtin-log.c            |    1 +
 diff.c                   |   24 ++++++++++--------------
 diff.h                   |    1 +
 t/t4030-diff-textconv.sh |    2 +-
 userdiff.c               |   10 +---------
 userdiff.h               |    3 +--
 7 files changed, 16 insertions(+), 26 deletions(-)
diff --git a/builtin-diff.c b/builtin-diff.c
index 9c8c295..2de5834 100644
--- a/builtin-diff.c
+++ b/builtin-diff.c
@@ -300,6 +300,7 @@ int cmd_diff(int argc, const char **argv, const char *prefix)
 	}
 	DIFF_OPT_SET(&rev.diffopt, ALLOW_EXTERNAL);
 	DIFF_OPT_SET(&rev.diffopt, RECURSIVE);
+	DIFF_OPT_SET(&rev.diffopt, ALLOW_TEXTCONV);
 
 	/*
 	 * If the user asked for our exit code then don't start a
diff --git a/builtin-log.c b/builtin-log.c
index a0944f7..75d698f 100644
--- a/builtin-log.c
+++ b/builtin-log.c
@@ -59,6 +59,7 @@ static void cmd_log_init(int argc, const char **argv, const char *prefix,
 		} else
 			die("unrecognized argument: %s", arg);
 	}
+	DIFF_OPT_SET(&rev->diffopt, ALLOW_TEXTCONV);
 }
 
 /*
diff --git a/diff.c b/diff.c
index 89bd2ff..52feba7 100644
--- a/diff.c
+++ b/diff.c
@@ -93,12 +93,6 @@ int git_diff_ui_config(const char *var, const char *value, void *cb)
 	if (!strcmp(var, "diff.external"))
 		return git_config_string(&external_diff_cmd_cfg, var, value);
 
-	switch (userdiff_config_porcelain(var, value)) {
-		case 0: break;
-		case -1: return -1;
-		default: return 0;
-	}
-
 	return git_diff_basic_config(var, value, cb);
 }
 
@@ -109,6 +103,12 @@ int git_diff_basic_config(const char *var, const char *value, void *cb)
 		return 0;
 	}
 
+	switch (userdiff_config(var, value)) {
+		case 0: break;
+		case -1: return -1;
+		default: return 0;
+	}
+
 	if (!prefixcmp(var, "diff.color.") || !prefixcmp(var, "color.diff.")) {
 		int slot = parse_diff_color_slot(var, 11);
 		if (!value)
@@ -123,12 +123,6 @@ int git_diff_basic_config(const char *var, const char *value, void *cb)
 		return 0;
 	}
 
-	switch (userdiff_config_basic(var, value)) {
-		case 0: break;
-		case -1: return -1;
-		default: return 0;
-	}
-
 	return git_color_default_config(var, value, cb);
 }
 
@@ -1409,9 +1403,11 @@ static void builtin_diff(const char *name_a,
 		}
 	}
 
-	if (diff_filespec_textconv(one) < 0 ||
-	    diff_filespec_textconv(two) < 0)
+	if (DIFF_OPT_TST(o, ALLOW_TEXTCONV)) {
+		if (diff_filespec_textconv(one) < 0 ||
+		    diff_filespec_textconv(two) < 0)
 			die("unable to read files to diff");
+	}
 
 	if (fill_mmfile(&mf1, one) < 0 || fill_mmfile(&mf2, two) < 0)
 		die("unable to read files to diff");
diff --git a/diff.h b/diff.h
index a49d865..42582ed 100644
--- a/diff.h
+++ b/diff.h
@@ -65,6 +65,7 @@ typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
 #define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
 #define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
 #define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
+#define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
 #define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
 #define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
 #define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)
diff --git a/t/t4030-diff-textconv.sh b/t/t4030-diff-textconv.sh
index 28d3640..e456746 100755
--- a/t/t4030-diff-textconv.sh
+++ b/t/t4030-diff-textconv.sh
@@ -69,7 +69,7 @@ test_expect_success 'log produces text' '
 	test_cmp expect.text actual
 '
 
-test_expect_failure 'format-patch produces binary' '
+test_expect_success 'format-patch produces binary' '
 	git format-patch --no-binary --stdout HEAD^ >patch &&
 	find_diff <patch >actual &&
 	test_cmp expect.binary actual
diff --git a/userdiff.c b/userdiff.c
index d95257a..3681062 100644
--- a/userdiff.c
+++ b/userdiff.c
@@ -120,7 +120,7 @@ static int parse_tristate(int *b, const char *k, const char *v)
 	return 1;
 }
 
-int userdiff_config_basic(const char *k, const char *v)
+int userdiff_config(const char *k, const char *v)
 {
 	struct userdiff_driver *drv;
 
@@ -130,14 +130,6 @@ int userdiff_config_basic(const char *k, const char *v)
 		return parse_funcname(&drv->funcname, k, v, REG_EXTENDED);
 	if ((drv = parse_driver(k, v, "binary")))
 		return parse_tristate(&drv->binary, k, v);
-
-	return 0;
-}
-
-int userdiff_config_porcelain(const char *k, const char *v)
-{
-	struct userdiff_driver *drv;
-
 	if ((drv = parse_driver(k, v, "command")))
 		return parse_string(&drv->external, k, v);
 	if ((drv = parse_driver(k, v, "textconv")))
diff --git a/userdiff.h b/userdiff.h
index f29c18f..ba29457 100644
--- a/userdiff.h
+++ b/userdiff.h
@@ -14,8 +14,7 @@ struct userdiff_driver {
 	const char *textconv;
 };
 
-int userdiff_config_basic(const char *k, const char *v);
-int userdiff_config_porcelain(const char *k, const char *v);
+int userdiff_config(const char *k, const char *v);
 struct userdiff_driver *userdiff_find_by_name(const char *name);
 struct userdiff_driver *userdiff_find_by_path(const char *path);
 
-- 
1.6.0.3.518.gdb328.dirty
Previous: Jeff KingNext: Johannes Sixt
Message 69 of 85 in “Implementation of a "textconv" filter for easy custom diff.”
  1. Matthieu MoySep 28, 2008
  2. Facility to have multiple kinds of drivers for diff.Matthieu Moy, Sep 28, 2008
  3. Implement run_command_to_buf (spawn a process and reads its stdout)Matthieu Moy, Sep 28, 2008
  4. Implement a textconv filter for "git diff"Matthieu Moy, Sep 28, 2008
  5. Document the textconv filter.Matthieu Moy, Sep 28, 2008
  6. Add a basic test for the textconv filter.Matthieu Moy, Sep 28, 2008
  7. Johannes SixtSep 28, 2008
  8. Matthieu MoySep 28, 2008
  9. Jeff KingSep 28, 2008
  10. Matthieu MoySep 28, 2008
  11. Jeff KingSep 28, 2008
  12. Jeff KingSep 28, 2008
  13. Matthieu MoySep 28, 2008
  14. Jeff KingSep 28, 2008
  15. Matthieu MoySep 30, 2008
  16. Jeff KingSep 30, 2008
  17. 0/4 diff text conversion filterJeff King, Oct 5, 2008
  18. 1/4 t4012: use test_cmp instead of cmpJeff King, Oct 5, 2008
  19. 2/4 diff: unify external diff and funcname parsing codeJeff King, Oct 5, 2008
  20. 3/4 diff: introduce diff.<driver>.binaryJeff King, Oct 5, 2008
  21. Johannes SixtOct 7, 2008
  22. Jeff KingOct 7, 2008
  23. Johannes SixtOct 7, 2008
  24. Junio C HamanoOct 12, 2008
  25. Jeff KingOct 13, 2008
  26. Junio C HamanoOct 13, 2008
  27. Jeff KingOct 13, 2008
  28. Johannes SixtOct 13, 2008
  29. Junio C HamanoOct 13, 2008
  30. Matthieu MoyOct 13, 2008
  31. Jeff KingOct 24, 2008
  32. 1/5 diff: add missing static declarationJeff King, Oct 24, 2008
  33. 2/5 add userdiff textconv testsJeff King, Oct 24, 2008
  34. 3/5 refactor userdiff textconv codeJeff King, Oct 24, 2008
  35. Johannes SixtOct 24, 2008
  36. Jeff KingOct 24, 2008
  37. Jeff KingOct 24, 2008
  38. Johannes SixtOct 24, 2008
  39. Jeff KingOct 24, 2008
  40. Junio C HamanoOct 24, 2008
  41. Jeff KingOct 24, 2008
  42. Jeff KingOct 24, 2008
  43. Jeff KingOct 25, 2008
  44. 1/7 diff: add missing static declarationJeff King, Oct 25, 2008
  45. 2/7 add userdiff textconv testsJeff King, Oct 25, 2008
  46. 3/7 textconv: assume text-converted contents are not binaryJeff King, Oct 25, 2008
  47. 4/7 textconv: don't convert for every operationJeff King, Oct 25, 2008
  48. Junio C HamanoOct 25, 2008
  49. Jeff KingOct 25, 2008
  50. Junio C HamanoOct 25, 2008
  51. Jeff KingOct 25, 2008
  52. Junio C HamanoOct 25, 2008
  53. Junio C HamanoOct 25, 2008
  54. Jeff KingOct 26, 2008
  55. Jeff KingOct 26, 2008
  56. 1/8 diff: add missing static declarationJeff King, Oct 26, 2008
  57. 2/8 document the diff driver textconv featureJeff King, Oct 26, 2008
  58. 3/8 add userdiff textconv testsJeff King, Oct 26, 2008
  59. 4/8 refactor userdiff textconv codeJeff King, Oct 26, 2008
  60. 5/8 userdiff: require explicitly allowing textconvJeff King, Oct 26, 2008
  61. 6/8 only textconv regular filesJeff King, Oct 26, 2008
  62. 7/8 wt-status: load diff ui configJeff King, Oct 26, 2008
  63. Junio C HamanoOct 27, 2008
  64. Jeff KingOct 27, 2008
  65. 8/8 enable textconv for diff in verbose status/commitJeff King, Oct 26, 2008
  66. 5/7 userdiff: require explicitly allowing textconvJeff King, Oct 25, 2008
  67. 6/7 document the diff driver textconv featureJeff King, Oct 25, 2008
  68. 7/7 only textconv regular filesJeff King, Oct 25, 2008
  69. 4/5 userdiff: require explicitly allowing textconvJeff King, Oct 24, 2008
  70. Johannes SixtOct 24, 2008
  71. 5/5 document the diff driver textconv featureJeff King, Oct 24, 2008
  72. Johannes SixtOct 24, 2008
  73. 4/4 diff: add filter for converting binary to textJeff King, Oct 5, 2008
  74. Jakub NarebskiOct 5, 2008
  75. Johannes SixtOct 6, 2008
  76. Jeff KingOct 6, 2008
  77. Johannes SixtOct 6, 2008
  78. Matthieu MoyOct 6, 2008
  79. Jeff KingOct 7, 2008
  80. Johannes SixtOct 7, 2008
  81. Jeff KingOct 7, 2008
  82. Matthieu MoyOct 7, 2008
  83. Jeff KingOct 7, 2008
  84. Johannes SixtOct 7, 2008
  85. Jeff KingOct 13, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.