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

[PATCH v3 4/4] cat-file: support --textconv/--filters in batch mode

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Sep 9, 2016, 10:10 UTC
Message-ID
<22debd2f58973cab5d0e1c9b7f1be4815004323a.1473415827.git.johannes.schindelin@gmx.de>
In-Reply-To
<cover.1473415827.git.johannes.schindelin@gmx.de>

With this patch, --batch can be combined with --textconv or --filters. For this to work, the input needs to have the form

	<object name><single white space><path>
so that the filters can be chosen appropriately.
Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
---
 Documentation/git-cat-file.txt | 18 +++++++++++-----
 builtin/cat-file.c             | 49 +++++++++++++++++++++++++++++++++++++-----
 t/t8010-cat-file-filters.sh    | 10 +++++++++
 3 files changed, 67 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index 4fa9041..204541c 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git cat-file' (-t [--allow-unknown-type]| -s [--allow-unknown-type]| -e | -p | <type> | --textconv | --filters ) [--path=<path>] <object>
-'git cat-file' (--batch | --batch-check) [--follow-symlinks]
+'git cat-file' (--batch | --batch-check) [ --textconv | --filters ] [--follow-symlinks]
 
 DESCRIPTION
 -----------
@@ -20,7 +20,11 @@ object type, or `-s` is used to find the object size, or `--textconv` or
 `--filters` is used (which imply type "blob").
 
 In the second form, a list of objects (separated by linefeeds) is provided on
-stdin, and the SHA-1, type, and size of each object is printed on stdout.
+stdin, and the SHA-1, type, and size of each object is printed on stdout. The
+output format can be overridden using the optional `<format>` argument. If
+either `--textconv` or `--filters` was specified, the input is expected to
+list the object names followed by the path name, separated by a single white
+space, so that the appropriate drivers can be determined.
 
 OPTIONS
 -------
@@ -72,13 +76,17 @@ OPTIONS
 --batch::
 --batch=<format>::
 	Print object information and contents for each object provided
-	on stdin.  May not be combined with any other options or arguments.
-	See the section `BATCH OUTPUT` below for details.
+	on stdin.  May not be combined with any other options or arguments
+	except `--textconv` or `--filters`, in which case the input lines
+	also need to specify the path, separated by white space.  See the
+	section `BATCH OUTPUT` below for details.
 
 --batch-check::
 --batch-check=<format>::
 	Print object information for each object provided on stdin.  May
-	not be combined with any other options or arguments.  See the
+	not be combined with any other options or arguments except
+	`--textconv` or `--filters`, in which case the input lines also
+	need to specify the path, separated by white space.  See the
 	section `BATCH OUTPUT` below for details.
 
 --batch-all-objects::
diff --git a/builtin/cat-file.c b/builtin/cat-file.c
index b648056..4461153 100644
--- a/builtin/cat-file.c
+++ b/builtin/cat-file.c
@@ -17,6 +17,7 @@ struct batch_options {
 	int print_contents;
 	int buffer_output;
 	int all_objects;
+	int cmdmode; /* may be 'w' or 'c' for --filters or --textconv */
 	const char *format;
 };
 
