doc/source/en/TortoiseGit/git_doc/git-bugreport.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 \r
   4 <sect2 lang="en" id="git-bugreport(1)">\r
   5     <title>git-bugreport(1)</title>\r
   6 <indexterm>\r
   7 <primary>git-bugreport(1)</primary>\r
   8 </indexterm>\r
   9 <simplesect id="git-bugreport(1)__name">\r
  10 <title>NAME</title>\r
  11 <simpara>git-bugreport - Collect information for user to file a bug report</simpara>\r
  12 </simplesect>\r
  13 <simplesect id="git-bugreport(1)__synopsis">\r
  14 <title>SYNOPSIS</title>\r
  15 <blockquote>\r
  16 <literallayout><emphasis>git bugreport</emphasis> [(-o | --output-directory) &lt;path&gt;] [(-s | --suffix) &lt;format&gt;]</literallayout>\r
  17 </blockquote>\r
  18 </simplesect>\r
  19 <simplesect id="git-bugreport(1)__description">\r
  20 <title>DESCRIPTION</title>\r
  21 <simpara>Captures information about the user's machine, Git client, and repository state,\r
  22 as well as a form requesting information about the behavior the user observed,\r
  23 into a single text file which the user can then share, for example to the Git\r
  24 mailing list, in order to report an observed bug.</simpara>\r
  25 <simpara>The following information is requested from the user:</simpara>\r
  26 <itemizedlist>\r
  27 <listitem>\r
  28 <simpara>\r
  29 Reproduction steps\r
  30 </simpara>\r
  31 </listitem>\r
  32 <listitem>\r
  33 <simpara>\r
  34 Expected behavior\r
  35 </simpara>\r
  36 </listitem>\r
  37 <listitem>\r
  38 <simpara>\r
  39 Actual behavior\r
  40 </simpara>\r
  41 </listitem>\r
  42 </itemizedlist>\r
  43 <simpara>The following information is captured automatically:</simpara>\r
  44 <itemizedlist>\r
  45 <listitem>\r
  46 <simpara>\r
  47 <emphasis>git version --build-options</emphasis>\r
  48 </simpara>\r
  49 </listitem>\r
  50 <listitem>\r
  51 <simpara>\r
  52 uname sysname, release, version, and machine strings\r
  53 </simpara>\r
  54 </listitem>\r
  55 <listitem>\r
  56 <simpara>\r
  57 Compiler-specific info string\r
  58 </simpara>\r
  59 </listitem>\r
  60 <listitem>\r
  61 <simpara>\r
  62 A list of enabled hooks\r
  63 </simpara>\r
  64 </listitem>\r
  65 <listitem>\r
  66 <simpara>\r
  67 $SHELL\r
  68 </simpara>\r
  69 </listitem>\r
  70 </itemizedlist>\r
  71 <simpara>This tool is invoked via the typical Git setup process, which means that in some\r
  72 cases, it might not be able to launch - for example, if a relevant config file\r
  73 is unreadable. In this kind of scenario, it may be helpful to manually gather\r
  74 the kind of information listed above when manually asking for help.</simpara>\r
  75 </simplesect>\r
  76 <simplesect id="git-bugreport(1)__options">\r
  77 <title>OPTIONS</title>\r
  78 <variablelist>\r
  79 <varlistentry>\r
  80 <term>\r
  81 -o &lt;path&gt;\r
  82 </term>\r
  83 <term>\r
  84 --output-directory &lt;path&gt;\r
  85 </term>\r
  86 <listitem>\r
  87 <simpara>\r
  88         Place the resulting bug report file in <emphasis>&lt;path&gt;</emphasis> instead of the root of\r
  89         the Git repository.\r
  90 </simpara>\r
  91 </listitem>\r
  92 </varlistentry>\r
  93 <varlistentry>\r
  94 <term>\r
  95 -s &lt;format&gt;\r
  96 </term>\r
  97 <term>\r
  98 --suffix &lt;format&gt;\r
  99 </term>\r
 100 <listitem>\r
 101 <simpara>\r
 102         Specify an alternate suffix for the bugreport name, to create a file\r
 103         named <emphasis>git-bugreport-&lt;formatted suffix&gt;</emphasis>. This should take the form of a\r
 104         strftime(3) format string; the current local time will be used.\r
 105 </simpara>\r
 106 </listitem>\r
 107 </varlistentry>\r
 108 </variablelist>\r
 109 </simplesect>\r
 110 <simplesect id="git-bugreport(1)__git">\r
 111 <title>GIT</title>\r
 112 <simpara>Part of the <xref linkend="git(1)" /> suite</simpara>\r
 113 </simplesect>\r
 114 </sect2>\r