From patchwork Mon Mar 23 21:43:38 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Emily Shaffer X-Patchwork-Id: 11454061 Return-Path: Received: from mail.kernel.org (pdx-korg-mail-1.web.codeaurora.org [172.30.200.123]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id B5716913 for ; Mon, 23 Mar 2020 21:43:59 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 8DAFD20753 for ; Mon, 23 Mar 2020 21:43:59 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=google.com header.i=@google.com header.b="WRvnaND+" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727105AbgCWVn6 (ORCPT ); Mon, 23 Mar 2020 17:43:58 -0400 Received: from mail-pl1-f202.google.com ([209.85.214.202]:52264 "EHLO mail-pl1-f202.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1727093AbgCWVn6 (ORCPT ); Mon, 23 Mar 2020 17:43:58 -0400 Received: by mail-pl1-f202.google.com with SMTP id 64so10507021plf.19 for ; Mon, 23 Mar 2020 14:43:55 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20161025; h=date:in-reply-to:message-id:mime-version:references:subject:from:to :cc; bh=cOcOWx/TGBbCwNH722vWiHG74pNEE+TGR9lWvLDDMic=; b=WRvnaND+WCgcijZjaYgFSs4sIWXXUYRGHT3gtyL9HUqIM1V6poCU5sz9hSJiw80xjl T0AomMb/n1OW0TXNE5f/1K3CL5pL4KIO4xQe2qo4agCwMzs1bNlauq86ZioWWy9jyunz VG68g930TopIKIMpgp+iG0vwrknlD60rCxNIFVsk6eIJVUGHKo1Sqh31HGBXylVw4h0E ovIx8P0tfGQaYtyiEUTbF0fhO3RQQ4zZugQmvJz0kb7wP+KZwB+qNrBi73+RPo2sV08w m7ZnEjv0xeER4jRgWqaZ/YRJjO0otbQLcCCM31JKMR3UEvQPtxAJTcl4D7XcLak6pFtO aGUQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:in-reply-to:message-id:mime-version :references:subject:from:to:cc; bh=cOcOWx/TGBbCwNH722vWiHG74pNEE+TGR9lWvLDDMic=; b=uIRSmGYbKdz4akuhenQzCapmPss4u5sCiXrZbCzB8YIuMHHhMlWlVjTEFHsRLtkMmF lIwHRmPiqPnRv7o/ZQdkIxEY0p9Vck23CSGjF8dvPnD2uQbGve8424+DpkvdQtMDgXtU ile4/KuVK4s9NQxtR/J1VzXjbu9M03jl648k6Fh3Th6OZaNpUr4L5E9fABfNu4WRTojI otpAuNKCNCwlJFbZP7uBml6++7Os85xh6wyQhOkkmYWosbIpAo1fIJsdpdTtUerlxx1H 5ikt5hA0+VzEKsjgkPb7vBD7LCgyQUCH6ku/Hv310y8egi+YYNnwp0aWh721iWmT+wBV gYEg== X-Gm-Message-State: ANhLgQ3eYup+PEE8xInqs3r0qLTXe6D6T6RLJGR9VkECJRoBPbaStgM5 fkg9yo0uuufKQwfe7CGFxJmkqtSV7uFIYA7Esfa29Id3uppWU/lmwPWCYFQUkyBlQlzabAqFexY O0QqTLwgkzdjK6wz/a2QP/Xi/95hk1BrtCQ0QKiv0AifwHZq4yJWwRXE6zuLdE36mjHB+iJJMZQ == X-Google-Smtp-Source: ADFU+vufPEHUvpKBpV6J8/AryqpI/k9om6DATT2DDKTTLbsN905+FUsk5nSBipSFhf3j4SqgEnSvjILRG+g7YAIQKkw= X-Received: by 2002:a17:90a:3a8c:: with SMTP id b12mr1599858pjc.48.1584999834554; Mon, 23 Mar 2020 14:43:54 -0700 (PDT) Date: Mon, 23 Mar 2020 14:43:38 -0700 In-Reply-To: <20200323214340.182724-1-emilyshaffer@google.com> Message-Id: <20200323214340.182724-4-emilyshaffer@google.com> Mime-Version: 1.0 References: <20200323214340.182724-1-emilyshaffer@google.com> X-Mailer: git-send-email 2.25.1.696.g5e7596f4ac-goog Subject: [PATCH v10 3/5] bugreport: gather git version and build info From: Emily Shaffer To: git@vger.kernel.org Cc: Emily Shaffer Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org 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 --- 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 ] [-s|--suffix ]"), @@ -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 []"), @@ -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