git-bugreport(1) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| OPTIONS \| GIT \| COLOPHON

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> | --no-suffix]
                       [--diagnose[=<mode>]]

DESCRIPTION top

       Collects information about the user’s machine, Git client, and
       repository state, in addition to a form requesting information
       about the behavior the user observed, and stores it in 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

       Additional information may be gathered into a separate zip
       archive using the --diagnose option, and can be attached
       alongside the bugreport document to provide additional context to
       readers.

       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
           current directory.

       -s <format>, --suffix <format>, --no-suffix
           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.  --no-suffix disables the suffix and
           the file is just named git-bugreport without any
           disambiguation measure.

       --no-diagnose, --diagnose[=<mode>]
           Create a zip archive of supplemental information about the
           user’s machine, Git client, and repository state. The archive
           is written to the same output directory as the bug report and
           is named git-diagnostics-<formatted-suffix>.

           Without mode specified, the diagnostic archive will contain
           the default set of statistics reported by git diagnose. An
           optional mode value may be specified to change which
           information is included in the archive. See git-diagnose(1)
           for the list of valid values for mode and details about their
           usage.

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
       ⟨http://git-scm.com/⟩.  If you have a bug report for this manual
       page, see ⟨http://git-scm.com/community⟩.  This page was obtained
       from the project's upstream Git repository
       ⟨https://github.com/git/git.git⟩ on 2024-06-14.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2024-06-12.)  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
       [email protected]

Git 2.45.2.492.gd63586         2024-06-12               GIT-BUGREPORT(1)

Pages that refer to this page: git(1), git-diagnose(1)