@@ -285,7 +286,32 @@ static void print_object_or_die(struct batch_options *opt, struct expand_data *d
 	if (data->type == OBJ_BLOB) {
 		if (opt->buffer_output)
 			fflush(stdout);
-		if (stream_blob_to_fd(1, sha1, NULL, 0) < 0)
+		if (opt->cmdmode) {
+			char *contents;
+			unsigned long size;
+
+			if (!data->rest)
+				die("missing path for '%s'", sha1_to_hex(sha1));
+
+			if (opt->cmdmode == 'w') {
+				if (filter_object(data->rest, 0100644, sha1,
+						  &contents, &size))
+					die("could not convert '%s' %s",
+					    sha1_to_hex(sha1), data->rest);
+			} else if (opt->cmdmode == 'c') {
+				enum object_type type;
+				if (!textconv_object(data->rest, 0100644, sha1,
+						     1, &contents, &size))
+					contents = read_sha1_file(sha1, &type,
+								  &size);
+				if (!contents)
+					die("could not convert '%s' %s",
+					    sha1_to_hex(sha1), data->rest);
+			} else
+				die("BUG: invalid cmdmode: %c", opt->cmdmode);
+			batch_write(opt, contents, size);
+			free(contents);
+		} else if (stream_blob_to_fd(1, sha1, NULL, 0) < 0)
 			die("unable to stream %s to stdout", sha1_to_hex(sha1));
 	}
 	else {
@@ -422,6 +448,8 @@ static int batch_objects(struct batch_options *opt)
 	data.mark_query = 1;
 	strbuf_expand(&buf, opt->format, expand_format, &data);
 	data.mark_query = 0;
+	if (opt->cmdmode)
+		data.split_on_whitespace = 1;
 
 	if (opt->all_objects) {
 		struct object_info empty;
@@ -487,7 +515,7 @@ static int batch_objects(struct batch_options *opt)
 
 static const char * const cat_file_usage[] = {
 	N_("git cat-file (-t [--allow-unknown-type]|-s [--allow-unknown-type]|-e|-p|<type>|--textconv|--filters) [--path=<path>] <object>"),
-	N_("git cat-file (--batch | --batch-check) [--follow-symlinks]"),
+	N_("git cat-file (--batch | --batch-check) [--follow-symlinks] [--textconv|--filters]"),
 	NULL
 };
 
@@ -558,7 +586,9 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix)
 	argc = parse_options(argc, argv, prefix, options, cat_file_usage, 0);
 
 	if (opt) {
-		if (argc == 1)
+		if (batch.enabled && (opt == 'c' || opt == 'w'))
+			batch.cmdmode = opt;
+		else if (argc == 1)
 			obj_name = argv[0];
 		else
 			usage_with_options(cat_file_usage, options);
@@ -570,8 +600,12 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix)
 		} else
 			usage_with_options(cat_file_usage, options);
 	}
-	if (batch.enabled && (opt || argc)) {
-		usage_with_options(cat_file_usage, options);
+	if (batch.enabled) {
+		if (batch.cmdmode != opt || argc)
+			usage_with_options(cat_file_usage, options);
+		if (batch.cmdmode && batch.all_objects)
+			die("--batch-all-objects cannot be combined with "
+			    "--textconv nor with --filters");
 	}
 
 	if ((batch.follow_symlinks || batch.all_objects) && !batch.enabled) {
@@ -583,6 +617,11 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix)
 		usage_with_options(cat_file_usage, options);
 	}
 
+	if (force_path && batch.enabled) {
+		error("--path=<path> incompatible with --batch");
+		usage_with_options(cat_file_usage, options);
+	}
+
 	if (batch.buffer_output < 0)
 		batch.buffer_output = batch.all_objects;
 
diff --git a/t/t8010-cat-file-filters.sh b/t/t8010-cat-file-filters.sh
index 0d5c33e..acdfa09 100755
--- a/t/t8010-cat-file-filters.sh
+++ b/t/t8010-cat-file-filters.sh
@@ -51,4 +51,14 @@ test_expect_success '----path=<path> complains without --textconv/--filters' '
 	grep "path.*needs.*filters" err
 '
 
+test_expect_success 'cat-file --textconv --batch works' '
+	sha1=$(git rev-parse -q --verify HEAD:world.txt) &&
+	test_config diff.txt.textconv "tr A-Za-z N-ZA-Mn-za-m <" &&
+	printf "%s hello.txt\n%s hello\n" $sha1 $sha1 |
+	git cat-file --textconv --batch >actual &&
+	printf "%s blob 6\nuryyb\r\n\n%s blob 6\nhello\n\n" \
+		$sha1 $sha1 >expect &&
+	test_cmp expect actual
+'
+
 test_done

