doc/source/en/TortoiseMerge/tme_dug_views.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE chapter SYSTEM "../../dtd/dblite.dtd">\r
   3 <sect1 id="tmerge-dug-views">\r
   4         <title>Viewing Modes</title>\r
   5         <para>\r
   6                 TortoiseMerge has three main viewing modes: one-pane, two-pane\r
   7                 and three-pane view. One/two-pane view is used to view changes\r
   8                 and three-pane view is used to resolve conflicts.\r
   9         </para>\r
  10         <sect2 id="tmerge-dug-view-merge">\r
  11                 <title>Viewing / Merging</title>\r
  12                 <figure id="tmerge-dug-dia-1pane">\r
  13                         <title>One Pane View</title>\r
  14                         <graphic fileref="images/TMerge_OnePane.png"/>\r
  15                 </figure>\r
  16                 <figure id="tmerge-dug-dia-2pane">\r
  17                         <title>Two Pane View</title>\r
  18                         <graphic fileref="images/TMerge_TwoPane.png"/>\r
  19                 </figure>\r
  20                 <para>\r
  21                         The two pane view has some features which are not available\r
  22                         in the one pane view:\r
  23                         <itemizedlist>\r
  24                                 <listitem>\r
  25                                         <para>\r
  26                                                 Changes inside the modified lines are shown in different\r
  27                                                 colors. Added string parts are shown with a lighter color,\r
  28                                                 but you can of course configure the colors used here.\r
  29                                                 Removed parts are indicated with a dark brown vertical\r
  30                                                 line in the string. Check out the screenshot above to\r
  31                                                 see how this works.\r
  32                                         </para>\r
  33                                 </listitem>\r
  34                                 <listitem>\r
  35                                         <para>\r
  36                                                 Code reorganization usually means a lot of changes in whitespaces\r
  37                                                 (space, tab, newlines) but no actual code change. For example,\r
  38                                                 you split up a very long line into several lines, or you sometimes\r
  39                                                 compact several lines together into one.\r
  40                                         </para>\r
  41                                         <para>\r
  42                                                 Such changes are marked with a white circle symbol on the left side\r
  43                                                 of the views. If you see such a white circle, you know immediately\r
  44                                                 that no real code change is there and you don't have to check the\r
  45                                                 changed block further.\r
  46                                         </para>\r
  47                                 </listitem>\r
  48                                 <listitem>\r
  49                                         <para>\r
  50                                                 Hand editing of the file in the right pane is possible in two-pane\r
  51                                                 view. Such changes are marked with a pencil symbol.\r
  52                                         </para>\r
  53                                 </listitem>\r
  54                         </itemizedlist>\r
  55                 </para>\r
  56                 <para>\r
  57                         If you want to compare/merge three files, TortoiseMerge \r
  58                         will show you the differences in a three pane view. This view \r
  59                         is also used if you need to resolve conflicted files.\r
  60                 </para>\r
  61                 <figure id="tmerge-dug-dia-3pane">\r
  62                         <title>Three Pane View</title>\r
  63                         <graphic fileref="images/TMerge_ThreePane.png"/>\r
  64                 </figure>\r
  65                 <para>\r
  66                         The left pane shows you the differences between \r
  67                         <emphasis>Their</emphasis> file and the <emphasis>Base</emphasis>\r
  68                         file, while the right pane shows you the differences between\r
  69                         <emphasis>Mine</emphasis> file and the <emphasis>Base</emphasis>\r
  70                         file. The bottom pane shows you the result of merging\r
  71                         <emphasis>Base</emphasis>, <emphasis>Mine</emphasis> and \r
  72                         <emphasis>Theirs</emphasis> with possible conflicts.\r
  73                 </para>\r
  74                 <para>\r
  75                         If you hover the mouse over the pane title, a tooltip will\r
  76                         show the filenames used for the diff in each pane.\r
  77                 </para>\r
  78         </sect2>\r
  79         <sect2 id="tmerge-dug-view-patch">\r
  80                 <title>Applying Patches</title>\r
  81                 <para>\r
  82                         After TortoiseMerge parses the patch file it will show\r
  83                         you a small window with all the files which have changes\r
  84                         according to the patch file.\r
  85                         <figure id="tmerge-dug-dia-patch">\r
  86                                 <title>Patch File List</title>\r
  87                                 <graphic fileref="images/TMerge_PatchWindow.png"/>\r
  88                         </figure>\r
  89                         If the filename is shown in black, then the patch can be applied\r
  90                         without any problems. That means the file is not outdated\r
  91                         according to the patch.\r
  92                         However, if the filename is shown in red, then the patch can't\r
  93                         get applied directly because you already changed that file.\r
  94                 </para>\r
  95                 <para>\r
  96                         But don't worry. If you're working with Git you can\r
  97                         retrieve an older version of the file and resolve the conflict.\r
  98                         In fact, TortoiseMerge automatically tries to get that older\r
  99                         version of the file and then shows you the diff between\r
 100                         <emphasis>Base</emphasis> (the older version of the file),\r
 101                         <emphasis>Mine</emphasis> (the file as it is currently in your\r
 102                         working copy) and <emphasis>Theirs</emphasis> (the older version\r
 103                         of the file with the patch already applied). Then you can\r
 104                         resolve possible conflicts manually.\r
 105                 </para>\r
 106                 <para>\r
 107                         The patch file window has a context menu which allows you to\r
 108                         preview the effect of the patch on the current file\r
 109                         (apply without saving), to apply and save the changes\r
 110                         for the selected file, or to apply and save changes to\r
 111                         <emphasis>all</emphasis> files in the list.\r
 112                         The double-click action is to preview.\r
 113                 </para>\r
 114                 <para>\r
 115                         Depending on whether TortoiseMerge can apply the patch directly\r
 116                         or by fetching an older version of the file first, it shows you\r
 117                         a two pane view (patch can be applied directly) or a three pane\r
 118                         view (older version of file fetched).\r
 119                 </para>\r
 120         </sect2>\r
 121 </sect1>\r