git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH v12 3/5] bugreport: gather git version and build info

From
Emily Shaffer <emilyshaffer@google.com>
Date
Apr 6, 2020, 22:45 UTC
Message-ID
<20200406224526.256074-4-emilyshaffer@google.com>
In-Reply-To
<20200406224526.256074-1-emilyshaffer@google.com>

Knowing which version of Git a user has and how it was built allows us to more precisely pin down the circumstances when a certain issue occurs, so teach bugreport how to tell us the same output as 'git version --build-options'.

It's not ideal to directly call 'git version --build-options' because that output goes to stdout. Instead, wrap the version string in a helper within help.[ch] library, and call that helper from within the bugreport library.

Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
---
 Documentation/git-bugreport.txt |  4 +++
 bugreport.c                     | 19 +++++++++++++-
 help.c                          | 46 ++++++++++++++++++++-------------
 help.h                          |  1 +
 4 files changed, 51 insertions(+), 19 deletions(-)
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index 1f9fde5cde..f44ae8cbe7 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -23,6 +23,10 @@ The following information is requested from the user:
  - Expected behavior
  - Actual behavior
 
+The following information is captured automatically:
+
+ - 'git version --build-options'
+
 This tool is invoked via the typical Git setup process, which means that in some
 cases, it might not be able to launch - for example, if a relevant config file
 is unreadable. In this kind of scenario, it may be helpful to manually gather
diff --git a/bugreport.c b/bugreport.c
index f6f53a5e8e..4cdb58bbaa 100644
--- a/bugreport.c
+++ b/bugreport.c
@@ -1,8 +1,17 @@
-#include "builtin.h"
+#include "cache.h"
 #include "parse-options.h"
 #include "stdio.h"
 #include "strbuf.h"
 #include "time.h"
+#include "help.h"
+
+static void get_system_info(struct strbuf *sys_info)
+{
+	/* get git version from native cmd */
+	strbuf_addstr(sys_info, _("git version:\n"));
+	get_version_info(sys_info, 1);
+	strbuf_complete_line(sys_info);
+}
 
 static const char * const bugreport_usage[] = {
 	N_("git bugreport [-o|--output-directory <file>] [-s|--suffix <format>]"),
@@ -32,6 +41,11 @@ static int get_bug_template(struct strbuf *template)
 	return 0;
 }
 
+static void get_header(struct strbuf *buf, const char *title)
+{
+	strbuf_addf(buf, "\n\n[%s]\n", title);
+}
+
 int cmd_main(int argc, const char **argv)
 {
 	struct strbuf buffer = STRBUF_INIT;
@@ -79,6 +93,9 @@ int cmd_main(int argc, const char **argv)
 	/* Prepare the report contents */
 	get_bug_template(&buffer);
 
+	get_header(&buffer, _("System Info"));
+	get_system_info(&buffer);
+
 	/* fopen doesn't offer us an O_EXCL alternative, except with glibc. */
 	report = open(report_path.buf, O_CREAT | O_EXCL | O_WRONLY, 0666);
 
diff --git a/help.c b/help.c
index a21487db77..1de9c0d589 100644
--- a/help.c
+++ b/help.c
@@ -622,8 +622,32 @@ const char *help_unknown_cmd(const char *cmd)
 	exit(1);
 }
 
