From: ZheNing Hu <adlternative@xxxxxxxxx> Because sometimes we want to check if the files in the index match the sparse specification, so introduce "%(skipworktree)" atom to git ls-files `--format` option. When we use this option, if the file match the sparse specification, it will output "1", otherwise, output empty string "". Signed-off-by: ZheNing Hu <adlternative@xxxxxxxxx> --- Documentation/git-ls-files.txt | 4 ++++ builtin/ls-files.c | 3 +++ t/t3013-ls-files-format.sh | 16 ++++++++++++++++ 3 files changed, 23 insertions(+) diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 440043cdb8e..4902c311927 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -260,6 +260,10 @@ eolattr:: that applies to the path. path:: The pathname of the file which is recorded in the index. +skipworktree:: + Whether the file in the index has the SKIP_WORKTREE bit set. + See link:technical/sparse-checkout.txt[sparse-checkout] + for more information. EXCLUDE PATTERNS ---------------- diff --git a/builtin/ls-files.c b/builtin/ls-files.c index a03b559ecaa..bbff868ae6b 100644 --- a/builtin/ls-files.c +++ b/builtin/ls-files.c @@ -280,6 +280,9 @@ static size_t expand_show_index(struct strbuf *sb, const char *start, data->pathname)); else if (skip_prefix(start, "(path)", &p)) write_name_to_buf(sb, data->pathname); + else if (skip_prefix(start, "(skipworktree)", &p)) + strbuf_addstr(sb, ce_skip_worktree(data->ce) ? + "1" : ""); else die(_("bad ls-files format: %%%.*s"), (int)len, start); diff --git a/t/t3013-ls-files-format.sh b/t/t3013-ls-files-format.sh index efb7450bf1e..65939d38444 100755 --- a/t/t3013-ls-files-format.sh +++ b/t/t3013-ls-files-format.sh @@ -92,4 +92,20 @@ test_expect_success 'git ls-files --format with --debug' ' test_cmp expect actual ' +test_expect_success 'git ls-files --format with skipworktree' ' + test_when_finished "git sparse-checkout disable" && + mkdir dir1 dir2 && + echo "file1" >dir1/file1.txt && + echo "file2" >dir2/file2.txt && + git add dir1 dir2 && + git commit -m skipworktree && + git sparse-checkout set dir1 && + git ls-files --format="%(skipworktree) %(path)" "dir*" >actual && + cat >expect <<-\EOF && + dir1/file1.txt + 1 dir2/file2.txt + EOF + test_cmp expect actual +' + test_done -- gitgitgadget