From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id D5DB4C43334 for ; Mon, 11 Jul 2022 16:54:07 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S230443AbiGKQyH (ORCPT ); Mon, 11 Jul 2022 12:54:07 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:40154 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S230450AbiGKQyB (ORCPT ); Mon, 11 Jul 2022 12:54:01 -0400 Received: from mail-wm1-x329.google.com (mail-wm1-x329.google.com [IPv6:2a00:1450:4864:20::329]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 46FEC33422 for ; Mon, 11 Jul 2022 09:53:59 -0700 (PDT) Received: by mail-wm1-x329.google.com with SMTP id n185so3372426wmn.4 for ; Mon, 11 Jul 2022 09:53:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=message-id:in-reply-to:references:from:date:subject:fcc :content-transfer-encoding:mime-version:to:cc; bh=DCeVlMOkxsEYglSZMyB3jq0zsf4jyrU6Ulr0Oj1sSGI=; b=YKiIhgrSst7++HOfvvRXNmHt33LDhYMYqH/o05JhelCNoZBKjVcUI4371YAyuzm6PL DBFbWQ63/B+mOepcxbM7ruIms99AhjV31yyqp1G7Pcz/QL7n41WgL+vosAcnpTwCmBf9 fNEW0Xo7qcydBGZOvGNA4v6esTzDAI+gqNHD8DuN4PyNa8454bqwqYOUouOzue1t6L2d t7JtsDVXQV12f4Yg3BmjCXtbtWUbmtHmJmwkVMZyv75ZGoUddWswN7XdIsG3eKAQ55Eq ZBcfa16JZgCe3hU06GHE8tpZ7Krk/af8tlvOaJ3Mz09w8l9PZ6ZVjG1U4ObUn32LLPuS XWSA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:message-id:in-reply-to:references:from:date :subject:fcc:content-transfer-encoding:mime-version:to:cc; bh=DCeVlMOkxsEYglSZMyB3jq0zsf4jyrU6Ulr0Oj1sSGI=; b=UE2N+ak5a25ljl3vGzMqhcABWHLmjg+siJHKadb0jSspSQjD45luMMlpTL/A8Pv9Zt oXBoc9SORuMRi8NGTzmVBO1bdsJgsb8gd5a8VHG1marS5no/Yq/cUnVsNw+nGDcE2Ex8 Z6vomOJbE1lZbC+msA8FeNmCHDCXmoF1vf6VFnEBomvIex5RpAp09qeBooEaMOy6ny+P cu0Sqv4r0t3JBrP1xdfuc4Jgdp8k8zT7GT6b3FEXdkxqb5pSOPUiXfG8B8ZS5UV3ZtTy vhEIoWWFIIU0u56rhhn2Ri2jjqbYpcTRe4D8dI87AWNnBzE7SUenlJi8k3iPbEPJjuIT vqwA== X-Gm-Message-State: AJIora91HUMEMd/WRyUmlOs5mlFok924AJy6D4G9G9lkf6fMoH0RXOrh D884GA312ziO9EGbXhj8qBQCwbz4CAo= X-Google-Smtp-Source: AGRyM1tDEXkkCa3H4WfI0RFANf6mmOtNC2XofygmVuyMypTac/zwaEvWbvdWj7YOQTgl9BmmUIGniw== X-Received: by 2002:a05:600c:4f83:b0:3a1:7310:62e7 with SMTP id n3-20020a05600c4f8300b003a1731062e7mr17322807wmq.84.1657558437115; Mon, 11 Jul 2022 09:53:57 -0700 (PDT) Received: from [127.0.0.1] ([13.74.141.28]) by smtp.gmail.com with ESMTPSA id 24-20020a05600c22d800b003a0375c4f73sm7069430wmg.44.2022.07.11.09.53.56 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 11 Jul 2022 09:53:56 -0700 (PDT) Message-Id: In-Reply-To: References: From: "ZheNing Hu via GitGitGadget" Date: Mon, 11 Jul 2022 16:53:55 +0000 Subject: [PATCH v6] ls-files: introduce "--format" option Fcc: Sent Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit MIME-Version: 1.0 To: git@vger.kernel.org Cc: Junio C Hamano , Christian Couder , =?UTF-8?Q?=C3=86var_Arnfj=C3=B6r=C3=B0?= Bjarmason , Phillip Wood , Torsten =?UTF-8?Q?B=C3=B6gershausen?= , ZheNing Hu , ZheNing Hu Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org From: ZheNing Hu Add a new option --format that output index enties informations with custom format, taking inspiration from the option with the same name in the `git ls-tree` command. --format cannot used with -s, -o, -k, -t, --resolve-undo, --deduplicate and --eol. Signed-off-by: ZheNing Hu --- ls-files: introduce "--format" options v5->v6: 1. Some code cleaning suggested by Ævar. Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1262%2Fadlternative%2Fzh%2Fls-file-format-v6 Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1262/adlternative/zh/ls-file-format-v6 Pull-Request: https://github.com/gitgitgadget/git/pull/1262 Range-diff vs v5: 1: 1ce69d6202a ! 1: 57ed2c15728 ls-files: introduce "--format" option @@ builtin/ls-files.c: static char *ps_matched; static const char *tag_cached = ""; static const char *tag_unmerged = ""; -@@ builtin/ls-files.c: static void write_eolinfo(struct index_state *istate, - } - } - -+static void write_index_eolinfo_to_buf(struct strbuf *sb, struct index_state *istate, -+ const struct cache_entry *ce) -+{ -+ const char *i_txt = ""; -+ if (ce && S_ISREG(ce->ce_mode)) -+ i_txt = get_cached_convert_stats_ascii(istate, ce->name); -+ strbuf_addstr(sb, i_txt); -+} -+ -+static void write_worktree_eolinfo_to_buf(struct strbuf *sb, const char *path) -+{ -+ struct stat st; -+ const char *w_txt = ""; -+ if (!lstat(path, &st) && S_ISREG(st.st_mode)) -+ w_txt = get_wt_convert_stats_ascii(path); -+ strbuf_addstr(sb, w_txt); -+} -+ -+static void write_eolattr_to_buf(struct strbuf *sb, struct index_state *istate, -+ const char *path) -+{ -+ strbuf_addstr(sb, get_convert_attr_ascii(istate, path)); -+} -+ - static void write_name(const char *name) - { - /* @@ builtin/ls-files.c: static void write_name(const char *name) stdout, line_terminator); } @@ builtin/ls-files.c: static void show_submodule(struct repository *superproject, + const char *end; + const char *p; + size_t len = strbuf_expand_literal_cb(sb, start, NULL); ++ struct stat st; ++ + if (len) + return len; + if (*start != '(') @@ builtin/ls-files.c: static void show_submodule(struct repository *superproject, + strbuf_add_unique_abbrev(sb, &data->ce->oid, abbrev); + else if (skip_prefix(start, "(stage)", &p)) + strbuf_addf(sb, "%d", ce_stage(data->ce)); -+ else if (skip_prefix(start, "(eolinfo:index)", &p)) -+ write_index_eolinfo_to_buf(sb, data->istate, data->ce); -+ else if (skip_prefix(start, "(eolinfo:worktree)", &p)) -+ write_worktree_eolinfo_to_buf(sb, data->pathname); ++ else if (skip_prefix(start, "(eolinfo:index)", &p) && ++ S_ISREG(data->ce->ce_mode)) ++ strbuf_addstr(sb, get_cached_convert_stats_ascii(data->istate, ++ data->ce->name)); ++ else if (skip_prefix(start, "(eolinfo:worktree)", &p) && ++ !lstat(data->pathname, &st) && S_ISREG(st.st_mode)) ++ strbuf_addstr(sb, get_wt_convert_stats_ascii(data->pathname)); + else if (skip_prefix(start, "(eolattr)", &p)) -+ write_eolattr_to_buf(sb, data->istate, data->pathname); ++ strbuf_addstr(sb, get_convert_attr_ascii(data->istate, ++ data->pathname)); + else if (skip_prefix(start, "(path)", &p)) + write_name_to_buf(sb, data->pathname); + else @@ builtin/ls-files.c: static void show_submodule(struct repository *superproject, + +static void show_ce_fmt(struct repository *repo, const struct cache_entry *ce, + const char *format, const char *fullname) { -+ + struct show_index_data data = { + .pathname = fullname, + .istate = repo->index, + .ce = ce, + }; -+ + struct strbuf sb = STRBUF_INIT; ++ + strbuf_expand(&sb, format, expand_show_index, &data); + strbuf_addch(&sb, line_terminator); + fwrite(sb.buf, sb.len, 1, stdout); + strbuf_release(&sb); -+ return; +} + static void show_ce(struct repository *repo, struct dir_struct *dir, @@ t/t3013-ls-files-format.sh (new) + test_cmp expect actual +' + -+test_expect_success 'git ls-files --format eolinfo:index' ' -+ cat >expect <<-\EOF && -+ lf -+ lf -+ EOF -+ git ls-files --format="%(eolinfo:index)" >actual && -+ test_cmp expect actual -+' -+ -+test_expect_success 'git ls-files --format eolinfo:worktree' ' -+ cat >expect <<-\EOF && -+ lf -+ lf -+ EOF -+ git ls-files --format="%(eolinfo:worktree)" >actual && -+ test_cmp expect actual -+' -+ -+test_expect_success 'git ls-files --format eolattr' ' -+ printf "\n\n" >expect && -+ git ls-files --format="%(eolattr)" >actual && ++HT=' ' ++WS=' ' ++test_expect_success 'git ls-files --format v.s. --eol' ' ++ git ls-files --eol >expect 2>err && ++ test_must_be_empty err && ++ git ls-files --format="i/%(eolinfo:index)${WS}w/%(eolinfo:worktree)${WS}attr/${WS}${WS}${WS}${WS} ${HT}%(path)" >actual 2>err && ++ test_must_be_empty err && + test_cmp expect actual +' + Documentation/git-ls-files.txt | 38 +++++++++++++- builtin/ls-files.c | 93 +++++++++++++++++++++++++++++++++ t/t3013-ls-files-format.sh | 94 ++++++++++++++++++++++++++++++++++ 3 files changed, 224 insertions(+), 1 deletion(-) create mode 100755 t/t3013-ls-files-format.sh diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 0dabf3f0ddc..97d4cebba9f 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -20,7 +20,7 @@ SYNOPSIS [--exclude-standard] [--error-unmatch] [--with-tree=] [--full-name] [--recurse-submodules] - [--abbrev[=]] [--] [...] + [--abbrev[=]] [--format=] [--] [...] DESCRIPTION ----------- @@ -192,6 +192,13 @@ followed by the ("attr/"). to the contained files. Sparse directories will be shown with a trailing slash, such as "x/" for a sparse directory "x". +--format=:: + A string that interpolates `%(fieldname)` from the result being shown. + It also interpolates `%%` to `%`, and `%xx` where `xx` are hex digits + interpolates to character with hex code `xx`; for example `%00` + interpolates to `\0` (NUL), `%09` to `\t` (TAB) and %0a to `\n` (LF). + --format cannot be combined with `-s`, `-o`, `-k`, `-t`, `--resolve-undo` + and `--eol`. \--:: Do not interpret any more arguments as options. @@ -223,6 +230,35 @@ quoted as explained for the configuration variable `core.quotePath` (see linkgit:git-config[1]). Using `-z` the filename is output verbatim and the line is terminated by a NUL byte. +It is possible to print in a custom format by using the `--format` +option, which is able to interpolate different fields using +a `%(fieldname)` notation. For example, if you only care about the +"objectname" and "path" fields, you can execute with a specific +"--format" like + + git ls-files --format='%(objectname) %(path)' + +FIELD NAMES +----------- +Various values from structured fields can be used to interpolate +into the resulting output. For each outputting line, the following +names can be used: + +objectmode:: + The mode of the file which is recorded in the index. +objectname:: + The name of the file which is recorded in the index. +stage:: + The stage of the file which is recorded in the index. +eolinfo:index:: +eolinfo:worktree:: + The (see the description of the `--eol` option) of + the contents in the index or in the worktree for the path. +eolattr:: + The (see the description of the `--eol` option) + that applies to the path. +path:: + The pathname of the file which is recorded in the index. EXCLUDE PATTERNS ---------------- diff --git a/builtin/ls-files.c b/builtin/ls-files.c index e791b65e7e9..6376dbcccc6 100644 --- a/builtin/ls-files.c +++ b/builtin/ls-files.c @@ -11,6 +11,7 @@ #include "quote.h" #include "dir.h" #include "builtin.h" +#include "strbuf.h" #include "tree.h" #include "cache-tree.h" #include "parse-options.h" @@ -48,6 +49,7 @@ static char *ps_matched; static const char *with_tree; static int exc_given; static int exclude_args; +static const char *format; static const char *tag_cached = ""; static const char *tag_unmerged = ""; @@ -85,6 +87,15 @@ static void write_name(const char *name) stdout, line_terminator); } +static void write_name_to_buf(struct strbuf *sb, const char *name) +{ + const char *rel = relative_path(name, prefix_len ? prefix : NULL, sb); + if (line_terminator) + quote_c_style(rel, sb, NULL, 0); + else + strbuf_add(sb, rel, strlen(rel)); +} + static const char *get_tag(const struct cache_entry *ce, const char *tag) { static char alttag[4]; @@ -222,6 +233,72 @@ static void show_submodule(struct repository *superproject, repo_clear(&subrepo); } +struct show_index_data { + const char *pathname; + struct index_state *istate; + const struct cache_entry *ce; +}; + +static size_t expand_show_index(struct strbuf *sb, const char *start, + void *context) +{ + struct show_index_data *data = context; + const char *end; + const char *p; + size_t len = strbuf_expand_literal_cb(sb, start, NULL); + struct stat st; + + if (len) + return len; + if (*start != '(') + die(_("bad ls-files format: element '%s' " + "does not start with '('"), start); + + end = strchr(start + 1, ')'); + if (!end) + die(_("bad ls-files format: element '%s'" + "does not end in ')'"), start); + + len = end - start + 1; + if (skip_prefix(start, "(objectmode)", &p)) + strbuf_addf(sb, "%06o", data->ce->ce_mode); + else if (skip_prefix(start, "(objectname)", &p)) + strbuf_add_unique_abbrev(sb, &data->ce->oid, abbrev); + else if (skip_prefix(start, "(stage)", &p)) + strbuf_addf(sb, "%d", ce_stage(data->ce)); + else if (skip_prefix(start, "(eolinfo:index)", &p) && + S_ISREG(data->ce->ce_mode)) + strbuf_addstr(sb, get_cached_convert_stats_ascii(data->istate, + data->ce->name)); + else if (skip_prefix(start, "(eolinfo:worktree)", &p) && + !lstat(data->pathname, &st) && S_ISREG(st.st_mode)) + strbuf_addstr(sb, get_wt_convert_stats_ascii(data->pathname)); + else if (skip_prefix(start, "(eolattr)", &p)) + strbuf_addstr(sb, get_convert_attr_ascii(data->istate, + data->pathname)); + else if (skip_prefix(start, "(path)", &p)) + write_name_to_buf(sb, data->pathname); + else + die(_("bad ls-files format: %%%.*s"), (int)len, start); + + return len; +} + +static void show_ce_fmt(struct repository *repo, const struct cache_entry *ce, + const char *format, const char *fullname) { + struct show_index_data data = { + .pathname = fullname, + .istate = repo->index, + .ce = ce, + }; + struct strbuf sb = STRBUF_INIT; + + strbuf_expand(&sb, format, expand_show_index, &data); + strbuf_addch(&sb, line_terminator); + fwrite(sb.buf, sb.len, 1, stdout); + strbuf_release(&sb); +} + static void show_ce(struct repository *repo, struct dir_struct *dir, const struct cache_entry *ce, const char *fullname, const char *tag) @@ -236,6 +313,12 @@ static void show_ce(struct repository *repo, struct dir_struct *dir, max_prefix_len, ps_matched, S_ISDIR(ce->ce_mode) || S_ISGITLINK(ce->ce_mode))) { + if (format) { + show_ce_fmt(repo, ce, format, fullname); + print_debug(ce); + return; + } + tag = get_tag(ce, tag); if (!show_stage) { @@ -675,6 +758,9 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix) N_("suppress duplicate entries")), OPT_BOOL(0, "sparse", &show_sparse_dirs, N_("show sparse directories in the presence of a sparse index")), + OPT_STRING_F(0, "format", &format, N_("format"), + N_("format to use for the output"), + PARSE_OPT_NONEG), OPT_END() }; int ret = 0; @@ -699,6 +785,13 @@ int cmd_ls_files(int argc, const char **argv, const char *cmd_prefix) for (i = 0; i < exclude_list.nr; i++) { add_pattern(exclude_list.items[i].string, "", 0, pl, --exclude_args); } + + if (format && (show_stage || show_others || show_killed || + show_resolve_undo || skipping_duplicates || show_eol || show_tag)) + usage_msg_opt("--format cannot used with -s, -o, -k, -t" + "--resolve-undo, --deduplicate, --eol", + ls_files_usage, builtin_ls_files_options); + if (show_tag || show_valid_bit || show_fsmonitor_bit) { tag_cached = "H "; tag_unmerged = "M "; diff --git a/t/t3013-ls-files-format.sh b/t/t3013-ls-files-format.sh new file mode 100755 index 00000000000..baf03f9096e --- /dev/null +++ b/t/t3013-ls-files-format.sh @@ -0,0 +1,94 @@ +#!/bin/sh + +test_description='git ls-files --format test' + +TEST_PASSES_SANITIZE_LEAK=true +. ./test-lib.sh + +for flag in -s -o -k -t --resolve-undo --deduplicate --eol +do + test_expect_success "usage: --format is incompatible with $flag" ' + test_expect_code 129 git ls-files --format="%(objectname)" $flag + ' +done + +test_expect_success 'setup' ' + echo o1 >o1 && + echo o2 >o2 && + git add o1 o2 && + git add --chmod +x o1 && + git commit -m base +' + +test_expect_success 'git ls-files --format objectmode' ' + cat >expect <<-\EOF && + 100755 + 100644 + EOF + git ls-files --format="%(objectmode)" >actual && + test_cmp expect actual +' + +test_expect_success 'git ls-files --format objectname' ' + oid1=$(git hash-object o1) && + oid2=$(git hash-object o2) && + cat >expect <<-EOF && + $oid1 + $oid2 + EOF + git ls-files --format="%(objectname)" >actual && + test_cmp expect actual +' + +HT=' ' +WS=' ' +test_expect_success 'git ls-files --format v.s. --eol' ' + git ls-files --eol >expect 2>err && + test_must_be_empty err && + git ls-files --format="i/%(eolinfo:index)${WS}w/%(eolinfo:worktree)${WS}attr/${WS}${WS}${WS}${WS} ${HT}%(path)" >actual 2>err && + test_must_be_empty err && + test_cmp expect actual +' + +test_expect_success 'git ls-files --format path' ' + cat >expect <<-\EOF && + o1 + o2 + EOF + git ls-files --format="%(path)" >actual && + test_cmp expect actual +' + +test_expect_success 'git ls-files --format with -m' ' + echo change >o1 && + cat >expect <<-\EOF && + o1 + EOF + git ls-files --format="%(path)" -m >actual && + test_cmp expect actual +' + +test_expect_success 'git ls-files --format with -d' ' + echo o3 >o3 && + git add o3 && + rm o3 && + cat >expect <<-\EOF && + o3 + EOF + git ls-files --format="%(path)" -d >actual && + test_cmp expect actual +' + +test_expect_success 'git ls-files --format imitate --stage' ' + git ls-files --stage >expect && + git ls-files --format="%(objectmode) %(objectname) %(stage)%x09%(path)" >actual && + test_cmp expect actual +' + +test_expect_success 'git ls-files --format with --debug' ' + git ls-files --debug >expect && + git ls-files --format="%(path)" --debug >actual && + test_cmp expect actual +' + +test_done base-commit: ab336e8f1c8009c8b1aab8deb592148e69217085 -- gitgitgadget