git-bugreport(1) — Linux manual page


GIT-BUGREPORT(1)               Git Manual               GIT-BUGREPORT(1)

NAME         top

       git-bugreport - Collect information for user to file a bug report

SYNOPSIS         top

       git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>]

DESCRIPTION         top

       Captures information about the user’s machine, Git client, and
       repository state, as well as a form requesting information about
       the behavior the user observed, into a single text file which the
       user can then share, for example to the Git mailing list, in
       order to report an observed bug.

       The following information is requested from the user:

       •   Reproduction steps

       •   Expected behavior

       •   Actual behavior

       The following information is captured automatically:

       •   git version --build-options

       •   uname sysname, release, version, and machine strings

       •   Compiler-specific info string

       •   A list of enabled hooks

       •   $SHELL

       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 the kind of
       information listed above when manually asking for help.

OPTIONS         top

       -o <path>, --output-directory <path>
           Place the resulting bug report file in <path> instead of the
           root of the Git repository.

       -s <format>, --suffix <format>
           Specify an alternate suffix for the bugreport name, to create
           a file named git-bugreport-<formatted suffix>. This should
           take the form of a strftime(3) format string; the current
           local time will be used.

GIT         top

       Part of the git(1) suite

COLOPHON         top

       This page is part of the git (Git distributed version control
       system) project.  Information about the project can be found at
       ⟨⟩.  If you have a bug report for this manual
       page, see ⟨⟩.  This page was obtained
       from the project's upstream Git repository
       ⟨⟩ on 2021-08-27.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2021-08-24.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

Git         08/27/2021               GIT-BUGREPORT(1)

Pages that refer to this page: git(1)