From: Phillip Wood <phillip.wood123@gmail.com>
To: ZheNing Hu via GitGitGadget <gitgitgadget@gmail.com>,
git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Christian Couder" <christian.couder@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
"ZheNing Hu" <adlternative@gmail.com>
Subject: Re: [PATCH v3] ls-files: introduce "--format" option
Date: Thu, 23 Jun 2022 15:06:33 +0100 [thread overview]
Message-ID: <080f65b3-91f5-7b68-4235-4bfb956c8321@gmail.com> (raw)
In-Reply-To: <pull.1262.v3.git.1655777140231.gitgitgadget@gmail.com>
Hi ZheNing
On 21/06/2022 03:05, ZheNing Hu via GitGitGadget wrote:
> From: ZheNing Hu <adlternative@gmail.com>
>
> 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, --resolve-undo,
> --deduplicate and --debug.
>
> Signed-off-by: ZheNing Hu <adlternative@gmail.com>
> ---
> ls-files: introduce "--format" options
>
> v2->v3:
>
> 1. remove %(tag) because -t is deprecated, suggested by Phillip.
> 2. fix some description of atoms in document, suggested by Phillip..
Thanks for re-rolling, having taken a look a closer look at the tests
I'm concerned about the output format for some of the specifiers, see below.
> [...]
> +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 in the index.
> +objectname::
> + The name of the file which is in the index.
> +stage::
> + The stage of the file which is in the index.
> +eol::
> + The <eolinfo> and <eolattr> of files both in the
> + index and the work-tree.
Looking at the test for this option I think it needs more work, why
should --format arbitrarily append a tab to the end of the output? - the
user should be able to specify a separator if they want one as part of
the format string. Also I'm not sure why there is so much whitespace in
the output.
> +path::
> + The pathname of the file which is in the index.
I think that for all these it might be clearer to say "recorded in the
index" rather than "of the file which is in the index"
> +ctime::
> + The create time of file which is in the index.
This is printed with a prefix 'ctime:' (the same applies to the format
specifiers below) I think we should omit that and just print the data so
the user can choose the format they want.
> +mtime::
> + The modified time of file which is in the index.
> +dev::
> + The ID of device containing file which is in the index.
> +ino::
> + The inode number of file which is in the index.
> +uid::
> + The user id of file owner which is in the index.
> +gid::
> + The group id of file owner which is in the index.
> +size::
> + The size of the file which is in the index.
> +flags::
> + The flags of the file in the index which include
> + in-memory only flags and some extended on-disk flags.
If %(flags) is going to be useful then I think we need to think about
how they are printed and document that. At the moment they are printed
as a hexadecimal number which is fine for debugging but probably not
going to be useful for something like --format. I think printing
documented symbolic names with some kind of separator (a comma maybe)
between them is probably more useful
> [...]
> +test_expect_success 'git ls-files --format eol' '
> + printf "i/lf w/lf attr/ \t\n" >expect &&
> + printf "i/lf w/lf attr/ \t\n" >>expect &&
> + git ls-files --format="%(eol)" --eol >actual &&
I'm not sure why this is passing --eol as well as --format='%(eol)' -
shouldn't that combination of flags be an error?
Best Wishes
Phillip
next prev parent reply other threads:[~2022-06-23 14:07 UTC|newest]
Thread overview: 61+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-06-15 13:45 [PATCH 0/2] ls-files: introduce "--format" and "--object-only" options ZheNing Hu via GitGitGadget
2022-06-15 13:45 ` [PATCH 1/2] ls-files: introduce "--format" option ZheNing Hu via GitGitGadget
2022-06-15 20:07 ` Ævar Arnfjörð Bjarmason
2022-06-18 10:50 ` ZheNing Hu
2022-06-15 13:45 ` [PATCH 2/2] ls-files: introduce "--object-only" option ZheNing Hu via GitGitGadget
2022-06-15 20:15 ` Ævar Arnfjörð Bjarmason
2022-06-18 10:59 ` ZheNing Hu
2022-06-19 9:13 ` [PATCH v2] ls-files: introduce "--format" option ZheNing Hu via GitGitGadget
2022-06-19 13:50 ` Phillip Wood
2022-06-20 13:32 ` ZheNing Hu
2022-06-21 2:05 ` [PATCH v3] " ZheNing Hu via GitGitGadget
2022-06-23 14:06 ` Phillip Wood [this message]
2022-06-23 15:57 ` Junio C Hamano
2022-06-24 10:16 ` Phillip Wood
2022-06-26 13:05 ` ZheNing Hu
2022-06-24 13:20 ` Ævar Arnfjörð Bjarmason
2022-06-24 15:28 ` Junio C Hamano
2022-06-26 13:01 ` ZheNing Hu
2022-06-24 13:25 ` Ævar Arnfjörð Bjarmason
2022-06-24 15:33 ` Junio C Hamano
2022-06-26 13:35 ` ZheNing Hu
2022-06-27 8:22 ` Junio C Hamano
2022-06-27 11:06 ` ZheNing Hu
2022-06-27 15:41 ` Junio C Hamano
2022-07-01 13:30 ` ZheNing Hu
2022-06-26 13:34 ` ZheNing Hu
2022-06-26 15:29 ` [PATCH v4] " ZheNing Hu via GitGitGadget
2022-06-27 8:32 ` Junio C Hamano
2022-06-27 11:18 ` ZheNing Hu
2022-06-27 18:34 ` Ævar Arnfjörð Bjarmason
2022-07-01 12:42 ` ZheNing Hu
2022-06-28 15:19 ` Phillip Wood
2022-07-01 12:47 ` ZheNing Hu
2022-07-05 6:32 ` [PATCH v5] " ZheNing Hu via GitGitGadget
2022-07-05 8:39 ` Ævar Arnfjörð Bjarmason
2022-07-11 15:14 ` ZheNing Hu
2022-07-05 19:28 ` Torsten Bögershausen
2022-07-11 15:27 ` ZheNing Hu
2022-07-11 16:53 ` [PATCH v6] " ZheNing Hu via GitGitGadget
2022-07-11 22:11 ` Junio C Hamano
2022-07-12 13:53 ` ZheNing Hu
2022-07-12 14:34 ` Junio C Hamano
2022-07-13 6:07 ` [PATCH v7] " ZheNing Hu via GitGitGadget
2022-07-18 8:09 ` Ævar Arnfjörð Bjarmason
2022-07-19 16:19 ` ZheNing Hu
2022-07-19 16:47 ` Junio C Hamano
2022-07-19 17:21 ` ZheNing Hu
2022-07-20 16:36 ` [PATCH v8] " ZheNing Hu via GitGitGadget
2022-07-20 17:37 ` Junio C Hamano
2022-07-21 15:54 ` Ævar Arnfjörð Bjarmason
2022-07-21 17:22 ` Eric Sunshine
2022-07-21 17:23 ` Junio C Hamano
2022-07-22 6:44 ` ZheNing Hu
2022-07-23 18:40 ` Junio C Hamano
2022-07-23 18:46 ` Junio C Hamano
2022-07-24 11:08 ` ZheNing Hu
2022-07-25 1:03 ` Junio C Hamano
2022-07-25 11:00 ` ZheNing Hu
2022-07-23 6:44 ` [PATCH v9] " ZheNing Hu via GitGitGadget
2022-09-08 2:01 ` Jiang Xin
2022-09-11 11:01 ` ZheNing Hu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=080f65b3-91f5-7b68-4235-4bfb956c8321@gmail.com \
--to=phillip.wood123@gmail.com \
--cc=adlternative@gmail.com \
--cc=avarab@gmail.com \
--cc=christian.couder@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=gitster@pobox.com \
--cc=phillip.wood@dunelm.org.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).