d4056dba1f
Fix the incorrect "[-o | --option <argument>]" syntax, which should be "[(-o | --option) <argument>]", we were previously claiming that only the long option accepted the "<argument>", which isn't what we meant. This syntax issue for "bugreport" originated in238b439d69(bugreport: add tool to generate debugging info, 2020-04-16), and for "diagnose" in6783fd3cef(builtin/diagnose.c: create 'git diagnose' builtin, 2022-08-12), which copied and adjusted "bugreport" documentation and code. In the case of "Documentation/git-stash.txt" and "builtin/stash.c" this is not a "doc txt & -h consistency" change, as we're changing both versions, doing so here makes a subsequent change smaller. In that case fix the incorrect "[-o | --option <argument>]" syntax, which should be "[(-o | --option) <argument>]", we were previously claiming that only the long option accepted the "<argument>", which isn't what we meant. The "stash" issue has been with us in both the "-h" and *.txt versions sincebd514cada4(stash: introduce 'git stash store', 2013-06-15). We could claim that this isn't a syntax issue if a "vertical bar binds tighter than option and its argument", but such a rule would change e.g. this "cat-file" SYNOPSIS example to mean something we don't: ... [<rev>:<path|tree-ish> | --path=<path|tree-ish> <rev>] We have various other examples where the post-image here is already used, e.g. for "format-patch" ("-o"), "grep" ("-m"), "submodule" ("set-branch -b") etc. Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
63 lines
1.8 KiB
C
63 lines
1.8 KiB
C
#include "builtin.h"
|
|
#include "parse-options.h"
|
|
#include "diagnose.h"
|
|
|
|
static const char * const diagnose_usage[] = {
|
|
N_("git diagnose [(-o|--output-directory) <path>] [(-s|--suffix) <format>]\n"
|
|
" [--mode=<mode>]"),
|
|
NULL
|
|
};
|
|
|
|
int cmd_diagnose(int argc, const char **argv, const char *prefix)
|
|
{
|
|
struct strbuf zip_path = STRBUF_INIT;
|
|
time_t now = time(NULL);
|
|
struct tm tm;
|
|
enum diagnose_mode mode = DIAGNOSE_STATS;
|
|
char *option_output = NULL;
|
|
char *option_suffix = "%Y-%m-%d-%H%M";
|
|
char *prefixed_filename;
|
|
|
|
const struct option diagnose_options[] = {
|
|
OPT_STRING('o', "output-directory", &option_output, N_("path"),
|
|
N_("specify a destination for the diagnostics archive")),
|
|
OPT_STRING('s', "suffix", &option_suffix, N_("format"),
|
|
N_("specify a strftime format suffix for the filename")),
|
|
OPT_CALLBACK_F(0, "mode", &mode, N_("(stats|all)"),
|
|
N_("specify the content of the diagnostic archive"),
|
|
PARSE_OPT_NONEG, option_parse_diagnose),
|
|
OPT_END()
|
|
};
|
|
|
|
argc = parse_options(argc, argv, prefix, diagnose_options,
|
|
diagnose_usage, 0);
|
|
|
|
/* Prepare the path to put the result */
|
|
prefixed_filename = prefix_filename(prefix,
|
|
option_output ? option_output : "");
|
|
strbuf_addstr(&zip_path, prefixed_filename);
|
|
strbuf_complete(&zip_path, '/');
|
|
|
|
strbuf_addstr(&zip_path, "git-diagnostics-");
|
|
strbuf_addftime(&zip_path, option_suffix, localtime_r(&now, &tm), 0, 0);
|
|
strbuf_addstr(&zip_path, ".zip");
|
|
|
|
switch (safe_create_leading_directories(zip_path.buf)) {
|
|
case SCLD_OK:
|
|
case SCLD_EXISTS:
|
|
break;
|
|
default:
|
|
die_errno(_("could not create leading directories for '%s'"),
|
|
zip_path.buf);
|
|
}
|
|
|
|
/* Prepare diagnostics */
|
|
if (create_diagnostics_archive(&zip_path, mode))
|
|
die_errno(_("unable to create diagnostics archive %s"),
|
|
zip_path.buf);
|
|
|
|
free(prefixed_filename);
|
|
strbuf_release(&zip_path);
|
|
return 0;
|
|
}
|