mirror of
https://github.com/git/git
synced 2024-08-28 20:20:07 +00:00
![Calvin Wan](/assets/img/avatar_default.png)
Signed-off-by: Calvin Wan <calvinwan@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
196 lines
5.5 KiB
C
196 lines
5.5 KiB
C
#include "builtin.h"
|
|
#include "abspath.h"
|
|
#include "editor.h"
|
|
#include "gettext.h"
|
|
#include "parse-options.h"
|
|
#include "strbuf.h"
|
|
#include "help.h"
|
|
#include "compat/compiler.h"
|
|
#include "hook.h"
|
|
#include "hook-list.h"
|
|
#include "diagnose.h"
|
|
#include "object-file.h"
|
|
#include "setup.h"
|
|
|
|
static void get_system_info(struct strbuf *sys_info)
|
|
{
|
|
struct utsname uname_info;
|
|
char *shell = NULL;
|
|
|
|
/* get git version from native cmd */
|
|
strbuf_addstr(sys_info, _("git version:\n"));
|
|
get_version_info(sys_info, 1);
|
|
|
|
/* system call for other version info */
|
|
strbuf_addstr(sys_info, "uname: ");
|
|
if (uname(&uname_info))
|
|
strbuf_addf(sys_info, _("uname() failed with error '%s' (%d)\n"),
|
|
strerror(errno),
|
|
errno);
|
|
else
|
|
strbuf_addf(sys_info, "%s %s %s %s\n",
|
|
uname_info.sysname,
|
|
uname_info.release,
|
|
uname_info.version,
|
|
uname_info.machine);
|
|
|
|
strbuf_addstr(sys_info, _("compiler info: "));
|
|
get_compiler_info(sys_info);
|
|
|
|
strbuf_addstr(sys_info, _("libc info: "));
|
|
get_libc_info(sys_info);
|
|
|
|
shell = getenv("SHELL");
|
|
strbuf_addf(sys_info, "$SHELL (typically, interactive shell): %s\n",
|
|
shell ? shell : "<unset>");
|
|
}
|
|
|
|
static void get_populated_hooks(struct strbuf *hook_info, int nongit)
|
|
{
|
|
const char **p;
|
|
|
|
if (nongit) {
|
|
strbuf_addstr(hook_info,
|
|
_("not run from a git repository - no hooks to show\n"));
|
|
return;
|
|
}
|
|
|
|
for (p = hook_name_list; *p; p++) {
|
|
const char *hook = *p;
|
|
|
|
if (hook_exists(hook))
|
|
strbuf_addf(hook_info, "%s\n", hook);
|
|
}
|
|
}
|
|
|
|
static const char * const bugreport_usage[] = {
|
|
N_("git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]\n"
|
|
" [--diagnose[=<mode>]]"),
|
|
NULL
|
|
};
|
|
|
|
static int get_bug_template(struct strbuf *template)
|
|
{
|
|
const char template_text[] = N_(
|
|
"Thank you for filling out a Git bug report!\n"
|
|
"Please answer the following questions to help us understand your issue.\n"
|
|
"\n"
|
|
"What did you do before the bug happened? (Steps to reproduce your issue)\n"
|
|
"\n"
|
|
"What did you expect to happen? (Expected behavior)\n"
|
|
"\n"
|
|
"What happened instead? (Actual behavior)\n"
|
|
"\n"
|
|
"What's different between what you expected and what actually happened?\n"
|
|
"\n"
|
|
"Anything else you want to add:\n"
|
|
"\n"
|
|
"Please review the rest of the bug report below.\n"
|
|
"You can delete any lines you don't wish to share.\n");
|
|
|
|
strbuf_addstr(template, _(template_text));
|
|
return 0;
|
|
}
|
|
|
|
static void get_header(struct strbuf *buf, const char *title)
|
|
{
|
|
strbuf_addf(buf, "\n\n[%s]\n", title);
|
|
}
|
|
|
|
int cmd_bugreport(int argc, const char **argv, const char *prefix)
|
|
{
|
|
struct strbuf buffer = STRBUF_INIT;
|
|
struct strbuf report_path = STRBUF_INIT;
|
|
int report = -1;
|
|
time_t now = time(NULL);
|
|
struct tm tm;
|
|
enum diagnose_mode diagnose = DIAGNOSE_NONE;
|
|
char *option_output = NULL;
|
|
char *option_suffix = "%Y-%m-%d-%H%M";
|
|
const char *user_relative_path = NULL;
|
|
char *prefixed_filename;
|
|
size_t output_path_len;
|
|
int ret;
|
|
|
|
const struct option bugreport_options[] = {
|
|
OPT_CALLBACK_F(0, "diagnose", &diagnose, N_("mode"),
|
|
N_("create an additional zip archive of detailed diagnostics (default 'stats')"),
|
|
PARSE_OPT_OPTARG, option_parse_diagnose),
|
|
OPT_STRING('o', "output-directory", &option_output, N_("path"),
|
|
N_("specify a destination for the bugreport file(s)")),
|
|
OPT_STRING('s', "suffix", &option_suffix, N_("format"),
|
|
N_("specify a strftime format suffix for the filename(s)")),
|
|
OPT_END()
|
|
};
|
|
|
|
argc = parse_options(argc, argv, prefix, bugreport_options,
|
|
bugreport_usage, 0);
|
|
|
|
/* Prepare the path to put the result */
|
|
prefixed_filename = prefix_filename(prefix,
|
|
option_output ? option_output : "");
|
|
strbuf_addstr(&report_path, prefixed_filename);
|
|
strbuf_complete(&report_path, '/');
|
|
output_path_len = report_path.len;
|
|
|
|
strbuf_addstr(&report_path, "git-bugreport-");
|
|
strbuf_addftime(&report_path, option_suffix, localtime_r(&now, &tm), 0, 0);
|
|
strbuf_addstr(&report_path, ".txt");
|
|
|
|
switch (safe_create_leading_directories(report_path.buf)) {
|
|
case SCLD_OK:
|
|
case SCLD_EXISTS:
|
|
break;
|
|
default:
|
|
die(_("could not create leading directories for '%s'"),
|
|
report_path.buf);
|
|
}
|
|
|
|
/* Prepare diagnostics, if requested */
|
|
if (diagnose != DIAGNOSE_NONE) {
|
|
struct strbuf zip_path = STRBUF_INIT;
|
|
strbuf_add(&zip_path, report_path.buf, output_path_len);
|
|
strbuf_addstr(&zip_path, "git-diagnostics-");
|
|
strbuf_addftime(&zip_path, option_suffix, localtime_r(&now, &tm), 0, 0);
|
|
strbuf_addstr(&zip_path, ".zip");
|
|
|
|
if (create_diagnostics_archive(&zip_path, diagnose))
|
|
die_errno(_("unable to create diagnostics archive %s"), zip_path.buf);
|
|
|
|
strbuf_release(&zip_path);
|
|
}
|
|
|
|
/* Prepare the report contents */
|
|
get_bug_template(&buffer);
|
|
|
|
get_header(&buffer, _("System Info"));
|
|
get_system_info(&buffer);
|
|
|
|
get_header(&buffer, _("Enabled Hooks"));
|
|
get_populated_hooks(&buffer, !startup_info->have_repository);
|
|
|
|
/* fopen doesn't offer us an O_EXCL alternative, except with glibc. */
|
|
report = xopen(report_path.buf, O_CREAT | O_EXCL | O_WRONLY, 0666);
|
|
|
|
if (write_in_full(report, buffer.buf, buffer.len) < 0)
|
|
die_errno(_("unable to write to %s"), report_path.buf);
|
|
|
|
close(report);
|
|
|
|
/*
|
|
* We want to print the path relative to the user, but we still need the
|
|
* path relative to us to give to the editor.
|
|
*/
|
|
if (!(prefix && skip_prefix(report_path.buf, prefix, &user_relative_path)))
|
|
user_relative_path = report_path.buf;
|
|
fprintf(stderr, _("Created new report at '%s'.\n"),
|
|
user_relative_path);
|
|
|
|
free(prefixed_filename);
|
|
strbuf_release(&buffer);
|
|
|
|
ret = !!launch_editor(report_path.buf, NULL, NULL);
|
|
strbuf_release(&report_path);
|
|
return ret;
|
|
}
|