]> git.ipfire.org Git - thirdparty/git.git/commitdiff
oddballs: send usage() help text to standard output
authorJunio C Hamano <gitster@pobox.com>
Thu, 16 Jan 2025 21:35:52 +0000 (13:35 -0800)
committerJunio C Hamano <gitster@pobox.com>
Fri, 17 Jan 2025 21:30:03 +0000 (13:30 -0800)
Using the show_usage_if_asked() helper we introduced earlier, fix
callers of usage() that want to show the help text when explicitly
asked by the end-user.  The help text now goes to the standard
output stream for them.

The callers in this step are oddballs in that their invocations of
usage() are *not* guarded by

if (argc == 2 && !strcmp(argv[1], "-h")
usage(...);

There are (unnecessarily) being clever ones that do things like

if (argc != 2 || !strcmp(argv[1], "-h")
usage(...);

to say "I know I take only one argument, so argc != 2 is always an
error regardless of what is in argv[].  Ah, by the way, even if argc
is 2, "-h" is a request for usage text, so we do the same".

Some like "git var -h" just do not treat "-h" any specially, and let
it take the same error code paths as a parameter error.

Now we cannot do the same, so these callers are rewrittin to do the
show_usage_and_exit_if_asked() first and then handle the usage error
the way they used to.

Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/credential.c
builtin/fetch-pack.c
builtin/unpack-file.c
builtin/upload-archive.c
builtin/var.c

index 14c8c6608b2fbd7091a11c14537d08783d5c281d..f6fc9481237d2eb7eac32e124a5c97c1ae078be6 100644 (file)
@@ -18,7 +18,8 @@ int cmd_credential(int argc,
 
        git_config(git_default_config, NULL);
 
-       if (argc != 2 || !strcmp(argv[1], "-h"))
+       show_usage_if_asked(argc, argv, usage_msg);
+       if (argc != 2)
                usage(usage_msg);
        op = argv[1];
 
index bed2816c2d4a2167ecae6cb0c472493aa032aa94..d07eec9e5550ab919f938b9a24fda7b6a94d1dc6 100644 (file)
@@ -75,6 +75,8 @@ int cmd_fetch_pack(int argc,
        list_objects_filter_init(&args.filter_options);
        args.uploadpack = "git-upload-pack";
 
+       show_usage_if_asked(argc, argv, fetch_pack_usage);
+
        for (i = 1; i < argc && *argv[i] == '-'; i++) {
                const char *arg = argv[i];
 
index 6da282575391b94c4b2a908eee3223a81d4a9ff1..fb5fcbc40a86d674cf48a7ea086e356238ddee3e 100644 (file)
@@ -26,6 +26,9 @@ static char *create_temp_file(struct object_id *oid)
        return path;
 }
 
+static const char usage_msg[] =
+"git unpack-file <blob>";
+
 int cmd_unpack_file(int argc,
                    const char **argv,
                    const char *prefix UNUSED,
@@ -33,8 +36,9 @@ int cmd_unpack_file(int argc,
 {
        struct object_id oid;
 
-       if (argc != 2 || !strcmp(argv[1], "-h"))
-               usage("git unpack-file <blob>");
+       show_usage_if_asked(argc, argv, usage_msg);
+       if (argc != 2)
+               usage(usage_msg);
        if (repo_get_oid(the_repository, argv[1], &oid))
                die("Not a valid object name %s", argv[1]);
 
index 9e9343f1213be72942ddebe9fa691b97e7d3b3fa..9d76a31c8f5d9ac968c5e160e6dcc54f998eca8a 100644 (file)
@@ -27,7 +27,8 @@ int cmd_upload_archive_writer(int argc,
        const char *arg_cmd = "argument ";
        int ret;
 
-       if (argc != 2 || !strcmp(argv[1], "-h"))
+       show_usage_if_asked(argc, argv, upload_archive_usage);
+       if (argc != 2)
                usage(upload_archive_usage);
 
        if (!enter_repo(argv[1], 0))
index 1449656cc924f849ee9c881c18b734a3ec55e9f3..46d40d6fba65d7e3e6bbd7f4a9fc48a2dde607ac 100644 (file)
@@ -221,6 +221,7 @@ int cmd_var(int argc,
        const struct git_var *git_var;
        char *val;
 
+       show_usage_if_asked(argc, argv, var_usage);
        if (argc != 2)
                usage(var_usage);