* [PATCH] test-tool: show tool list on error
@ 2018-10-17 9:25 Jeff King
2018-10-17 13:02 ` Derrick Stolee
0 siblings, 1 reply; 2+ messages in thread
From: Jeff King @ 2018-10-17 9:25 UTC (permalink / raw)
To: git
Before we switched to one big test-tool binary, if you
forgot the name of a tool, you could use tab-completion in
the shell to get a hint. But these days, all you get is:
$ t/helper/test-tool approxidate
fatal: There is no test named 'approxidate'
and you're stuck reading the source code to find it. Let's
print a list of the available tools in this case.
Signed-off-by: Jeff King <peff@peff.net>
---
Not really user-facing, but this bugged me enough earlier to write the
patch. ;)
Some of the individual tools have nice help, too (try
"t/helper/test-tool date", which shows the approxidate command I was
looking for), but some of them could probably stand to improve their
friendliness (try "t/helper/test-tool config"). I think it's fine for
people to improve them over time if and when they get annoyed.
t/helper/test-tool.c | 15 +++++++++++++--
1 file changed, 13 insertions(+), 2 deletions(-)
diff --git a/t/helper/test-tool.c b/t/helper/test-tool.c
index 6b5836dc1b..5df8b682aa 100644
--- a/t/helper/test-tool.c
+++ b/t/helper/test-tool.c
@@ -55,13 +55,23 @@ static struct test_cmd cmds[] = {
{ "write-cache", cmd__write_cache },
};
+static NORETURN void die_usage(void)
+{
+ size_t i;
+
+ fprintf(stderr, "usage: test-tool <toolname> [args]\n");
+ for (i = 0; i < ARRAY_SIZE(cmds); i++)
+ fprintf(stderr, " %s\n", cmds[i].name);
+ exit(128);
+}
+
int cmd_main(int argc, const char **argv)
{
int i;
BUG_exit_code = 99;
if (argc < 2)
- die("I need a test name!");
+ die_usage();
for (i = 0; i < ARRAY_SIZE(cmds); i++) {
if (!strcmp(cmds[i].name, argv[1])) {
@@ -70,5 +80,6 @@ int cmd_main(int argc, const char **argv)
return cmds[i].fn(argc, argv);
}
}
- die("There is no test named '%s'", argv[1]);
+ error("there is no tool named '%s'", argv[1]);
+ die_usage();
}
--
2.19.1.790.g519f91cad4
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] test-tool: show tool list on error
2018-10-17 9:25 [PATCH] test-tool: show tool list on error Jeff King
@ 2018-10-17 13:02 ` Derrick Stolee
0 siblings, 0 replies; 2+ messages in thread
From: Derrick Stolee @ 2018-10-17 13:02 UTC (permalink / raw)
To: Jeff King, git
On 10/17/2018 5:25 AM, Jeff King wrote:
> Before we switched to one big test-tool binary, if you
> forgot the name of a tool, you could use tab-completion in
> the shell to get a hint. But these days, all you get is:
>
> $ t/helper/test-tool approxidate
> fatal: There is no test named 'approxidate'
>
> and you're stuck reading the source code to find it. Let's
> print a list of the available tools in this case.
>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> Not really user-facing, but this bugged me enough earlier to write the
> patch. ;)
>
> Some of the individual tools have nice help, too (try
> "t/helper/test-tool date", which shows the approxidate command I was
> looking for), but some of them could probably stand to improve their
> friendliness (try "t/helper/test-tool config"). I think it's fine for
> people to improve them over time if and when they get annoyed.
This will improve contributors' lives! Thanks.
Reviewed-by: Derrick Stolee <dstolee@microsoft.com>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-10-17 13:02 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-10-17 9:25 [PATCH] test-tool: show tool list on error Jeff King
2018-10-17 13:02 ` Derrick Stolee
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).