<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">

<sect2 lang="en" id="git-bugreport(1)">
    <title>git-bugreport(1)</title>
    <date>2024-07-02</date>
<revhistory><revision><date>2024-07-02</date></revision></revhistory>
<indexterm>
<primary>git-bugreport(1)</primary>
</indexterm>
<simplesect id="git-bugreport(1)__name">
<title>NAME</title>
<simpara>git-bugreport - Collect information for user to file a bug report</simpara>
</simplesect>
<simplesect id="git-bugreport(1)__synopsis">
<title>SYNOPSIS</title>
<blockquote>
<literallayout><emphasis>git bugreport</emphasis> [(-o | --output-directory) &lt;path&gt;]
                [(-s | --suffix) &lt;format&gt; | --no-suffix]
                [--diagnose[=&lt;mode&gt;]]</literallayout>
</blockquote>
</simplesect>
<simplesect id="git-bugreport(1)__description">
<title>DESCRIPTION</title>
<simpara>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.</simpara>
<simpara>The following information is requested from the user:</simpara>
<itemizedlist>
<listitem>
<simpara>
Reproduction steps
</simpara>
</listitem>
<listitem>
<simpara>
Expected behavior
</simpara>
</listitem>
<listitem>
<simpara>
Actual behavior
</simpara>
</listitem>
</itemizedlist>
<simpara>The following information is captured automatically:</simpara>
<itemizedlist>
<listitem>
<simpara>
<emphasis>git version --build-options</emphasis>
</simpara>
</listitem>
<listitem>
<simpara>
uname sysname, release, version, and machine strings
</simpara>
</listitem>
<listitem>
<simpara>
Compiler-specific info string
</simpara>
</listitem>
<listitem>
<simpara>
A list of enabled hooks
</simpara>
</listitem>
<listitem>
<simpara>
$SHELL
</simpara>
</listitem>
</itemizedlist>
<simpara>Additional information may be gathered into a separate zip archive using the
<emphasis>--diagnose</emphasis> option, and can be attached alongside the bugreport document to
provide additional context to readers.</simpara>
<simpara>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.</simpara>
</simplesect>
<simplesect id="git-bugreport(1)__options">
<title>OPTIONS</title>
<variablelist>
<varlistentry>
<term>
-o &lt;path&gt;
</term>
<term>
--output-directory &lt;path&gt;
</term>
<listitem>
<simpara>
        Place the resulting bug report file in <emphasis>&lt;path&gt;</emphasis> instead of the current
        directory.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
-s &lt;format&gt;
</term>
<term>
--suffix &lt;format&gt;
</term>
<term>
--no-suffix
</term>
<listitem>
<simpara>
        Specify an alternate suffix for the bugreport name, to create a file
        named <emphasis>git-bugreport-&lt;formatted-suffix&gt;</emphasis>. This should take the form of a
        strftime(3) format string; the current local time will be used.
        <emphasis>--no-suffix</emphasis> disables the suffix and the file is just named
        <emphasis>git-bugreport</emphasis> without any disambiguation measure.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
--no-diagnose
</term>
<term>
--diagnose[=&lt;mode&gt;]
</term>
<listitem>
<simpara>
        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
        <emphasis>git-diagnostics-&lt;formatted-suffix&gt;</emphasis>.
</simpara>
<simpara>Without <emphasis>mode</emphasis> specified, the diagnostic archive will contain the default set of
statistics reported by <emphasis>git diagnose</emphasis>. An optional <emphasis>mode</emphasis> value may be specified
to change which information is included in the archive. See
<xref linkend="git-diagnose(1)" /> for the list of valid values for <emphasis>mode</emphasis> and details
about their usage.</simpara>
</listitem>
</varlistentry>
</variablelist>
</simplesect>
<simplesect id="git-bugreport(1)__git">
<title>GIT</title>
<simpara>Part of the <xref linkend="git(1)" /> suite</simpara>
</simplesect>
</sect2>
