admin/git
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

builtin/diagnose.c: create 'git diagnose' builtin

Browse Source 
Create a 'git diagnose' builtin to generate a standalone zip archive of
repository diagnostics.

The "diagnose" functionality was originally implemented for Scalar in
aa5c79a331 (scalar: implement `scalar diagnose`, 2022-05-28). However, the
diagnostics gathered are not specific to Scalar-cloned repositories and
can be useful when diagnosing issues in any Git repository.

Helped-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Helped-by: Derrick Stolee <derrickstolee@github.com>
Signed-off-by: Victoria Dye <vdye@github.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Victoria Dye
2022-08-12 20:10:15 +00:00
committed by Junio C Hamano
parent 33cba726f0
commit 6783fd3cef
7 changed files with 143 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
builtin/diagnose.c Normal file
View File

@@ -0,0 +1,57 @@
#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>]"),
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;
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_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, DIAGNOSE_STATS))
die_errno(_("unable to create diagnostics archive %s"),
zip_path.buf);
free(prefixed_filename);
strbuf_release(&zip_path);
return 0;
}