Log dialog can revert selected files to parent revision
[TortoiseGit.git] / doc / source / en / TortoiseGit / tsvn_dug / dug_log.xml
blobac1519e36b37a43bf66de194bcbe97bd572fb41a
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect1 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect1 id="tsvn-dug-showlog">\r
4         <title>Revision Log Dialog</title>\r
5         <indexterm>\r
6                 <primary>log</primary>\r
7         </indexterm>\r
8         <indexterm>\r
9                 <primary>history</primary>\r
10         </indexterm>\r
11         <indexterm>\r
12                 <primary>commit messages</primary>\r
13         </indexterm>\r
14         <indexterm>\r
15                 <primary>log messages</primary>\r
16         </indexterm>\r
17         <?dbhh topicname="HIDD_LOGMESSAGE"?>\r
18         <para>\r
19                 For every change you make and commit, you should provide\r
20                 a log message for that change. That way you can later find out\r
21                 what changes you made and why, and you have a detailed log for\r
22                 your development process.\r
23         </para>\r
24         <para>\r
25                 The Revision Log Dialog retrieves all those log messages and shows them\r
26                 to you.\r
27                 The display is divided into 3 panes.\r
28                 <itemizedlist>\r
29                         <listitem>\r
30                                 <para>\r
31                                         The top pane shows a list of revisions where changes to the\r
32                                         file/folder have been committed. This summary includes the\r
33                                         date and time, the person who committed the revision and the\r
34                                         start of the log message.\r
35                                 </para>\r
36                                 <para>\r
37                                         Lines shown in bold indicate that that is HEAD commit.\r
38                                 </para>\r
39                         </listitem>\r
40                         <listitem>\r
41                                 <para>\r
42                                         The middle pane shows the full log message for the selected\r
43                                         revision.\r
44                                 </para>\r
45                         </listitem>\r
46                         <listitem>\r
47                                 <para>\r
48                                         The bottom pane shows a list of all files and folders that\r
49                                         were changed as part of the selected revision.\r
50                                 </para>\r
51                         </listitem>\r
52                 </itemizedlist>\r
53                 But it does much more than that - it provides context menu\r
54                 commands which you can use to get even more information about the\r
55                 project history.\r
56         </para>\r
57         <sect2 id="tsvn-dug-showlog-1">\r
58                 <title>Invoking the Revision Log Dialog</title>\r
59                 <para>\r
60                         <figure id="tsvn-dug-showlog-1-dia-1">\r
61                                 <title>The Revision Log Dialog</title>\r
62                                 <graphic fileref="../images/LogMessages.png"/>\r
63                         </figure>\r
64                         There are several places from where you can show the Log dialog:\r
65                         <itemizedlist>\r
66                                 <listitem>\r
67                                         <para>\r
68                                                 From the TortoiseGit context submenu\r
69                                         </para>\r
70                                 </listitem>\r
71                         </itemizedlist>\r
72                 </para>\r
73         </sect2>\r
74         <sect2 id="tsvn-dug-showlog-actions">\r
75                 <title>Revision Log Actions</title>\r
76                 <para>\r
77                         The top pane has an <guilabel>Actions</guilabel> column containing\r
78                         icons that summarize what has been done in that revision.\r
79                         There are four different icons, each shown in its own column.\r
80                 </para>\r
81                 <para>\r
82                         <graphic fileref="../images/ActionModifiedIcon.png"/>\r
83                         If a revision modified a file or directory, the\r
84                         <emphasis>modified</emphasis> icon is shown in the first column.\r
85                 </para>\r
86                 <para>\r
87                         <graphic fileref="../images/ActionAddedIcon.png"/>\r
88                         If a revision added a file or directory, the\r
89                         <emphasis>added</emphasis> icon is shown in the second column.\r
90                 </para>\r
91                 <para>\r
92                         <graphic fileref="../images/ActionDeletedIcon.png"/>\r
93                         If a revision deleted a file or directory, the\r
94                         <emphasis>deleted</emphasis> icon is shown in the third column.\r
95                 </para>\r
96                 <para>\r
97                         <graphic fileref="../images/ActionReplacedIcon.png"/>\r
98                         If a revision replaced(rename) a file, the\r
99                         <emphasis>replaced</emphasis> icon is shown in the fourth column.\r
100                 </para>\r
101         </sect2>\r
102         <sect2 id="tsvn-dug-showlog-2">\r
103                 <title>Getting Additional Information</title>\r
104                 <para>\r
105                         <figure id="tsvn-dug-showlog-2-dia-1">\r
106                                 <title>The Revision Log Dialog Top Pane with Context Menu</title>\r
107                                 <graphic fileref="../images/LogContextMenu.png"/>\r
108                         </figure>\r
109                         The top pane of the Log dialog has a context menu that allows you to\r
110                         access much more information. Some of these menu entries appear only\r
111                         when the log is shown for a file, and some only when the log is shown\r
112                         for a folder.\r
113                         <variablelist>\r
114                                 <varlistentry>\r
115                                         <term>Compare with working tree</term>\r
116                                         <listitem>\r
117                                                 <para>\r
118                                                         Compare the selected revision with your working tree.\r
119                                                         The default Diff-Tool is TortoiseMerge which\r
120                                                         is supplied with TortoiseGit.\r
121                                                         If the log dialog is for a folder, this will show you a list\r
122                                                         of changed files, and allow you to review the changes made\r
123                                                         to each file individually.\r
124                                                 </para>\r
125                                         </listitem>\r
126                                 </varlistentry>\r
127                                 <varlistentry>\r
128                                         <term>Show changes as unified diff</term>\r
129                                         <listitem>\r
130                                                 <para>\r
131                                                         View the changes made in the selected revision as a\r
132                                                         Unified-Diff file (GNU patch format). This shows\r
133                                                         only the differences with a few lines of context. It\r
134                                                         is harder to read than a visual file compare, but will\r
135                                                         show all file changes together in a compact format.\r
136                                                 </para>\r
137                                         </listitem>\r
138                                 </varlistentry>\r
139                                 <varlistentry>\r
140                                         <term>Compare with previous revision</term>\r
141                                         <listitem>\r
142                                                 <para>\r
143                                                         Compare the selected revision with the previous revision.\r
144                                                         This works in a similar manner to comparing with your\r
145                                                         working tree.\r
146                                                         For folders this option will first show the changed files\r
147                                                         dialog allowing you to select files to compare.\r
148                                                 </para>\r
149                                         </listitem>\r
150                                 </varlistentry>\r
151                                 <varlistentry>\r
152                                         <term>Browse repository</term>\r
153                                         <listitem>\r
154                                                 <para>\r
155                                                         Open the repository browser to examine the selected file or\r
156                                                         folder in the repository as it was at the selected revision.\r
157                                                 </para>\r
158                                         </listitem>\r
159                                 </varlistentry>\r
160                                 <varlistentry>\r
161                                         <term>Reset (current branch) to this</term>\r
162                                         <listitem>\r
163                                                 <para>\r
164                                                         Reset current branch HEAD to selected commit.\r
165                                                         <!-- todo refer reset -->\r
166                                                 </para>\r
167                                         </listitem>\r
168                                 </varlistentry>\r
169                                 <varlistentry>\r
170                                         <term>Switch / Checkout to revision</term>\r
171                                         <listitem>\r
172                                                 <para>\r
173                                                         Update your working tree to the selected revision.\r
174                                                         Useful if you want to have your working tree reflect\r
175                                                         a time in the past, or if there have been further commits to\r
176                                                         the repository and you want to update your working tree one\r
177                                                         step at a time.\r
178                                                 </para>\r
179                                         </listitem>\r
180                                 </varlistentry>\r
182                                 <varlistentry>\r
183                                         <term>Create branch from revision</term>\r
184                                         <listitem>\r
185                                                 <para>\r
186                                                         Create a branch from a selected revision.\r
187                                                         This is useful e.g.\r
188                                                 </para>\r
189                                         </listitem>\r
190                                 </varlistentry>\r
191                                 <varlistentry>\r
192                                         <term>Create tag from revision</term>\r
193                                         <listitem>\r
194                                                 <para>\r
195                                                         Create a tag from a selected revision.\r
196                                                         This is useful e.g.\r
197                                                 </para>\r
198                                         </listitem>\r
199                                 </varlistentry>\r
200                                 <varlistentry>\r
201                                         <term>Rebase (current branch) to this</term>\r
202                                         <listitem>\r
203                                                 <para>\r
204                                                         Rebase current branch to selected commit.\r
205                                                         <!-- todo refer rebase -->\r
206                                                 </para>\r
207                                         </listitem>\r
208                                 </varlistentry>\r
209                                 <varlistentry>\r
210                                         <term>Export this version...</term>\r
211                                         <listitem>\r
212                                                 <para>\r
213                                                         Export the selected revision to an archive file such as zip. This brings up a dialog for you to confirm the\r
214                                                         revision, and select a location for the export.\r
215                                                 </para>\r
216                                         </listitem>\r
217                                 </varlistentry>\r
218                                 <varlistentry>\r
219                                         <term>Revert change by this commit</term>\r
220                                         <listitem>\r
221                                                 <para>\r
222                                                         Revert changes from which were made in the selected\r
223                                                         revision. All changes are integrated into your working tree.\r
224                                                         You may choose to commit immediately or edit and commit later.\r
225                                                         To abandon the reverted changes, perform a hard reset.\r
226                                                 </para>\r
227                                         </listitem>\r
228                                 </varlistentry>\r
229                                 <varlistentry>\r
230                                         <term>Edit notes</term>\r
231                                         <listitem>\r
232                                                 <para>\r
233                                                         Edit notes of the selected commit.\r
234                                                 </para>\r
235                                         </listitem>\r
236                                 </varlistentry>\r
237                                 <varlistentry>\r
238                                         <term>Cherry Pick this commit</term>\r
239                                         <listitem>\r
240                                                 <para>\r
241                                                         Cherry Pick this commit to current branch\r
242                                                         <!-- todo refer cherry pick -->\r
243                                                 </para>\r
244                                         </listitem>\r
245                                 </varlistentry>\r
246                                 <varlistentry>\r
247                                         <term>Format Patch...</term>\r
248                                         <listitem>\r
249                                                 <para>\r
250                                                         Create Patches from this commit.\r
251                                                 </para>\r
252                                         </listitem>\r
253                                 </varlistentry>\r
254                                 <varlistentry>\r
255                                         <term>Copy SHA-1 to clipboard</term>\r
256                                         <listitem>\r
257                                                 <para>\r
258                                                         Copy the commit hash of the selected revision to the clipboard.\r
259                                                 </para>\r
260                                         </listitem>\r
261                                 </varlistentry>\r
262                                 <varlistentry>\r
263                                         <term>Copy to clipboard</term>\r
264                                         <listitem>\r
265                                                 <para>\r
266                                                         Copy the log details of the selected revisions to the clipboard.\r
267                                                         This will copy the revision number, author, date, log message\r
268                                                         and the list of changed items for each revision.\r
269                                                 </para>\r
270                                         </listitem>\r
271                                 </varlistentry>\r
272                                 <varlistentry>\r
273                                         <term>Copy log message to clipboard</term>\r
274                                         <listitem>\r
275                                                 <para>\r
276                                                         Copy the log message of the selected revision to the clipboard.\r
277                                                 </para>\r
278                                         </listitem>\r
279                                 </varlistentry>\r
280                                 <varlistentry>\r
281                                         <term>Search log messages...</term>\r
282                                         <listitem>\r
283                                                 <figure id="tsvn-dug-showlog-1-dia-2">\r
284                                                         <title>The Search Log Messages Dialog</title>\r
285                                                         <graphic fileref="../images/LogSearch.png"/>\r
286                                                 </figure>\r
287                                                 <para>\r
288                                                         Search log messages for the text you enter. This searches\r
289                                                         the log messages that you entered and also the action summaries\r
290                                                         created by Git (shown in the bottom pane). The search\r
291                                                         is not case sensitive.\r
292                                                 </para>\r
293                                                 <tip>\r
294                                                         <para>\r
295                                                                 This allows you to easily search for refs (tags and branches).\r
296                                                         </para>\r
297                                                 </tip>\r
298                                         </listitem>\r
299                                 </varlistentry>\r
300                                 <varlistentry>\r
301                                         <term>Shows branches this commit is on</term>\r
302                                         <listitem>\r
303                                                 <para>\r
304                                                         Shows the branches that the select commit belongs to.\r
305                                                         It shows both local and remote branches.\r
306                                                 </para>\r
307                                         </listitem>\r
308                                 </varlistentry>\r
309                         </variablelist>\r
310                 </para>\r
311                 <para>\r
312                         <figure id="tsvn-dug-showlog-2-dia-1a">\r
313                                 <title>Top Pane Context Menu for 2 Selected Revisions</title>\r
314                                 <graphic fileref="../images/LogContextMenu1.png"/>\r
315                         </figure>\r
316                         If you select two revisions at once (using the usual\r
317                         <keycap>Ctrl</keycap>-modifier), the context menu changes and\r
318                         gives you fewer options:\r
319                         <variablelist>\r
320                                 <varlistentry>\r
321                                         <term>Compare revisions</term>\r
322                                         <listitem>\r
323                                                 <para>\r
324                                                         Compare the two selected revisions using a visual\r
325                                                         difference tool. The default Diff-Tool is TortoiseMerge\r
326                                                         which is supplied with TortoiseGit.\r
327                                                 </para>\r
328                                         </listitem>\r
329                                 </varlistentry>\r
330                                 <varlistentry>\r
331                                         <term>Show differences as unified diff</term>\r
332                                         <listitem>\r
333                                                 <para>\r
334                                                         View the differences between the two selected revisions\r
335                                                         as a Unified-Diff file. This works for files and folders.\r
336                                                 </para>\r
337                                         </listitem>\r
338                                 </varlistentry>\r
339                                 <varlistentry>\r
340                                         <term>Revert changes by these commit</term>\r
341                                         <listitem>\r
342                                                 <para>\r
343                                                         Revert changes from which were made in the selected\r
344                                                         revisions. All changes are integrated into your working tree.\r
345                                                         You may choose to commit immediately or edit and commit later.\r
346                                                         To abandon the reverted changes, perform a hard reset.\r
347                                                 </para>\r
348                                         </listitem>\r
349                                 </varlistentry>\r
350                                 <varlistentry>\r
351                                         <term>Combine to one commit</term>\r
352                                         <listitem>\r
353                                                 <para>\r
354                                                         Combine continuous commits to one commit.\r
355                                                 </para>\r
356                                         </listitem>\r
357                                 </varlistentry>\r
358                                 <varlistentry>\r
359                                         <term>Cherry Pick selected commits</term>\r
360                                         <listitem>\r
361                                                 <para>\r
362                                                         Cherry Pick Chosen Commits.\r
363                                                 </para>\r
364                                         </listitem>\r
365                                 </varlistentry>\r
366                                 <varlistentry>\r
367                                         <term>Bisect start</term>\r
368                                         <listitem>\r
369                                                 <para>\r
370                                                         Start bisection. Find by binary search the change that introduced a bug. \r
371                                                 </para>\r
372                                         </listitem>\r
373                                 </varlistentry>\r
374                                 <varlistentry>\r
375                                         <term>Fomat Patch...</term>\r
376                                         <listitem>\r
377                                                 <para>\r
378                                                         Create patchs between chosen two commits.\r
379                                                 </para>\r
380                                         </listitem>\r
381                                 </varlistentry>\r
382                                 <varlistentry>\r
383                                         <term>Copy SHA-1 to clipboard</term>\r
384                                         <listitem>\r
385                                                 <para>\r
386                                                         Copy the commit hashes of the selected revisions to the clipboard, delimited by CRLF.\r
387                                                 </para>\r
388                                         </listitem>\r
389                                 </varlistentry>\r
390                                 <varlistentry>\r
391                                         <term>Copy to clipboard</term>\r
392                                         <listitem>\r
393                                                 <para>\r
394                                                         Copy log messages to clipboard as described above.\r
395                                                 </para>\r
396                                         </listitem>\r
397                                 </varlistentry>\r
398                                 <varlistentry>\r
399                                         <term>Copy log messages to clipboard</term>\r
400                                         <listitem>\r
401                                                 <para>\r
402                                                         Copy the log messages of the selected revisions to the clipboard.\r
403                                                         This will copy the log message for each revision.\r
404                                                         This faciliates the preparation of release notes.\r
405                                                 </para>\r
406                                         </listitem>\r
407                                 </varlistentry>\r
408                                 <varlistentry>\r
409                                         <term>Search log messages...</term>\r
410                                         <listitem>\r
411                                                 <para>\r
412                                                         Search log messages as described above.\r
413                                                 </para>\r
414                                         </listitem>\r
415                                 </varlistentry>\r
416                         </variablelist>\r
417                 </para>\r
419                 <para>\r
420                         If you select two or more revisions (using the usual\r
421                         <keycap>Ctrl</keycap> or <keycap>Shift</keycap> modifiers),\r
422                         You can combine select commits to one commit. And cherry pick\r
423                         these commits to current branch.\r
424                 </para>\r
425                 <para>\r
426                         <figure id="tsvn-dug-showlog-2-dia-2">\r
427                                 <title>The Log Dialog Bottom Pane with Context Menu</title>\r
428                                 <graphic fileref="../images/LogContextMenu2.png"/>\r
429                         </figure>\r
430                         The bottom pane of the Log dialog also has a context menu that allows you to\r
431                         <variablelist>\r
432                                 <varlistentry>\r
433                                         <term>Compare with base</term>\r
434                                         <listitem>\r
435                                                 <para>\r
436                                                         Compare chosen file with base version.\r
437                                                 </para>\r
438                                         </listitem>\r
439                                 </varlistentry>\r
441                                 <varlistentry>\r
442                                         <term>Show as unified diff</term>\r
443                                         <listitem>\r
444                                                 <para>\r
445                                                         Show file changes in unified diff format.\r
446                                                         This context menu is only available for\r
447                                                         files shown as <emphasis>modified</emphasis>.\r
448                                                 </para>\r
449                                         </listitem>\r
450                                 </varlistentry>\r
451                                 <varlistentry>\r
452                                         <term>Compare with working tree</term>\r
453                                         <listitem>\r
454                                                 <para>\r
455                                                         Compare chosen file with working tree.\r
456                                                 </para>\r
457                                         </listitem>\r
458                                 </varlistentry>\r
460                                 <varlistentry>\r
461                                         <term>Revert changes to this revision</term>\r
462                                         <listitem>\r
463                                                 <para>\r
464                                                         Revert chosen files to this revision.\r
465                                                 </para>\r
466                                         </listitem>\r
467                                 </varlistentry>\r
468                                 <varlistentry>\r
469                                         <term>Revert changes to parent revision</term>\r
470                                         <listitem>\r
471                                                 <para>\r
472                                                         Revert chosen files to parent revision.\r
473                                                 </para>\r
474                                         </listitem>\r
475                                 </varlistentry>\r
476                                 <varlistentry>\r
477                                         <term>Show log</term>\r
478                                         <listitem>\r
479                                                 <para>\r
480                                                         Show the revision log for the selected single file.\r
481                                                 </para>\r
482                                         </listitem>\r
483                                 </varlistentry>\r
485                                 <varlistentry>\r
486                                         <term>Blame...</term>\r
487                                         <listitem>\r
488                                                 <para>\r
489                                                         Opens the Blame dialog, allowing you to blame up to the\r
490                                                         selected revision.\r
491                                                 </para>\r
492                                         </listitem>\r
493                                 </varlistentry>\r
495                                 <varlistentry>\r
496                                         <term>Save revision to...</term>\r
497                                         <listitem>\r
498                                                 <para>\r
499                                                         Save the selected revision to a file so you\r
500                                                         have an older version of that file.\r
501                                                 </para>\r
502                                         </listitem>\r
503                                 </varlistentry>\r
505                                 <varlistentry>\r
506                                         <term>Export selection to...</term>\r
507                                         <listitem>\r
508                                                 <para>\r
509                                                         Saves the selected files to a target directory. Compared to "Save revision to..." this preserves the directory structure.\r
510                                                 </para>\r
511                                         </listitem>\r
512                                 </varlistentry>\r
514                                 <varlistentry>\r
515                                         <term>View revision in alternative editor</term>\r
516                                         <listitem>\r
517                                                 <para>\r
518                                                         Show chosen file with an alternative editor such as notepad2 with chosen commit.\r
519                                                 </para>\r
520                                         </listitem>\r
521                                 </varlistentry>\r
523                                 <varlistentry>\r
524                                         <term>Open / Open with...</term>\r
525                                         <listitem>\r
526                                                 <para>\r
527                                                         Open the selected file, either with the default viewer for\r
528                                                         that file type, or with a program you choose.\r
529                                                 </para>\r
530                                         </listitem>\r
531                                 </varlistentry>\r
533                                 <varlistentry>\r
534                                         <term>Explore to</term>\r
535                                         <listitem>\r
536                                                 <para>\r
537                                                         Open directory of file with Explore.\r
538                                                 </para>\r
539                                         </listitem>\r
540                                 </varlistentry>\r
542                                 <varlistentry>\r
543                                         <term>Copy paths to clipboard</term>\r
544                                         <listitem>\r
545                                                 <para>\r
546                                                         Copy paths to clipboard\r
547                                                 </para>\r
548                                         </listitem>\r
549                                 </varlistentry>\r
551                                 <varlistentry>\r
552                                         <term>Copy all information to clipboard</term>\r
553                                         <listitem>\r
554                                                 <para>\r
555                                                         Copy all information to clipboard, include version info.\r
556                                                 </para>\r
557                                         </listitem>\r
558                                 </varlistentry>\r
559                         </variablelist>\r
560                 </para>\r
561                 <tip>\r
562                         <para>\r
563                                 You may notice that sometimes we refer to changes and other times\r
564                                 to differences. What's the difference?\r
565                         </para>\r
566                 </tip>\r
567         </sect2>\r
568         <sect2 id="tsvn-dug-showlog-filter">\r
569                 <title>Filtering Log Messages</title>\r
570                 <indexterm>\r
571                         <primary>filter</primary>\r
572                 </indexterm>\r
573                 <para>\r
574                         If you want to restrict the log messages to show only those\r
575                         you are interested in rather than scrolling through a list\r
576                         of hundreds, you can use the filter controls at the top of\r
577                         the Log Dialog. The start and end date controls allow you\r
578                         to restrict the output to a known date range. The search\r
579                         box allows you to show only messages which contain a\r
580                         particular phrase.\r
581                 </para>\r
582                 <para>\r
583                         Click on the search icon to select which information you want\r
584                         to search in, and to choose <emphasis>regex</emphasis> mode.\r
585                         Normally you will only need a simple text search, but if you\r
586                         need to more flexible search terms, you can use regular expressions.\r
587                         If you hover the mouse over the box, a tooltip will give hints\r
588                         on how to use the regex functions.\r
589                         You can also find online documentation and a tutorial at\r
590                         <ulink url="http://www.regular-expressions.info/">\r
591                                 <citetitle>http://www.regular-expressions.info/</citetitle>\r
592                         </ulink>.\r
593                         The filter works by checking whether your filter string matches\r
594                         the log entries, and then only those entries which <emphasis>match</emphasis>\r
595                         the filter string are shown.\r
596                 </para>\r
597                 <para>\r
598                         To make the filter show all log entries that do <emphasis>not</emphasis>\r
599                         match the filter string, start the string with an exclamation mark ('!').\r
600                         For example, a filter string <literal>!username</literal> will only\r
601                         show those entries which were not committed by <literal>username</literal>.\r
602                 </para>\r
603                 <para>\r
604                         Note that these filters act on the messages already retrieved.\r
605                         They do not control downloading of messages from the repository.\r
606                 </para>\r
607                 <para>\r
608                         You can also filter the path names in the bottom pane using the\r
609                         <guilabel>Hide unrelated changed paths</guilabel> checkbox.\r
610                         Related paths are those which contain the path used to display\r
611                         the log. If you fetch the log for a folder, that means anything\r
612                         in that folder or below it. For a file it means just that one file.\r
613                         The checkbox is tristate: you can show all paths, grey out the\r
614                         unrelated ones, or hide the unrelated paths completely.\r
615                 </para>\r
617                 <para>\r
618                         You can show all branches history by click <guilabel>All branches</guilabel>\r
619                 </para>\r
620                 <para>\r
621                         You can show whole project history, no choose directory or file by click\r
622                         <guilabel>Show Whole Project</guilabel>\r
623                 </para>\r
624                 <para>\r
625                         <guilabel>First Parent</guilabel> just follow up first parent commit. This will\r
626                         help understand overwhole history.\r
627                 </para>\r
628         </sect2>\r
629         <sect2 id="tsvn-dug-showlog-5">\r
630                 <?dbhh topicname="HIDD_STATGRAPH"?>\r
631                 <title>Statistical Information</title>\r
632                 <indexterm>\r
633                         <primary>statistics</primary>\r
634                 </indexterm>\r
635                 <para>\r
636                         The <guibutton>Statistics</guibutton> button brings up a box\r
637                         showing some interesting information about the revisions\r
638                         shown in the Log dialog. This shows how many authors have\r
639                         been at work, how many commits they have made, progress\r
640                         by week, and much more. Now you can see at a glance who\r
641                         has been working hardest and who is slacking ;-)\r
642                 </para>\r
643                 <sect3 id="tsvn-dug-showlog-stats-1">\r
644                         <title>Statistics Page</title>\r
645                         <para>\r
646                                 This page gives you all the numbers you can think of,\r
647                                 in particular the period and number of revisions covered,\r
648                                 and some min/max/average values.\r
649                         </para>\r
650                 </sect3>\r
651                 <sect3 id="tsvn-dug-showlog-stats-2">\r
652                         <title>Commits by Author Page</title>\r
653                         <para>\r
654                                 <figure id="tsvn-dug-showlog-stats-dia-2">\r
655                                         <title>Commits-by-Author Histogram</title>\r
656                                         <graphic fileref="../images/StatsByAuthor.png"/>\r
657                                 </figure>\r
658                                 This graph shows you which authors have been active on the\r
659                                 project as a simple histogram, stacked histogram or\r
660                                 pie chart.\r
661                                 <figure id="tsvn-dug-showlog-stats-dia-3">\r
662                                         <title>Commits-by-Author Pie Chart</title>\r
663                                         <graphic fileref="../images/StatsByAuthPie.png"/>\r
664                                 </figure>\r
665                         </para>\r
666                         <para>\r
667                                 Where there are a few major authors and many minor contributors,\r
668                                 the number of tiny segments can make the graph more difficult to\r
669                                 read. The slider at the bottom allows you to set a threshold\r
670                                 (as a percentage of total commits) below which any activity is\r
671                                 grouped into an <emphasis>Others</emphasis> category.\r
672                         </para>\r
673                 </sect3>\r
674                 <sect3 id="tsvn-dug-showlog-stats-3">\r
675                         <title>Commits by date Page</title>\r
676                         <para>\r
677                                 <figure id="tsvn-dug-showlog-stats-dia-4">\r
678                                         <title>Commits-by-date Graph</title>\r
679                                         <graphic fileref="../images/StatsByDate.png"/>\r
680                                 </figure>\r
681                                 This page gives you a graphical representation of project\r
682                                 activity in terms of number of commits <emphasis>and</emphasis>\r
683                                 author. This gives some idea of when a project is being worked\r
684                                 on, and who was working at which time.\r
685                         </para>\r
686                         <para>\r
687                                 When there are several authors, you will get many lines on the\r
688                                 graph. There are two views available here: <emphasis>normal</emphasis>,\r
689                                 where each author's activity is relative to the base line, and\r
690                                 <emphasis>stacked</emphasis>, where each author's activity is\r
691                                 relative to the line underneath.\r
692                                 The latter option avoids the lines crossing over, which can make\r
693                                 the graph easier to read, but less easy to see one author's output.\r
694                         </para>\r
695                 </sect3>\r
696                 <para>\r
697                         By default the analysis is case-sensitive, so users\r
698                         <literal>PeterEgan</literal> and <literal>PeteRegan</literal>\r
699                         are treated as different authors. However, in many cases user names\r
700                         are not case-sensitive, and are sometimes entered inconsistently,\r
701                         so you may want <literal>DavidMorgan</literal> and\r
702                         <literal>davidmorgan</literal> to be treated as the same person.\r
703                         Use the <guilabel>Authors case insensitive</guilabel> checkbox\r
704                         to control how this is handled.\r
705                 </para>\r
706                 <para>\r
707                         Note that the statistics cover the same period as the\r
708                         Log dialog. If that is only displaying one revision\r
709                         then the statistics will not tell you very much.\r
710                 </para>\r
711         </sect2>\r
712         <sect2 id="tsvn-dug-showlog-refresh">\r
713                 <title>Refreshing the View</title>\r
714                 <para>\r
715                         If you want to check the repository again for newer log messages,\r
716                         you can simply refresh the view using <keycap>F5</keycap>. If you\r
717                         are using the log cache (enabled by default), this will check the\r
718                         repository for newer messages and fetch only the new ones.\r
719                 </para>\r
720         </sect2>\r
721 </sect1>\r