doc/source/en/TortoiseGit/git_doc/git-shortlog.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-shortlog(1)">\r
   5 <articleinfo>\r
   6     <title>git-shortlog(1)</title>\r
   7         <indexterm>\r
   8                 <primary>git-shortlog(1)</primary>\r
   9         </indexterm>\r
  10 </articleinfo>\r
  11 <simplesect id="_name">\r
  12 <title>NAME</title>\r
  13 <simpara>git-shortlog - Summarize <emphasis>git-log</emphasis> output</simpara>\r
  14 </simplesect>\r
  15 <simplesect id="_synopsis">\r
  16 <title>SYNOPSIS</title>\r
  17 <blockquote>\r
  18 <literallayout>git log --pretty=short | <emphasis>git shortlog</emphasis> [-h] [-n] [-s] [-e] [-w]\r
  19 git shortlog [-n|--numbered] [-s|--summary] [-e|--email] [-w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]] [&lt;committish&gt;&#8230;]</literallayout>\r
  20 </blockquote>\r
  21 </simplesect>\r
  22 <simplesect id="_description">\r
  23 <title>DESCRIPTION</title>\r
  24 <simpara>Summarizes <emphasis>git-log</emphasis> output in a format suitable for inclusion\r
  25 in release announcements. Each commit will be grouped by author and\r
  26 the first line of the commit message will be shown.</simpara>\r
  27 <simpara>Additionally, "[PATCH]" will be stripped from the commit description.</simpara>\r
  28 </simplesect>\r
  29 <simplesect id="_options">\r
  30 <title>OPTIONS</title>\r
  31 <variablelist>\r
  32 <varlistentry>\r
  33 <term>\r
  34 -h\r
  35 </term>\r
  36 <term>\r
  37 --help\r
  38 </term>\r
  39 <listitem>\r
  40 <simpara>\r
  41         Print a short usage message and exit.\r
  42 </simpara>\r
  43 </listitem>\r
  44 </varlistentry>\r
  45 <varlistentry>\r
  46 <term>\r
  47 -n\r
  48 </term>\r
  49 <term>\r
  50 --numbered\r
  51 </term>\r
  52 <listitem>\r
  53 <simpara>\r
  54         Sort output according to the number of commits per author instead\r
  55         of author alphabetic order.\r
  56 </simpara>\r
  57 </listitem>\r
  58 </varlistentry>\r
  59 <varlistentry>\r
  60 <term>\r
  61 -s\r
  62 </term>\r
  63 <term>\r
  64 --summary\r
  65 </term>\r
  66 <listitem>\r
  67 <simpara>\r
  68         Suppress commit description and provide a commit count summary only.\r
  69 </simpara>\r
  70 </listitem>\r
  71 </varlistentry>\r
  72 <varlistentry>\r
  73 <term>\r
  74 -e\r
  75 </term>\r
  76 <term>\r
  77 --email\r
  78 </term>\r
  79 <listitem>\r
  80 <simpara>\r
  81         Show the email address of each author.\r
  82 </simpara>\r
  83 </listitem>\r
  84 </varlistentry>\r
  85 <varlistentry>\r
  86 <term>\r
  87 -w[&lt;width&gt;[,&lt;indent1&gt;[,&lt;indent2&gt;]]]\r
  88 </term>\r
  89 <listitem>\r
  90 <simpara>\r
  91         Linewrap the output by wrapping each line at <literal>width</literal>.  The first\r
  92         line of each entry is indented by <literal>indent1</literal> spaces, and the second\r
  93         and subsequent lines are indented by <literal>indent2</literal> spaces. <literal>width</literal>,\r
  94         <literal>indent1</literal>, and <literal>indent2</literal> default to 76, 6 and 9 respectively.\r
  95 </simpara>\r
  96 </listitem>\r
  97 </varlistentry>\r
  98 </variablelist>\r
  99 </simplesect>\r
 100 <simplesect id="_files">\r
 101 <title>FILES</title>\r
 102 <simpara>If a file <literal>.mailmap</literal> exists at the toplevel of the repository, or at the\r
 103 location pointed to by the log.mailmap configuration option,\r
 104 it is used to map author and committer names and email addresses to\r
 105 canonical real names and email addresses.\r
 106 This can be used to coalesce together commits by the same person where\r
 107 their name and/or email address was spelled differently.</simpara>\r
 108 <simpara>In the simple form, each line in the file consists of the canonical real name\r
 109 of an author, whitespace, and an email address used in the commit\r
 110 (enclosed by <emphasis>&lt;</emphasis> and <emphasis>&gt;</emphasis>) to map to the name. Thus, looks like this</simpara>\r
 111 <literallayout class="monospaced">Proper Name &lt;commit@email.xx&gt;</literallayout>\r
 112 <simpara>The more complex forms are</simpara>\r
 113 <literallayout class="monospaced">&lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</literallayout>\r
 114 <simpara>which allows mailmap to replace only the email part of a commit.</simpara>\r
 115 <literallayout class="monospaced">Proper Name &lt;proper@email.xx&gt; &lt;commit@email.xx&gt;</literallayout>\r
 116 <simpara>which allows mailmap to replace both the name and the email of a commit\r
 117 matching the specified commit email address. And</simpara>\r
 118 <literallayout class="monospaced">Proper Name &lt;proper@email.xx&gt; Commit Name &lt;commit@email.xx&gt;</literallayout>\r
 119 <simpara>which allows mailmap to replace both the name and the email of a commit\r
 120 matching the specified commit name and email address.</simpara>\r
 121 <simpara>So, for example, if your history contains commits by two authors, Jane\r
 122 and Joe, whose names appear in the repository under several forms:</simpara>\r
 123 <literallayout>Joe Developer &lt;joe@example.com&gt;\r
 124 Joe R. Developer &lt;joe@example.com&gt;\r
 125 Jane Doe &lt;jane@example.com&gt;\r
 126 Jane Doe &lt;jane@laptop.(none)&gt;\r
 127 Jane D. &lt;jane@desktop.(none)&gt;</literallayout>\r
 128 <simpara>Then, supposing Joe wants his middle name initial used, and Jane prefers\r
 129 her family name fully spelled out, a proper <literal>.mailmap</literal> file would look like:</simpara>\r
 130 <literallayout># Note how we don't need an entry for &lt;jane@laptop.(none)&gt;, because the\r
 131 # real name of that author is correct already, and coalesced directly.\r
 132 Jane Doe &lt;jane@desktop.(none)&gt;\r
 133 Joe R. Developer &lt;joe@example.com&gt;</literallayout>\r
 134 <simpara>Now, suppose your repository contains commits from the following authors:</simpara>\r
 135 <literallayout>nick1 &lt;bugs@company.xx&gt;\r
 136 nick2 &lt;bugs@company.xx&gt;\r
 137 nick2 &lt;nick2@company.xx&gt;\r
 138 santa &lt;me@company.xx&gt;\r
 139 claus &lt;me@company.xx&gt;\r
 140 CTO &lt;cto@coompany.xx&gt;</literallayout>\r
 141 <simpara>Then, you might want a <literal>.mailmap</literal> file looking like:</simpara>\r
 142 <literallayout>&lt;cto@company.xx&gt;                       &lt;cto@coompany.xx&gt;\r
 143 Some Dude &lt;some@dude.xx&gt;         nick1 &lt;bugs@company.xx&gt;\r
 144 Other Author &lt;other@author.xx&gt;   nick2 &lt;bugs@company.xx&gt;\r
 145 Other Author &lt;other@author.xx&gt;         &lt;nick2@company.xx&gt;\r
 146 Santa Claus &lt;santa.claus@northpole.xx&gt; &lt;me@company.xx&gt;</literallayout>\r
 147 <simpara>Use hash <emphasis>#</emphasis> for comments, either on their own line, or after the email address.</simpara>\r
 148 </simplesect>\r
 149 <simplesect id="_author">\r
 150 <title>Author</title>\r
 151 <simpara>Written by Jeff Garzik &lt;<ulink url="mailto:jgarzik@pobox.com">jgarzik@pobox.com</ulink>&gt;</simpara>\r
 152 </simplesect>\r
 153 <simplesect id="_documentation">\r
 154 <title>Documentation</title>\r
 155 <simpara>Documentation by Junio C Hamano.</simpara>\r
 156 </simplesect>\r
 157 <simplesect id="_git">\r
 158 <title>GIT</title>\r
 159 <simpara>Part of the <xref linkend="git(1)"/> suite</simpara>\r
 160 </simplesect>\r
 161 </article>\r