LinuxCommandLibrary

git-bugreport

Generate Git bug reports

TLDR

Create a new bug report file in the current directory

$ git bugreport
copy

Create a new bug report file in the specified directory, creating it if it does not exist
$ git bugreport [[-o|--output-directory]] [path/to/directory]
copy

Create a new bug report file with the specified filename suffix in strftime format
$ git bugreport [[-s|--suffix]] [%m%d%y]
copy

SYNOPSIS

git bugreport [--no-local-config] [--no-global-config] [--no-system-config] [--no-attach] [--stdout] [--what-to-collect=]

PARAMETERS

--no-local-config
    Exclude local Git configuration from the report.

--no-global-config
    Exclude global Git configuration from the report.

--no-system-config
    Exclude system Git configuration from the report.

--no-attach
    Do not generate an archive to be attached; output the report to standard output.

--stdout
    Synonym for `--no-attach`.

--what-to-collect=
    Specify what kind of data should be collected. If none is specified, all information is collected.

DESCRIPTION

The `git-bugreport` command gathers system information and Git configuration details, creating a comprehensive report useful for diagnosing and resolving Git-related issues. This report aids developers in understanding the user's environment and the context in which the bug occurred.

The script collects information such as Git version, operating system details, installed patches, CPU architecture, filesystem information, Git configuration (global, system, and repository-specific), hook scripts, and the output of various Git commands (`git status`, `git config --list`, `git fsck --full --strict`). It also checks for potential problems within the repository and identifies possible conflicts with other programs.

The command aims to simplify the process of reporting bugs to the Git development team, ensuring that bug reports are detailed and include relevant context.

OUTPUT

The output is either written to the standard output using the `--stdout` or `--no-attach` option, or saved in a compressed archive. If no specific directory is specified, the archive is created in the current working directory. It helps to provide a complete state of the git installation and git repository to debug the problem.

SEE ALSO

Copied to clipboard