[PATCH v4 0/3] builtin/ls-files.c:add git ls-file --dedup option

["阿德烈 via GitGitGadget" <gitgitgadget@gmail.com>]

I am reading the source code of git ls-files and learned that git ls-files
may have duplicate files name when there are unmerged path in a branch merge
or when different options are used at the same time. Users may fell confuse
when they see these duplicate file names.

As Junio C Hamano said ,it have odd behaviour.

Therefore, we can provide an additional option to git ls-files to delete
those repeated information.

This fixes https://github.com/gitgitgadget/git/issues/198

Thanks!

ZheNing Hu (3):
  ls_files.c: bugfix for --deleted and --modified
  ls_files.c: consolidate two for loops into one
  ls-files: add --deduplicate option

 Documentation/git-ls-files.txt |  5 +++
 builtin/ls-files.c             | 82 +++++++++++++++++++---------------
 t/t3012-ls-files-dedup.sh      | 57 +++++++++++++++++++++++
 3 files changed, 109 insertions(+), 35 deletions(-)
 create mode 100755 t/t3012-ls-files-dedup.sh


base-commit: 6d3ef5b467eccd2769f1aa1c555d317d3c8dc707
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-832%2Fadlternative%2Fls-files-dedup-v4
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-832/adlternative/ls-files-dedup-v4
Pull-Request: https://github.com/gitgitgadget/git/pull/832

