diff options
Diffstat (limited to 'devdocs/git/git-bugreport.html')
| -rw-r--r-- | devdocs/git/git-bugreport.html | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/devdocs/git/git-bugreport.html b/devdocs/git/git-bugreport.html new file mode 100644 index 00000000..bb2a1c96 --- /dev/null +++ b/devdocs/git/git-bugreport.html @@ -0,0 +1,7 @@ +<h1>git-bugreport</h1> <h2 id="_name">Name</h2> <div class="sectionbody"> <p>git-bugreport - Collect information for user to file a bug report</p> </div> <h2 id="_synopsis">Synopsis</h2> <div class="sectionbody"> <div class="verseblock"> <pre class="content" data-language="shell">git bugreport [(-o | --output-directory) <path>] [(-s | --suffix) <format>] + [--diagnose[=<mode>]]</pre> </div> </div> <h2 id="_description">Description</h2> <div class="sectionbody"> <p>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.</p> <p>The following information is requested from the user:</p> <div class="ulist"> <ul> <li> <p>Reproduction steps</p> </li> <li> <p>Expected behavior</p> </li> <li> <p>Actual behavior</p> </li> </ul> </div> <p>The following information is captured automatically:</p> <div class="ulist"> <ul> <li> <p><code>git version --build-options</code></p> </li> <li> <p>uname sysname, release, version, and machine strings</p> </li> <li> <p>Compiler-specific info string</p> </li> <li> <p>A list of enabled hooks</p> </li> <li> <p>$SHELL</p> </li> </ul> </div> <p>Additional information may be gathered into a separate zip archive using the <code>--diagnose</code> option, and can be attached alongside the bugreport document to provide additional context to readers.</p> <p>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.</p> </div> <h2 id="_options">Options</h2> <div class="sectionbody"> <div class="dlist"> <dl> <dt class="hdlist1" id="Documentation/git-bugreport.txt--oltpathgt"> -o <path> </dt> <dt class="hdlist1" id="Documentation/git-bugreport.txt---output-directoryltpathgt"> --output-directory <path> </dt> <dd> <p>Place the resulting bug report file in <code><path></code> instead of the current directory.</p> </dd> <dt class="hdlist1" id="Documentation/git-bugreport.txt--sltformatgt"> -s <format> </dt> <dt class="hdlist1" id="Documentation/git-bugreport.txt---suffixltformatgt"> --suffix <format> </dt> <dd> <p>Specify an alternate suffix for the bugreport name, to create a file named <code>git-bugreport-<formatted suffix></code>. This should take the form of a strftime(3) format string; the current local time will be used.</p> </dd> <dt class="hdlist1" id="Documentation/git-bugreport.txt---no-diagnose"> --no-diagnose </dt> <dt class="hdlist1" id="Documentation/git-bugreport.txt---diagnoseltmodegt"> --diagnose[=<mode>] </dt> <dd> <p>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 <code>git-diagnostics-<formatted suffix></code>.</p> <p>Without <code>mode</code> specified, the diagnostic archive will contain the default set of statistics reported by <code>git diagnose</code>. An optional <code>mode</code> value may be specified to change which information is included in the archive. See <a href="git-diagnose">git-diagnose[1]</a> for the list of valid values for <code>mode</code> and details about their usage.</p> </dd> </dl> </div> </div><div class="_attribution"> + <p class="_attribution-p"> + © 2012–2024 Scott Chacon and others<br>Licensed under the MIT License.<br> + <a href="https://git-scm.com/docs/git-bugreport" class="_attribution-link">https://git-scm.com/docs/git-bugreport</a> + </p> +</div> |