From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>, "Jeff King" <peff@peff.net>,
"John Cai" <johncai86@gmail.com>,
"Sergey Organov" <sorganov@gmail.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v2 00/10] cat-file: better usage UX & error messages
Date: Fri, 12 Nov 2021 23:19:58 +0100 [thread overview]
Message-ID: <cover-v2-00.10-00000000000-20211112T221506Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-00.10-00000000000-20211106T214259Z-avarab@gmail.com>
This series of patches to cat-file significantly improves the UX of
the -h output, see 08/10. For the v1 see[1]
This update addresses comments Eric Sunshine had on test patterns &
typos. I've taken (or attemted to address) all his comments
here. There was a leftover unused $switch variable from development,
and some other minor test & typo nits.
Junio: John Cai expressed (off-list) interest in building on top of
this for the cat-file "new stdin mode"+fflush() batch command. You
seemed to think the direction of my WIP patch in that direction was
good, whic his much easier to implement, test & be sure about the
correctness off after this series.
So it would be great to have this tightening of the options behavior &
UX improvement picked up.
1. https://lore.kernel.org/git/cover-00.10-00000000000-20211106T214259Z-avarab@gmail.com/
2. https://lore.kernel.org/git/xmqqk0hitnkc.fsf@gitster.g/
3. https://lore.kernel.org/git/xmqqk0hitnkc.fsf@gitster.g/
Ævar Arnfjörð Bjarmason (10):
cat-file tests: test bad usage
cat-file tests: test messaging on bad objects/paths
parse-options API: add a usage_msg_optf()
cat-file docs: fix SYNOPSIS and "-h" output
cat-file: move "usage" variable to cmd_cat_file()
cat-file: make --batch-all-objects a CMDMODE
cat-file: fix remaining usage bugs
cat-file: correct and improve usage information
object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY
cat-file: improve --(textconv|filters) disambiguation
Documentation/git-cat-file.txt | 10 +-
builtin/cat-file.c | 181 ++++++++++++++++++++-------------
builtin/stash.c | 4 +-
cache.h | 1 +
object-name.c | 11 +-
parse-options.c | 13 +++
parse-options.h | 10 ++
t/t1006-cat-file.sh | 92 +++++++++++++++++
t/t8007-cat-file-textconv.sh | 26 +++++
9 files changed, 267 insertions(+), 81 deletions(-)
Range-diff against v1:
1: c8040da8e55 ! 1: 3a0d2923cfa cat-file tests: test bad usage
@@ Commit message
when --batch-all-objects is combined with --textconv or --filters, but
we don't.
+ The cases of needing to assign to opt=2 in the "opt" loop are because
+ on those we do the right thing already, in subsequent commits the
+ "test_expect_failure" cases will be fixed, and the for-loops unified.
+
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
## t/t1006-cat-file.sh ##
@@ t/t1006-cat-file.sh: test_description='git cat-file'
. ./test-lib.sh
-+test_cmdmode_usage() {
++test_cmdmode_usage () {
+ test_expect_code 129 "$@" 2>err &&
+ grep "^error:.*is incompatible with" err
+}
+
-+test_expect_success 'usage: cmdmode' '
-+ test_cmdmode_usage git cat-file -e -p &&
-+ test_cmdmode_usage git cat-file -p -t &&
-+ test_cmdmode_usage git cat-file -t -s &&
-+ test_cmdmode_usage git cat-file -s --textconv &&
-+ test_cmdmode_usage git cat-file --textconv --filters
-+'
++for switches in \
++ '-e -p' \
++ '-p -t' \
++ '-t -s' \
++ '-s --textconv' \
++ '--textconv --filters'
++do
++ test_expect_success "usage: cmdmode $switches" '
++ test_cmdmode_usage git cat-file $switches
++ '
++done
+
-+test_incompatible_usage() {
++test_incompatible_usage () {
+ test_expect_code 129 "$@" 2>err &&
-+ grep -E "^error:.*$switch.*needs" err
++ grep -E "^error:.**needs" err
+}
+
+for opt in --batch --batch-check
2: a473185eb97 = 2: fc8d5e60682 cat-file tests: test messaging on bad objects/paths
3: 5d87897f49c = 3: 0e2e5ab9d2d parse-options API: add a usage_msg_optf()
4: 29b67330a48 = 4: b9c935b95b7 cat-file docs: fix SYNOPSIS and "-h" output
5: 1974136d483 = 5: 664c5db634e cat-file: move "usage" variable to cmd_cat_file()
6: ee49e586483 ! 6: d945fc94774 cat-file: make --batch-all-objects a CMDMODE
@@ Commit message
instead. It doesn't combine with --filters, --textconv etc.
By giving parse_options() information about what options are mutually
- exclusive with one another we can get the die9) message being removed
+ exclusive with one another we can get the die() message being removed
here for free, we didn't even use that removed message in some cases,
e.g. for both of:
@@ builtin/cat-file.c: int cmd_cat_file(int argc, const char **argv, const char *pr
usage_with_options(usage, options);
## t/t1006-cat-file.sh ##
-@@ t/t1006-cat-file.sh: test_expect_success 'usage: cmdmode' '
- test_cmdmode_usage git cat-file -p -t &&
- test_cmdmode_usage git cat-file -t -s &&
- test_cmdmode_usage git cat-file -s --textconv &&
-- test_cmdmode_usage git cat-file --textconv --filters
-+ test_cmdmode_usage git cat-file --textconv --filters &&
-+ test_cmdmode_usage git cat-file --batch-all-objects -e
- '
-
- test_incompatible_usage() {
+@@ t/t1006-cat-file.sh: for switches in \
+ '-p -t' \
+ '-t -s' \
+ '-s --textconv' \
+- '--textconv --filters'
++ '--textconv --filters' \
++ '--batch-all-objects -e'
+ do
+ test_expect_success "usage: cmdmode $switches" '
+ test_cmdmode_usage git cat-file $switches
@@ t/t1006-cat-file.sh: do
test_expect_success "usage: $opt requires another option" '
test_expect_code 129 git cat-file $opt
7: 9e1dcd6b824 ! 7: 22f55e1fb6b cat-file: fix remaining usage bugs
@@ builtin/cat-file.c: int cmd_cat_file(int argc, const char **argv, const char *pr
die("git cat-file --allow-unknown-type: use with -s or -t");
## t/t1006-cat-file.sh ##
-@@ t/t1006-cat-file.sh: test_expect_success 'usage: cmdmode' '
+@@ t/t1006-cat-file.sh: done
- test_incompatible_usage() {
+ test_incompatible_usage () {
test_expect_code 129 "$@" 2>err &&
-- grep -E "^error:.*$switch.*needs" err
-+ grep -E "^(fatal|error):.*$switch.*(requires|incompatible with|needs)" err
+- grep -E "^error:.**needs" err
++ grep -E "^(fatal|error):.*(requires|incompatible with|needs)" err
}
for opt in --batch --batch-check
8: 951fea02b83 = 8: 0842df64695 cat-file: correct and improve usage information
9: 49f9e30792b ! 9: 6642b57c6fe object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY
@@ Commit message
call get_oid_with_context_1() again via this
maybe_die_on_misspelt_object_name() function.
- In the subsequent commit we'll add a new caller that excepts to call
+ In the subsequent commit we'll add a new caller that expects to call
this only once, but who would still like to have all the error
messaging that GET_OID_ONLY_TO_DIE gives it, in addition to any
regular errors.
10: 3d61399aa78 = 10: 177f16ba856 cat-file: improve --(textconv|filters) disambiguation
--
2.34.0.rc2.795.g926201d1cc8
next prev parent reply other threads:[~2021-11-12 22:20 UTC|newest]
Thread overview: 101+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-10-05 20:29 [PATCH 0/5] cat-file replace handling and optimization Jeff King
2021-10-05 20:30 ` [PATCH 1/5] t1006: clean up broken objects Jeff King
2021-10-05 20:31 ` [PATCH 2/5] cat-file: mention --unordered along with --batch-all-objects Jeff King
2021-10-05 21:02 ` Ævar Arnfjörð Bjarmason
2021-10-05 21:41 ` Jeff King
2021-10-06 9:02 ` Ævar Arnfjörð Bjarmason
2021-10-06 16:15 ` Jeff King
2021-10-07 10:18 ` Ævar Arnfjörð Bjarmason
2021-10-08 2:30 ` Jeff King
2021-10-08 7:54 ` Ævar Arnfjörð Bjarmason
2021-10-08 20:34 ` Junio C Hamano
2021-10-08 21:44 ` Jeff King
2021-10-08 22:04 ` Junio C Hamano
2021-11-06 21:46 ` [PATCH 00/10] cat-file: better usage UX & error messages Ævar Arnfjörð Bjarmason
2021-11-06 21:46 ` [PATCH 01/10] cat-file tests: test bad usage Ævar Arnfjörð Bjarmason
2021-11-07 1:07 ` Eric Sunshine
2021-11-06 21:46 ` [PATCH 02/10] cat-file tests: test messaging on bad objects/paths Ævar Arnfjörð Bjarmason
2021-11-06 21:46 ` [PATCH 03/10] parse-options API: add a usage_msg_optf() Ævar Arnfjörð Bjarmason
2021-11-06 21:46 ` [PATCH 04/10] cat-file docs: fix SYNOPSIS and "-h" output Ævar Arnfjörð Bjarmason
2021-11-06 21:46 ` [PATCH 05/10] cat-file: move "usage" variable to cmd_cat_file() Ævar Arnfjörð Bjarmason
2021-11-06 21:46 ` [PATCH 06/10] cat-file: make --batch-all-objects a CMDMODE Ævar Arnfjörð Bjarmason
2021-11-07 3:00 ` Eric Sunshine
2021-11-06 21:46 ` [PATCH 07/10] cat-file: fix remaining usage bugs Ævar Arnfjörð Bjarmason
2021-11-06 21:47 ` [PATCH 08/10] cat-file: correct and improve usage information Ævar Arnfjörð Bjarmason
2021-11-06 21:47 ` [PATCH 09/10] object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY Ævar Arnfjörð Bjarmason
2021-11-07 3:05 ` Eric Sunshine
2021-11-06 21:47 ` [PATCH 10/10] cat-file: improve --(textconv|filters) disambiguation Ævar Arnfjörð Bjarmason
2021-11-12 22:19 ` Ævar Arnfjörð Bjarmason [this message]
2021-11-12 22:19 ` [PATCH v2 01/10] cat-file tests: test bad usage Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 02/10] cat-file tests: test messaging on bad objects/paths Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 03/10] parse-options API: add a usage_msg_optf() Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 04/10] cat-file docs: fix SYNOPSIS and "-h" output Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 05/10] cat-file: move "usage" variable to cmd_cat_file() Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 06/10] cat-file: make --batch-all-objects a CMDMODE Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 07/10] cat-file: fix remaining usage bugs Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 08/10] cat-file: correct and improve usage information Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 09/10] object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY Ævar Arnfjörð Bjarmason
2021-11-12 22:20 ` [PATCH v2 10/10] cat-file: improve --(textconv|filters) disambiguation Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 00/10] cat-file: better usage UX & error messages Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 01/10] cat-file tests: test bad usage Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 02/10] cat-file tests: test messaging on bad objects/paths Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 03/10] parse-options API: add a usage_msg_optf() Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 04/10] cat-file docs: fix SYNOPSIS and "-h" output Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 05/10] cat-file: move "usage" variable to cmd_cat_file() Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 06/10] cat-file: make --batch-all-objects a CMDMODE Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 07/10] cat-file: fix remaining usage bugs Ævar Arnfjörð Bjarmason
2021-12-06 1:19 ` Jiang Xin
2021-11-29 19:57 ` [PATCH v3 08/10] cat-file: correct and improve usage information Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 09/10] object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY Ævar Arnfjörð Bjarmason
2021-11-29 19:57 ` [PATCH v3 10/10] cat-file: use GET_OID_ONLY_TO_DIE in --(textconv|filters) Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 00/10] cat-file: better usage UX & error messages Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 01/10] cat-file tests: test bad usage Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 02/10] cat-file tests: test messaging on bad objects/paths Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 03/10] parse-options API: add a usage_msg_optf() Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 04/10] cat-file docs: fix SYNOPSIS and "-h" output Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 05/10] cat-file: move "usage" variable to cmd_cat_file() Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 06/10] cat-file: make --batch-all-objects a CMDMODE Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 07/10] cat-file: fix remaining usage bugs Ævar Arnfjörð Bjarmason
2021-12-20 16:00 ` John Cai
2021-12-08 12:34 ` [PATCH v4 08/10] cat-file: correct and improve usage information Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 09/10] object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY Ævar Arnfjörð Bjarmason
2021-12-08 12:34 ` [PATCH v4 10/10] cat-file: use GET_OID_ONLY_TO_DIE in --(textconv|filters) Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 00/10] cat-file: better usage UX & error messages Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 01/10] cat-file tests: test bad usage Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 02/10] cat-file tests: test messaging on bad objects/paths Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 03/10] parse-options API: add a usage_msg_optf() Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 04/10] cat-file docs: fix SYNOPSIS and "-h" output Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 05/10] cat-file: move "usage" variable to cmd_cat_file() Ævar Arnfjörð Bjarmason
2021-12-22 4:12 ` [PATCH v5 06/10] cat-file: make --batch-all-objects a CMDMODE Ævar Arnfjörð Bjarmason
2021-12-22 4:13 ` [PATCH v5 07/10] cat-file: fix remaining usage bugs Ævar Arnfjörð Bjarmason
2021-12-26 0:31 ` Junio C Hamano
2021-12-22 4:13 ` [PATCH v5 08/10] cat-file: correct and improve usage information Ævar Arnfjörð Bjarmason
2021-12-22 4:13 ` [PATCH v5 09/10] object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY Ævar Arnfjörð Bjarmason
2021-12-22 4:13 ` [PATCH v5 10/10] cat-file: use GET_OID_ONLY_TO_DIE in --(textconv|filters) Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 00/10] cat-file: better usage UX & error messages Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 01/10] cat-file tests: test bad usage Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 02/10] cat-file tests: test messaging on bad objects/paths Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 03/10] parse-options API: add a usage_msg_optf() Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 04/10] cat-file docs: fix SYNOPSIS and "-h" output Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 05/10] cat-file: move "usage" variable to cmd_cat_file() Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 06/10] cat-file: make --batch-all-objects a CMDMODE Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 07/10] cat-file: fix remaining usage bugs Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 08/10] cat-file: correct and improve usage information Ævar Arnfjörð Bjarmason
2022-01-08 2:58 ` Jiang Xin
2022-01-10 22:08 ` [PATCH 0/2] fixups for issues in next-merged ab/cat-file Ævar Arnfjörð Bjarmason
2022-01-10 22:08 ` [PATCH 1/2] cat-file: don't whitespace-pad "(...)" in SYNOPSIS and usage output Ævar Arnfjörð Bjarmason
2022-01-10 22:08 ` [PATCH 2/2] cat-file: s/_/-/ in typo'd usage_msg_optf() message Ævar Arnfjörð Bjarmason
2022-01-10 22:20 ` [PATCH 0/2] fixups for issues in next-merged ab/cat-file Junio C Hamano
2022-01-11 15:48 ` Taylor Blau
2022-01-12 18:11 ` Junio C Hamano
2021-12-28 13:28 ` [PATCH v6 09/10] object-name.c: don't have GET_OID_ONLY_TO_DIE imply *_QUIETLY Ævar Arnfjörð Bjarmason
2021-12-28 13:28 ` [PATCH v6 10/10] cat-file: use GET_OID_ONLY_TO_DIE in --(textconv|filters) Ævar Arnfjörð Bjarmason
2021-10-05 20:36 ` [PATCH 3/5] cat-file: disable refs/replace with --batch-all-objects Jeff King
2021-10-06 20:33 ` Derrick Stolee
2021-10-07 20:48 ` Junio C Hamano
2021-10-05 20:36 ` [PATCH 4/5] cat-file: split ordered/unordered batch-all-objects callbacks Jeff King
2021-10-05 20:38 ` [PATCH 5/5] cat-file: use packed_object_info() for --batch-all-objects Jeff King
2021-10-07 20:56 ` Junio C Hamano
2021-10-08 2:35 ` Jeff King
2021-10-06 20:41 ` [PATCH 0/5] cat-file replace handling and optimization Derrick Stolee
2021-10-07 0:32 ` Jeff King
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=cover-v2-00.10-00000000000-20211112T221506Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=johncai86@gmail.com \
--cc=peff@peff.net \
--cc=sorganov@gmail.com \
/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.
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 NNTP newsgroup(s).