From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: git@vger.kernel.org
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Derrick Stolee" <stolee@gmail.com>,
"Taylor Blau" <me@ttaylorr.com>,
"Andrei Rybak" <rybak.a.v@gmail.com>,
"SZEDER Gábor" <szeder.dev@gmail.com>,
"Jeff King" <peff@peff.net>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Subject: [PATCH v4 0/7] commit-graph: usage fixes
Date: Mon, 23 Aug 2021 14:30:14 +0200 [thread overview]
Message-ID: <cover-v4-0.7-00000000000-20210823T122854Z-avarab@gmail.com> (raw)
In-Reply-To: <cover-0.6-00000000000-20210720T113707Z-avarab@gmail.com>
A re-roll of v3 which should fix all outstanding issues &
feedback. Thanks SZEDER & Taylor:
https://lore.kernel.org/git/cover-0.6-00000000000-20210720T113707Z-avarab@gmail.com/
I dropped this myself because per
https://lore.kernel.org/git/87im14unfd.fsf@evledraar.gmail.com/ I was
under the impression that Taylor was intending to pick up these
patches as part of some more generale usage() fixes of his (which also
touched multi-pack-index.c), but his recent changes to fix
multi-pack-index.c didn't pick this up, so here it is as a re-roll instead.
Ævar Arnfjörð Bjarmason (7):
commit-graph: define common usage with a macro
commit-graph: remove redundant handling of -h
commit-graph: use parse_options_concat()
multi-pack-index: refactor "goto usage" pattern
commit-graph: early exit to "usage" on !argc
commit-graph: show usage on "commit-graph [write|verify] garbage"
commit-graph: show "unexpected subcommand" error
builtin/commit-graph.c | 90 +++++++++++++++++++++-----------------
builtin/multi-pack-index.c | 11 +++--
t/t5318-commit-graph.sh | 19 ++++++++
3 files changed, 74 insertions(+), 46 deletions(-)
Range-diff against v3:
1: 1b9b4703ce2 = 1: ef37a8243c8 commit-graph: define common usage with a macro
2: 8f50750ae5e = 2: bbed18ff193 commit-graph: remove redundant handling of -h
3: f02da994363 = 3: 32cc0d1c7bc commit-graph: use parse_options_concat()
4: 6e9bd877866 ! 4: 087f98bbec6 multi-pack-index: refactor "goto usage" pattern
@@ Commit message
Refactor the "goto usage" pattern added in
cd57bc41bbc (builtin/multi-pack-index.c: display usage on unrecognized
- command, 2021-03-30) to maintain the same brevity, but doesn't run
- afoul of the recommendation in CodingGuidelines about braces:
+ command, 2021-03-30) and 88617d11f9d (multi-pack-index: fix potential
+ segfault without sub-command, 2021-07-19) to maintain the same
+ brevity, but in a form that doesn't run afoul of the recommendation in
+ CodingGuidelines about braces:
When there are multiple arms to a conditional and some of them
require braces, enclose even a single line block in braces for
@@ builtin/multi-pack-index.c: int cmd_multi_pack_index(int argc, const char **argv
else if (!strcmp(argv[0], "expire"))
return cmd_multi_pack_index_expire(argc, argv);
- else {
+- error(_("unrecognized subcommand: %s"), argv[0]);
+
++ error(_("unrecognized subcommand: %s"), argv[0]);
usage:
-- error(_("unrecognized subcommand: %s"), argv[0]);
- usage_with_options(builtin_multi_pack_index_usage,
- builtin_multi_pack_index_options);
- }
-+ error(_("unrecognized subcommand: %s"), argv[0]);
+ usage_with_options(builtin_multi_pack_index_usage,
+ builtin_multi_pack_index_options);
}
5: 7acb4bd75ce = 5: 2983e16ba69 commit-graph: early exit to "usage" on !argc
6: 5c1694e071e ! 6: 85552a6f88c commit-graph: show usage on "commit-graph [write|verify] garbage"
@@ Metadata
## Commit message ##
commit-graph: show usage on "commit-graph [write|verify] garbage"
- Change the parse_options() invocation in the commit-graph code to make
- sense. We're calling it twice, once for common options parsing, and
- then for the sub-commands.
+ Change the parse_options() invocation in the commit-graph code to
+ error on unknown leftover argv elements, in addition to the existing
+ and implicit erroring via parse_options() on unknown options.
- But we never checked if we had something leftover in argc in "write"
- or "verify", as a result we'd silently accept garbage in these
- subcommands. Let's not do that.
+ We'd already error in cmd_commit_graph() on e.g.:
+
+ git commit-graph unknown verify
+ git commit-graph --unknown verify
+
+ But here we're calling parse_options() twice more for the "write" and
+ "verify" subcommands. We did not do the same checking for leftover
+ argv elements there. As a result we'd silently accept garbage in these
+ subcommands, let's not do that.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
## builtin/commit-graph.c ##
@@ builtin/commit-graph.c: static int graph_verify(int argc, const char **argv)
- opts.progress = isatty(2);
argc = parse_options(argc, argv, NULL,
options,
-- builtin_commit_graph_verify_usage, 0);
-+ builtin_commit_graph_verify_usage,
-+ PARSE_OPT_KEEP_UNKNOWN);
+ builtin_commit_graph_verify_usage, 0);
+ if (argc)
+ usage_with_options(builtin_commit_graph_verify_usage, options);
if (!opts.obj_dir)
opts.obj_dir = get_object_directory();
@@ builtin/commit-graph.c: static int graph_write(int argc, const char **argv)
-
argc = parse_options(argc, argv, NULL,
options,
-- builtin_commit_graph_write_usage, 0);
-+ builtin_commit_graph_write_usage,
-+ PARSE_OPT_KEEP_UNKNOWN);
+ builtin_commit_graph_write_usage, 0);
+ if (argc)
+ usage_with_options(builtin_commit_graph_write_usage, options);
-: ----------- > 7: 962521cfa17 commit-graph: show "unexpected subcommand" error
--
2.33.0.662.gbc81f8cbdca
next prev parent reply other threads:[~2021-08-23 12:30 UTC|newest]
Thread overview: 40+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-18 7:58 [PATCH v2 0/5] commit-graph: usage fixes Ævar Arnfjörð Bjarmason
2021-07-18 7:58 ` [PATCH v2 1/5] commit-graph: define common usage with a macro Ævar Arnfjörð Bjarmason
2021-07-19 16:29 ` Taylor Blau
2021-07-18 7:58 ` [PATCH v2 2/5] commit-graph: remove redundant handling of -h Ævar Arnfjörð Bjarmason
2021-07-18 12:55 ` Andrei Rybak
2021-07-19 16:34 ` Taylor Blau
2021-07-18 7:58 ` [PATCH v2 3/5] commit-graph: use parse_options_concat() Ævar Arnfjörð Bjarmason
2021-07-19 16:50 ` Taylor Blau
2021-07-20 11:31 ` Ævar Arnfjörð Bjarmason
2021-07-18 7:58 ` [PATCH v2 4/5] commit-graph: early exit to "usage" on !argc Ævar Arnfjörð Bjarmason
2021-07-19 16:55 ` Taylor Blau
2021-07-18 7:58 ` [PATCH v2 5/5] commit-graph: show usage on "commit-graph [write|verify] garbage" Ævar Arnfjörð Bjarmason
2021-07-19 16:53 ` Taylor Blau
2021-07-20 11:39 ` [PATCH v3 0/6] commit-graph: usage fixes Ævar Arnfjörð Bjarmason
2021-07-20 11:39 ` [PATCH v3 1/6] commit-graph: define common usage with a macro Ævar Arnfjörð Bjarmason
2021-07-20 11:39 ` [PATCH v3 2/6] commit-graph: remove redundant handling of -h Ævar Arnfjörð Bjarmason
2021-07-20 11:39 ` [PATCH v3 3/6] commit-graph: use parse_options_concat() Ævar Arnfjörð Bjarmason
2021-07-20 11:39 ` [PATCH v3 4/6] multi-pack-index: refactor "goto usage" pattern Ævar Arnfjörð Bjarmason
2021-07-20 18:14 ` Taylor Blau
2021-07-20 11:39 ` [PATCH v3 5/6] commit-graph: early exit to "usage" on !argc Ævar Arnfjörð Bjarmason
2021-07-20 18:17 ` Taylor Blau
2021-07-20 11:39 ` [PATCH v3 6/6] commit-graph: show usage on "commit-graph [write|verify] garbage" Ævar Arnfjörð Bjarmason
2021-07-20 17:47 ` SZEDER Gábor
2021-07-20 17:55 ` SZEDER Gábor
2021-07-20 18:24 ` Taylor Blau
2021-07-20 21:17 ` Ævar Arnfjörð Bjarmason
2021-07-20 21:47 ` Taylor Blau
2021-07-21 7:26 ` Ævar Arnfjörð Bjarmason
2021-07-21 8:08 ` Jeff King
2021-07-21 16:54 ` Junio C Hamano
2021-08-23 12:30 ` Ævar Arnfjörð Bjarmason [this message]
2021-08-23 12:30 ` [PATCH v4 1/7] commit-graph: define common usage with a macro Ævar Arnfjörð Bjarmason
2021-08-23 12:30 ` [PATCH v4 2/7] commit-graph: remove redundant handling of -h Ævar Arnfjörð Bjarmason
2021-08-23 12:30 ` [PATCH v4 3/7] commit-graph: use parse_options_concat() Ævar Arnfjörð Bjarmason
2021-08-23 12:30 ` [PATCH v4 4/7] multi-pack-index: refactor "goto usage" pattern Ævar Arnfjörð Bjarmason
2021-08-23 12:30 ` [PATCH v4 5/7] commit-graph: early exit to "usage" on !argc Ævar Arnfjörð Bjarmason
2021-08-23 12:30 ` [PATCH v4 6/7] commit-graph: show usage on "commit-graph [write|verify] garbage" Ævar Arnfjörð Bjarmason
2021-08-23 12:30 ` [PATCH v4 7/7] commit-graph: show "unexpected subcommand" error Ævar Arnfjörð Bjarmason
2021-08-30 23:54 ` [PATCH v4 0/7] commit-graph: usage fixes Taylor Blau
2021-08-30 23:58 ` Junio C Hamano
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=cover-v4-0.7-00000000000-20210823T122854Z-avarab@gmail.com \
--to=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.com \
--cc=peff@peff.net \
--cc=rybak.a.v@gmail.com \
--cc=stolee@gmail.com \
--cc=szeder.dev@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.
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).