-- 
2.10.0.windows.1.10.g803177d
Previous: Johannes SchindelinNext: Johannes Schindelin
Message 58 of 66 in “cat-file: optionally convert to worktree version”
  1. 0/4 cat-file: optionally convert to worktree versionJohannes Schindelin, Aug 18, 2016
  2. 3/4 cat-file --textconv/--filters: allow specifying the path separatelyJohannes Schindelin, Aug 18, 2016
  3. Junio C HamanoAug 18, 2016
  4. Johannes SchindelinAug 19, 2016
  5. Junio C HamanoAug 19, 2016
  6. Johannes SchindelinAug 24, 2016
  7. 2/4 cat-file: introduce the --filters optionJohannes Schindelin, Aug 18, 2016
  8. Junio C HamanoAug 18, 2016
  9. Johannes SchindelinAug 19, 2016
  10. Torsten BögershausenAug 18, 2016
  11. Johannes SchindelinAug 19, 2016
  12. Junio C HamanoAug 19, 2016
  13. Torsten BögershausenAug 19, 2016
  14. Johannes SchindelinAug 19, 2016
  15. Junio C HamanoAug 19, 2016
  16. Torsten BögershausenAug 22, 2016
  17. Johannes SchindelinAug 24, 2016
  18. 4/4 cat-file: support --textconv/--filters in batch modeJohannes Schindelin, Aug 18, 2016
  19. Junio C HamanoAug 18, 2016
  20. Johannes SchindelinAug 19, 2016
  21. Jeff KingAug 19, 2016
  22. Jeff KingAug 18, 2016
  23. Junio C HamanoAug 18, 2016
  24. Johannes SchindelinAug 19, 2016
  25. Johannes SchindelinAug 19, 2016
  26. Jeff KingAug 19, 2016
  27. Torsten BögershausenAug 18, 2016
  28. Johannes SchindelinAug 19, 2016
  29. Jeff KingAug 19, 2016
  30. Junio C HamanoAug 19, 2016
  31. 1/4 cat-file: fix a grammo in the man pageJohannes Schindelin, Aug 18, 2016
  32. Junio C HamanoAug 18, 2016
  33. 0/4 cat-file: optionally convert to worktree versionJohannes Schindelin, Aug 24, 2016
  34. 4/4 cat-file: support --textconv/--filters in batch modeJohannes Schindelin, Aug 24, 2016
  35. 2/4 cat-file: introduce the --filters optionJohannes Schindelin, Aug 24, 2016
  36. Junio C HamanoAug 24, 2016
  37. Junio C HamanoAug 24, 2016
  38. Johannes SchindelinAug 31, 2016
  39. Junio C HamanoAug 31, 2016
  40. 1/4 cat-file: fix a grammo in the man pageJohannes Schindelin, Aug 24, 2016
  41. 3/4 cat-file --textconv/--filters: allow specifying the path separatelyJohannes Schindelin, Aug 24, 2016
  42. Junio C HamanoAug 24, 2016
  43. Junio C HamanoAug 24, 2016
  44. Johannes SchindelinAug 31, 2016
  45. Junio C HamanoAug 31, 2016
  46. Junio C HamanoAug 24, 2016
  47. Jeff KingAug 24, 2016
  48. Junio C HamanoAug 24, 2016
  49. Jeff KingAug 24, 2016
  50. Junio C HamanoAug 24, 2016
  51. Junio C HamanoAug 29, 2016
  52. Johannes SchindelinAug 31, 2016
  53. 0/4 cat-file: optionally convert to worktree versionJohannes Schindelin, Sep 9, 2016
  54. 1/4 cat-file: fix a grammo in the man pageJohannes Schindelin, Sep 9, 2016
  55. 3/4 cat-file --textconv/--filters: allow specifying the path separatelyJohannes Schindelin, Sep 9, 2016
  56. Junio C HamanoSep 9, 2016
  57. Johannes SchindelinSep 10, 2016
  58. 4/4 cat-file: support --textconv/--filters in batch modeJohannes Schindelin, Sep 9, 2016
  59. 2/4 cat-file: introduce the --filters optionJohannes Schindelin, Sep 9, 2016
  60. Junio C HamanoSep 9, 2016
  61. Johannes SchindelinSep 9, 2016
  62. Junio C HamanoSep 9, 2016
  63. Junio C HamanoSep 9, 2016
  64. Junio C HamanoSep 9, 2016
  65. Johannes SchindelinSep 10, 2016
  66. Junio C HamanoSep 11, 2016

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.