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

builtin/diagnose.c: add '--mode' option

Browse Source 
Create '--mode=<mode>' option in 'git diagnose' to allow users to optionally
select non-default diagnostic information to include in the output archive.
Additionally, document the currently-available modes, emphasizing the
importance of not sharing a '--mode=all' archive publicly due to the
presence of sensitive information.

Note that the option parsing callback - 'option_parse_diagnose()' - is added
to 'diagnose.c' rather than 'builtin/diagnose.c' so that it may be reused in
future callers configuring a diagnostics archive.

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:16 +00:00
committed by Junio C Hamano
parent 6783fd3cef
commit 7ecf193f7d
5 changed files with 84 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
builtin/diagnose.c
View File

@@ -3,7 +3,7 @@
#include "diagnose.h"
static const char * const diagnose_usage[] = {
N_("git diagnose [-o|--output-directory <path>] [-s|--suffix <format>]"),
N_("git diagnose [-o|--output-directory <path>] [-s|--suffix <format>] [--mode=<mode>]"),
NULL
};
@@ -12,6 +12,7 @@ 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;
@@ -21,6 +22,9 @@ int cmd_diagnose(int argc, const char **argv, const char *prefix)
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()
};
@@ -47,7 +51,7 @@ int cmd_diagnose(int argc, const char **argv, const char *prefix)
}
/* Prepare diagnostics */
if (create_diagnostics_archive(&zip_path, DIAGNOSE_STATS))
if (create_diagnostics_archive(&zip_path, mode))
die_errno(_("unable to create diagnostics archive %s"),
zip_path.buf);