Range-diff vs v3:

 -:  ----------- > 1:  f4d9af8a312 ls_files.c: bugfix for --deleted and --modified
 -:  ----------- > 2:  50efd9b45b1 ls_files.c: consolidate two for loops into one
 1:  5ce52c8b7a4 ! 3:  0c7830d07db ls-files.c: add --dedup option
     @@ Metadata
      Author: ZheNing Hu <adlternative@gmail.com>
      
       ## Commit message ##
     -    ls-files.c: add --dedup option
     +    ls-files: add --deduplicate option
      
          In order to provide users a better experience
          when viewing information about files in the index
     -    and the working tree, the `--dedup` option will suppress
     -    some duplicate options under some conditions.
     +    and the working tree, the `--deduplicate` option will suppress
     +    some duplicate name under some conditions.
      
     -    In a merge conflict, one item of "git ls-files" output may
     -    appear multiple times. For example,now the file `a.c` has
     -    a conflict,`a.c` will appear three times in the output of
     -    "git ls-files".We can use "git ls-files --dedup" to output
     +    In a merge conflict, one file name of "git ls-files" output may
     +    appear multiple times. For example,now there is an unmerged path
     +    `a.c`,`a.c` will appear three times in the output of
     +    "git ls-files".We can use "git ls-files --deduplicate" to output
          `a.c` only one time.(unless `--stage` or `--unmerged` is
          used to view all the detailed information in the index)
      
     -    In addition, if you use both `--delete` and `--modify` in
     -    the same time, The `--dedup` option can also suppress modified
     -    entries output.
     +    In addition, if you use both `--delete` and `--modify` at
     +    the same time, The `--deduplicate` option
     +    can also suppress file name output.
      
     -    `--dedup` option relevant descriptions in
     -    `Documentation/git-ls-files.txt`,
     -    the test script in `t/t3012-ls-files-dedup.sh`
     -    prove the correctness of the `--dedup` option.
     -
     -    this patch fixed:
     -    https://github.com/gitgitgadget/git/issues/198
     -    Thanks.
     +    Additional instructions:
     +    In order to display entries information,`deduplicate` suppresses
     +    the output of duplicate file names, not the output of duplicate
     +    entries information, so under the option of `-t`, `--stage`, `--unmerge`,
     +    `--deduplicate` will have no effect.
      
          Signed-off-by: ZheNing Hu <adlternative@gmail.com>
      
     @@ Documentation/git-ls-files.txt: SYNOPSIS
       		(--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
       		(-[c|d|o|i|s|u|k|m])*
       		[--eol]
     -+		[--dedup]
     ++		[--deduplicate]
       		[-x <pattern>|--exclude=<pattern>]
       		[-X <file>|--exclude-from=<file>]
       		[--exclude-per-directory=<file>]
     @@ Documentation/git-ls-files.txt: OPTIONS
       	\0 line termination on output and do not quote filenames.
       	See OUTPUT below for more information.
       
     -+--dedup::
     -+	Suppress duplicate entries when conflict happen or `--deleted`
     -+	and `--modified` are combined.
     ++--deduplicate::
     ++	Suppress duplicate entries when there are unmerged paths in index
     ++	or `--deleted` and `--modified` are combined.
      +
       -x <pattern>::
       --exclude=<pattern>::
     @@ builtin/ls-files.c: static int line_terminator = '\n';
       static int debug_mode;
       static int show_eol;
       static int recurse_submodules;
     -+static int delete_dup;
     ++static int skipping_duplicates;
       
       static const char *prefix;
       static int max_prefix_len;
     @@ builtin/ls-files.c: static void show_files(struct repository *repo, struct dir_s
       {
       	int i;
       	struct strbuf fullname = STRBUF_INIT;
     -+	const struct cache_entry *last_stage = NULL;
     ++	const struct cache_entry *last_shown_ce;
       
       	/* For cached/deleted files we don't need to even do the readdir */
       	if (show_others || show_killed) {
      @@ builtin/ls-files.c: static void show_files(struct repository *repo, struct dir_struct *dir)
     - 		for (i = 0; i < repo->index->cache_nr; i++) {
     - 			const struct cache_entry *ce = repo->index->cache[i];
     - 
     -+			if (show_cached && delete_dup) {
     -+				switch (ce_stage(ce)) {
     -+				case 0:
     -+				default:
     -+					break;
     -+				case 1:
     -+				case 2:
     -+				case 3:
     -+					if (last_stage &&
     -+					!strcmp(last_stage->name, ce->name))
     -+						continue;
     -+					last_stage = ce;
     -+				}
     -+			}
     - 			construct_fullname(&fullname, repo, ce);
     - 
     - 			if ((dir->flags & DIR_SHOW_IGNORED) &&
     + 	}
     + 	if (! (show_cached || show_stage || show_deleted || show_modified))
     + 		return;
     ++	last_shown_ce = NULL;
     + 	for (i = 0; i < repo->index->cache_nr; i++) {
     + 		const struct cache_entry *ce = repo->index->cache[i];
     + 		struct stat st;
      @@ builtin/ls-files.c: static void show_files(struct repository *repo, struct dir_struct *dir)
     - 			struct stat st;
     - 			int err;
       
     -+			if (delete_dup) {
     -+				switch (ce_stage(ce)) {
     -+				case 0:
     -+				default:
     -+					break;
     -+				case 1:
     -+				case 2:
     -+				case 3:
     -+					if (last_stage &&
     -+					!strcmp(last_stage->name, ce->name))
     -+						continue;
     -+					last_stage = ce;
     -+				}
     -+			}
     - 			construct_fullname(&fullname, repo, ce);
     + 		construct_fullname(&fullname, repo, ce);
       
     - 			if ((dir->flags & DIR_SHOW_IGNORED) &&
     -@@ builtin/ls-files.c: static void show_files(struct repository *repo, struct dir_struct *dir)
     - 			if (ce_skip_worktree(ce))
     - 				continue;
     - 			err = lstat(fullname.buf, &st);
     --			if (show_deleted && err)
     -+			if (delete_dup && show_deleted && show_modified && err)
     - 				show_ce(repo, dir, ce, fullname.buf, tag_removed);
     --			if (show_modified && ie_modified(repo->index, ce, &st, 0))
     --				show_ce(repo, dir, ce, fullname.buf, tag_modified);
     ++		if (skipping_duplicates && last_shown_ce &&
     ++			!strcmp(last_shown_ce->name,ce->name))
     ++				continue;
     + 		if ((dir->flags & DIR_SHOW_IGNORED) &&
     + 			!ce_excluded(dir, repo->index, fullname.buf, ce))
     + 			continue;
     + 		if (ce->ce_flags & CE_UPDATE)
     + 			continue;
     + 		if (show_cached || show_stage) {
     ++			if (show_cached && skipping_duplicates && last_shown_ce &&
     ++				!strcmp(last_shown_ce->name,ce->name))
     ++					continue;
     + 			if (!show_unmerged || ce_stage(ce))
     + 				show_ce(repo, dir, ce, fullname.buf,
     + 					ce_stage(ce) ? tag_unmerged :
     + 					(ce_skip_worktree(ce) ? tag_skip_worktree :
     + 						tag_cached));
     ++			if(show_cached && skipping_duplicates)
     ++				last_shown_ce = ce;
     + 		}
     + 		if (ce_skip_worktree(ce))
     + 			continue;
     ++		if (skipping_duplicates && last_shown_ce && !strcmp(last_shown_ce->name,ce->name))
     ++			continue;
     + 		err = lstat(fullname.buf, &st);
     + 		if (err) {
     ++			if (skipping_duplicates && show_deleted && show_modified)
     ++				show_ce(repo, dir, ce, fullname.buf, tag_removed);
      +			else {
     -+				if (show_deleted && err)
     -+					show_ce(repo, dir, ce, fullname.buf, tag_removed);
     -+				if (show_modified && ie_modified(repo->index, ce, &st, 0))
     -+					show_ce(repo, dir, ce, fullname.buf, tag_modified);
     + 				if (show_deleted)
     + 					show_ce(repo, dir, ce, fullname.buf, tag_removed);
     + 				if (show_modified)
     + 					show_ce(repo, dir, ce, fullname.buf, tag_modified);
     +-		}else if (show_modified && ie_modified(repo->index, ce, &st, 0))
      +			}
     - 		}
     ++		} else if (show_modified && ie_modified(repo->index, ce, &st, 0))
     + 			show_ce(repo, dir, ce, fullname.buf, tag_modified);
     ++		last_shown_ce = ce;
       	}
       
     + 	strbuf_release(&fullname);
      @@ builtin/ls-files.c: int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
       			N_("pretend that paths removed since <tree-ish> are still present")),
       		OPT__ABBREV(&abbrev),
       		OPT_BOOL(0, "debug", &debug_mode, N_("show debugging data")),
     -+		OPT_BOOL(0, "dedup", &delete_dup, N_("suppress duplicate entries")),
     ++		OPT_BOOL(0,"deduplicate",&skipping_duplicates,N_("suppress duplicate entries")),
       		OPT_END()
       	};
       
     +@@ builtin/ls-files.c: int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix)
     + 		tag_skip_worktree = "S ";
     + 		tag_resolve_undo = "U ";
     + 	}
     ++	if (show_tag && skipping_duplicates)
     ++		skipping_duplicates = 0;
     + 	if (show_modified || show_others || show_deleted || (dir.flags & DIR_SHOW_IGNORED) || show_killed)
     + 		require_work_tree = 1;
     + 	if (show_unmerged)
      
       ## t/t3012-ls-files-dedup.sh (new) ##
      @@
      +#!/bin/sh
      +
     -+test_description='git ls-files --dedup test.
     -+
     -+This test prepares the following in the cache:
     -+
     -+    a.txt       - a file(base)
     -+    a.txt	- a file(master)
     -+    a.txt       - a file(dev)
     -+    b.txt       - a file
     -+    delete.txt  - a file
     -+    expect1	- a file
     -+    expect2	- a file
     -+
     -+'
     ++test_description='git ls-files --deduplicate test'
      +
      +. ./test-lib.sh
      +
      +test_expect_success 'setup' '
     -+	> a.txt &&
     -+	> b.txt &&
     -+	> delete.txt &&
     -+	cat >expect1<<-\EOF &&
     -+	M a.txt
     -+	H b.txt
     -+	H delete.txt
     -+	H expect1
     -+	H expect2
     -+	EOF
     -+	cat >expect2<<-EOF &&
     -+	C a.txt
     -+	R delete.txt
     -+	EOF
     -+	git add a.txt b.txt delete.txt expect1 expect2 &&
     ++	>a.txt &&
     ++	>b.txt &&
     ++	>delete.txt &&
     ++	git add a.txt b.txt delete.txt &&
      +	git commit -m master:1 &&
     -+	echo a>a.txt &&
     -+	echo b>b.txt &&
     ++	echo a >a.txt &&
     ++	echo b >b.txt &&
      +	echo delete >delete.txt &&
      +	git add a.txt b.txt delete.txt &&
      +	git commit -m master:2 &&
      +	git checkout HEAD~ &&
      +	git switch -c dev &&
     ++	test_when_finished "git switch master" &&
      +	echo change >a.txt &&
      +	git add a.txt &&
      +	git commit -m dev:1 &&
      +	test_must_fail git merge master &&
     -+	git ls-files -t --dedup >actual1 &&
     -+	test_cmp expect1 actual1 &&
     ++	git ls-files --deduplicate >actual &&
     ++	cat >expect <<-\EOF &&
     ++	a.txt
     ++	b.txt
     ++	delete.txt
     ++	EOF
     ++	test_cmp expect actual &&
      +	rm delete.txt &&
     -+	git ls-files -d -m -t --dedup >actual2 &&
     -+	test_cmp expect2 actual2
     ++	git ls-files -d -m --deduplicate >actual &&
     ++	cat >expect <<-\EOF &&
     ++	a.txt
     ++	delete.txt
     ++	EOF
     ++	test_cmp expect actual &&
     ++	git ls-files -d -m -t  --deduplicate >actual &&
     ++	cat >expect <<-\EOF &&
     ++	C a.txt
     ++	C a.txt
     ++	C a.txt
     ++	R delete.txt
     ++	C delete.txt
     ++	EOF
     ++	test_cmp expect actual &&
     ++	git ls-files -d -m -c  --deduplicate >actual &&
     ++	cat >expect <<-\EOF &&
     ++	a.txt
     ++	b.txt
     ++	delete.txt
     ++	EOF
     ++	test_cmp expect actual &&
     ++	git merge --abort
      +'
     -+
      +test_done

-- 
gitgitgadget