+void get_version_info(struct strbuf *buf, int show_build_options)
+{
+	/*
+	 * The format of this string should be kept stable for compatibility
+	 * with external projects that rely on the output of "git version".
+	 *
+	 * Always show the version, even if other options are given.
+	 */
+	strbuf_addf(buf, "git version %s\n", git_version_string);
+
+	if (show_build_options) {
+		strbuf_addf(buf, "cpu: %s\n", GIT_HOST_CPU);
+		if (git_built_from_commit_string[0])
+			strbuf_addf(buf, "built from commit: %s\n",
+			       git_built_from_commit_string);
+		else
+			strbuf_addstr(buf, "no commit associated with this build\n");
+		strbuf_addf(buf, "sizeof-long: %d\n", (int)sizeof(long));
+		strbuf_addf(buf, "sizeof-size_t: %d\n", (int)sizeof(size_t));
+		/* NEEDSWORK: also save and output GIT-BUILD_OPTIONS? */
+	}
+}
+
 int cmd_version(int argc, const char **argv, const char *prefix)
 {
+	struct strbuf buf = STRBUF_INIT;
 	int build_options = 0;
 	const char * const usage[] = {
 		N_("git version [<options>]"),
@@ -637,25 +661,11 @@ int cmd_version(int argc, const char **argv, const char *prefix)
 
 	argc = parse_options(argc, argv, prefix, options, usage, 0);
 
-	/*
-	 * The format of this string should be kept stable for compatibility
-	 * with external projects that rely on the output of "git version".
-	 *
-	 * Always show the version, even if other options are given.
-	 */
-	printf("git version %s\n", git_version_string);
+	get_version_info(&buf, build_options);
+	printf("%s", buf.buf);
+
+	strbuf_release(&buf);
 
-	if (build_options) {
-		printf("cpu: %s\n", GIT_HOST_CPU);
-		if (git_built_from_commit_string[0])
-			printf("built from commit: %s\n",
-			       git_built_from_commit_string);
-		else
-			printf("no commit associated with this build\n");
-		printf("sizeof-long: %d\n", (int)sizeof(long));
-		printf("sizeof-size_t: %d\n", (int)sizeof(size_t));
-		/* NEEDSWORK: also save and output GIT-BUILD_OPTIONS? */
-	}
 	return 0;
 }
 
diff --git a/help.h b/help.h
index 9071894e8c..500521b908 100644
--- a/help.h
+++ b/help.h
@@ -37,6 +37,7 @@ void add_cmdname(struct cmdnames *cmds, const char *name, int len);
 void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes);
 int is_in_cmdlist(struct cmdnames *cmds, const char *name);
 void list_commands(unsigned int colopts, struct cmdnames *main_cmds, struct cmdnames *other_cmds);
+void get_version_info(struct strbuf *buf, int show_build_options);
 
 /*
  * call this to die(), when it is suspected that the user mistyped a

-- 
2.26.0.292.g33ef6b2f38-goog
Previous: Emily ShafferNext: Junio C Hamano
Message 20 of 32 in “add git-bugreport tool”
  1. 0/5 add git-bugreport toolEmily Shaffer, Mar 23, 2020
  2. 1/5 help: move list_config_help to builtin/helpEmily Shaffer, Mar 23, 2020
  3. 2/5 bugreport: add tool to generate debugging infoEmily Shaffer, Mar 23, 2020
  4. 3/5 bugreport: gather git version and build infoEmily Shaffer, Mar 23, 2020
  5. 4/5 bugreport: add uname infoEmily Shaffer, Mar 23, 2020
  6. 5/5 bugreport: add compiler infoEmily Shaffer, Mar 23, 2020
  7. Junio C HamanoMar 23, 2020
  8. Emily ShafferMar 25, 2020
  9. 0/5 add git-bugreport toolEmily Shaffer, Mar 25, 2020
  10. 1/5 help: move list_config_help to builtin/helpEmily Shaffer, Mar 25, 2020
  11. 2/5 bugreport: add tool to generate debugging infoEmily Shaffer, Mar 25, 2020
  12. SZEDER GáborApr 1, 2020
  13. 3/5 bugreport: gather git version and build infoEmily Shaffer, Mar 25, 2020
  14. 4/5 bugreport: add uname infoEmily Shaffer, Mar 25, 2020
  15. 5/5 bugreport: add compiler infoEmily Shaffer, Mar 25, 2020
  16. 0/5 bugreport: add tool to generate debugging infoEmily Shaffer, Apr 6, 2020
  17. 1/5 help: move list_config_help to builtin/helpEmily Shaffer, Apr 6, 2020
  18. Junio C HamanoApr 6, 2020
  19. 2/5 bugreport: add tool to generate debugging infoEmily Shaffer, Apr 6, 2020
  20. 3/5 bugreport: gather git version and build infoEmily Shaffer, Apr 6, 2020
  21. Junio C HamanoApr 6, 2020
  22. Emily ShafferApr 7, 2020
  23. Junio C HamanoApr 7, 2020
  24. Emily ShafferApr 7, 2020
  25. 4/5 bugreport: add uname infoEmily Shaffer, Apr 6, 2020
  26. Junio C HamanoApr 6, 2020
  27. 5/5 bugreport: add compiler infoEmily Shaffer, Apr 6, 2020
  28. Junio C HamanoApr 6, 2020
  29. Danh DoanApr 6, 2020
  30. Junio C HamanoApr 7, 2020
  31. Emily ShafferApr 7, 2020
  32. Junio C HamanoApr 7, 2020

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.