doc/source/en/TortoiseGit/git_doc/git-annotate.html.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">\r
   3 \r
   4 <article lang="en" id="git-annotate(1)">\r
   5 <articleinfo>\r
   6     <title>git-annotate(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-annotate(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-annotate - Annotate file lines with commit info</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <simpara><emphasis>git annotate</emphasis> [options] file [revision]</simpara>\r
  18 </simplesect>\r
  19 <simplesect id="_description">\r
  20 <title>DESCRIPTION</title>\r
  21 <simpara>Annotates each line in the given file with information from the commit\r
  22 which introduced the line. Optionally annotate from a given revision.</simpara>\r
  23 <simpara>The only difference between this command and <xref linkend="git-blame(1)"/> is that\r
  24 they use slightly different output formats, and this command exists only\r
  25 for backward compatibility to support existing scripts, and provide more\r
  26 familiar command name for people coming from other SCM systems.</simpara>\r
  27 </simplesect>\r
  28 <simplesect id="_options">\r
  29 <title>OPTIONS</title>\r
  30 <variablelist>\r
  31 <varlistentry>\r
  32 <term>\r
  33 -b\r
  34 </term>\r
  35 <listitem>\r
  36 <simpara>\r
  37         Show blank SHA-1 for boundary commits.  This can also\r
  38         be controlled via the <literal>blame.blankboundary</literal> config option.\r
  39 </simpara>\r
  40 </listitem>\r
  41 </varlistentry>\r
  42 <varlistentry>\r
  43 <term>\r
  44 --root\r
  45 </term>\r
  46 <listitem>\r
  47 <simpara>\r
  48         Do not treat root commits as boundaries.  This can also be\r
  49         controlled via the <literal>blame.showroot</literal> config option.\r
  50 </simpara>\r
  51 </listitem>\r
  52 </varlistentry>\r
  53 <varlistentry>\r
  54 <term>\r
  55 --show-stats\r
  56 </term>\r
  57 <listitem>\r
  58 <simpara>\r
  59         Include additional statistics at the end of blame output.\r
  60 </simpara>\r
  61 </listitem>\r
  62 </varlistentry>\r
  63 <varlistentry>\r
  64 <term>\r
  65 -L &lt;start&gt;,&lt;end&gt;\r
  66 </term>\r
  67 <listitem>\r
  68 <simpara>\r
  69         Annotate only the given line range.  &lt;start&gt; and &lt;end&gt; can take\r
  70         one of these forms:\r
  71 </simpara>\r
  72 <itemizedlist>\r
  73 <listitem>\r
  74 <simpara>\r
  75 number\r
  76 </simpara>\r
  77 <simpara>If &lt;start&gt; or &lt;end&gt; is a number, it specifies an\r
  78 absolute line number (lines count from 1).</simpara>\r
  79 </listitem>\r
  80 <listitem>\r
  81 <simpara>\r
  82 /regex/\r
  83 </simpara>\r
  84 <simpara>This form will use the first line matching the given\r
  85 POSIX regex.  If &lt;end&gt; is a regex, it will search\r
  86 starting at the line given by &lt;start&gt;.</simpara>\r
  87 </listitem>\r
  88 <listitem>\r
  89 <simpara>\r
  90 +offset or -offset\r
  91 </simpara>\r
  92 <simpara>This is only valid for &lt;end&gt; and will specify a number\r
  93 of lines before or after the line given by &lt;start&gt;.</simpara>\r
  94 </listitem>\r
  95 </itemizedlist>\r
  96 </listitem>\r
  97 </varlistentry>\r
  98 <varlistentry>\r
  99 <term>\r
 100 -l\r
 101 </term>\r
 102 <listitem>\r
 103 <simpara>\r
 104         Show long rev (Default: off).\r
 105 </simpara>\r
 106 </listitem>\r
 107 </varlistentry>\r
 108 <varlistentry>\r
 109 <term>\r
 110 -t\r
 111 </term>\r
 112 <listitem>\r
 113 <simpara>\r
 114         Show raw timestamp (Default: off).\r
 115 </simpara>\r
 116 </listitem>\r
 117 </varlistentry>\r
 118 <varlistentry>\r
 119 <term>\r
 120 -S &lt;revs-file&gt;\r
 121 </term>\r
 122 <listitem>\r
 123 <simpara>\r
 124         Use revs from revs-file instead of calling <xref linkend="git-rev-list(1)"/>.\r
 125 </simpara>\r
 126 </listitem>\r
 127 </varlistentry>\r
 128 <varlistentry>\r
 129 <term>\r
 130 -p\r
 131 </term>\r
 132 <term>\r
 133 --porcelain\r
 134 </term>\r
 135 <listitem>\r
 136 <simpara>\r
 137         Show in a format designed for machine consumption.\r
 138 </simpara>\r
 139 </listitem>\r
 140 </varlistentry>\r
 141 <varlistentry>\r
 142 <term>\r
 143 --incremental\r
 144 </term>\r
 145 <listitem>\r
 146 <simpara>\r
 147         Show the result incrementally in a format designed for\r
 148         machine consumption.\r
 149 </simpara>\r
 150 </listitem>\r
 151 </varlistentry>\r
 152 <varlistentry>\r
 153 <term>\r
 154 --encoding=&lt;encoding&gt;\r
 155 </term>\r
 156 <listitem>\r
 157 <simpara>\r
 158         Specifies the encoding used to output author names\r
 159         and commit summaries. Setting it to <literal>none</literal> makes blame\r
 160         output unconverted data. For more information see the\r
 161         discussion about encoding in the <xref linkend="git-log(1)"/>\r
 162         manual page.\r
 163 </simpara>\r
 164 </listitem>\r
 165 </varlistentry>\r
 166 <varlistentry>\r
 167 <term>\r
 168 --contents &lt;file&gt;\r
 169 </term>\r
 170 <listitem>\r
 171 <simpara>\r
 172         When &lt;rev&gt; is not specified, the command annotates the\r
 173         changes starting backwards from the working tree copy.\r
 174         This flag makes the command pretend as if the working\r
 175         tree copy has the contents of the named file (specify\r
 176         <literal>-</literal> to make the command read from the standard input).\r
 177 </simpara>\r
 178 </listitem>\r
 179 </varlistentry>\r
 180 <varlistentry>\r
 181 <term>\r
 182 -M|&lt;num&gt;|\r
 183 </term>\r
 184 <listitem>\r
 185 <simpara>\r
 186         Detect moving lines in the file as well.  When a commit\r
 187         moves a block of lines in a file (e.g. the original file\r
 188         has A and then B, and the commit changes it to B and\r
 189         then A), traditional <emphasis>blame</emphasis> algorithm typically blames\r
 190         the lines that were moved up (i.e. B) to the parent and\r
 191         assigns blame to the lines that were moved down (i.e. A)\r
 192         to the child commit.  With this option, both groups of lines\r
 193         are blamed on the parent.\r
 194 </simpara>\r
 195 <simpara>&lt;num&gt; is optional but it is the lower bound on the number of\r
 196 alphanumeric characters that git must detect as moving\r
 197 within a file for it to associate those lines with the parent\r
 198 commit.</simpara>\r
 199 </listitem>\r
 200 </varlistentry>\r
 201 <varlistentry>\r
 202 <term>\r
 203 -C|&lt;num&gt;|\r
 204 </term>\r
 205 <listitem>\r
 206 <simpara>\r
 207         In addition to <literal>-M</literal>, detect lines copied from other\r
 208         files that were modified in the same commit.  This is\r
 209         useful when you reorganize your program and move code\r
 210         around across files.  When this option is given twice,\r
 211         the command looks for copies from all other files in the\r
 212         parent for the commit that creates the file in addition.\r
 213 </simpara>\r
 214 <simpara>&lt;num&gt; is optional but it is the lower bound on the number of\r
 215 alphanumeric characters that git must detect as moving\r
 216 between files for it to associate those lines with the parent\r
 217 commit.</simpara>\r
 218 </listitem>\r
 219 </varlistentry>\r
 220 <varlistentry>\r
 221 <term>\r
 222 -h\r
 223 </term>\r
 224 <term>\r
 225 --help\r
 226 </term>\r
 227 <listitem>\r
 228 <simpara>\r
 229         Show help message.\r
 230 </simpara>\r
 231 </listitem>\r
 232 </varlistentry>\r
 233 </variablelist>\r
 234 </simplesect>\r
 235 <simplesect id="_see_also">\r
 236 <title>SEE ALSO</title>\r
 237 <simpara><xref linkend="git-blame(1)"/></simpara>\r
 238 </simplesect>\r
 239 <simplesect id="_author">\r
 240 <title>AUTHOR</title>\r
 241 <simpara>Written by Ryan Anderson &lt;<ulink url="mailto:ryan@michonline.com">ryan@michonline.com</ulink>&gt;.</simpara>\r
 242 </simplesect>\r
 243 <simplesect id="_git">\r
 244 <title>GIT</title>\r
 245 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 246 </simplesect>\r
 247 </article>\r