Go to main content

man pages section 1: User Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

git-bugreport (1)

Name

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

Synopsis

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

Description

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



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

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


DESCRIPTION
       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:

       o   Reproduction steps

       o   Expected behavior

       o   Actual behavior

       The following information is captured automatically:

       o   git version --build-options

       o   uname sysname, release, version, and machine strings

       o   Compiler-specific info string

       o   A list of enabled hooks

       o   $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
       -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
       Part of the git(1) suite



Git 2.31.1                        03/26/2021                  GIT-BUGREPORT(1)