| blob | db6b9995e503a05e848e9bf4b4c1664f28c0d1d3 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect1 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect1 id="tsvn-dug-wcstatus">\r
4 <title>Getting Status Information</title>\r
5 <indexterm>\r
6 <primary>status</primary>\r
7 </indexterm>\r
8 <indexterm>\r
9 <primary>view changes</primary>\r
10 </indexterm>\r
11 <indexterm>\r
12 <primary>working copy status</primary>\r
13 </indexterm>\r
14 <para>\r
15 While you are working on your working copy you often need to know\r
16 which files you have changed/added/removed or renamed, or even which\r
17 files got changed and committed by others.\r
18 </para>\r
19 <sect2 id="tsvn-dug-wcstatus-1">\r
20 <title>Icon Overlays</title>\r
21 <indexterm>\r
22 <primary>overlays</primary>\r
23 </indexterm>\r
24 <indexterm>\r
25 <primary>icons</primary>\r
26 </indexterm>\r
27 <para>\r
28 <figure id="tsvn-dug-wcstatus-dia-1">\r
29 <title>Explorer showing icon overlays</title>\r
30 <graphic fileref="../images/Overlays.png"/>\r
31 </figure>\r
32 </para>\r
33 <para>\r
34 Now that you have checked out a working copy from a Subversion\r
35 repository you can see your files in the windows explorer with\r
36 changed icons. This is one of the reasons why TortoiseGit is so\r
37 popular. TortoiseGit adds a so called overlay icon to each\r
38 file icon which overlaps the original file icon. Depending on\r
39 the Subversion status of the file the overlay icon is different.\r
40 </para>\r
41 <para>\r
42 <graphic fileref="../images/InSubVersionIcon.png"/>\r
43 A fresh checked out working copy has a green checkmark as overlay.\r
44 That means the Subversion status is <emphasis>normal</emphasis>.\r
45 </para>\r
46 <para>\r
47 <graphic fileref="../images/ModifiedIcon.png"/>\r
48 As soon as you start editing a file,\r
49 the status changes to <emphasis>modified</emphasis>\r
50 and the icon overlay then changes to a red exclamation\r
51 mark. That way you can easily see which files were changed\r
52 since you last updated your working copy and need to be committed.\r
53 </para>\r
54 <para>\r
55 <graphic fileref="../images/ConflictIcon.png"/>\r
56 If during an update a <emphasis>conflict</emphasis> occurs then\r
57 the icon changes to a yellow exclamation mark.\r
58 </para>\r
59 <para>\r
60 <graphic fileref="../images/ReadOnlyIcon.png"/> \r
61 If you have set the <literal>svn:needs-lock</literal> property on a file,\r
62 Subversion makes that file read-only until you get a lock on that file.\r
63 Such files have this overlay to indicate that you have to get a lock\r
64 first before you can edit that file.\r
65 </para>\r
66 <para>\r
67 <graphic fileref="../images/LockedIcon.png"/> \r
68 If you hold a lock on a file, and the Subversion status is\r
69 <emphasis>normal</emphasis>, this icon overlay reminds you that you\r
70 should release the lock if you are not using it to allow others to\r
71 commit their changes to the file.\r
72 </para>\r
73 <para>\r
74 <graphic fileref="../images/DeletedIcon.png"/> \r
75 This icon shows you that some files or folders inside the current folder\r
76 have been scheduled to be <emphasis>deleted</emphasis> from version control\r
77 or a file under version control is missing in a folder.\r
78 </para>\r
79 <para>\r
80 <graphic fileref="../images/AddedIcon.png"/> \r
81 The plus sign tells you that a file or folder has been scheduled to be\r
82 <emphasis>added</emphasis> to version control.\r
83 </para>\r
84 <para>\r
85 <graphic fileref="../images/IgnoredIcon.png"/> \r
86 The bar sign tells you that a file or folder is\r
87 <emphasis>ignored</emphasis> for version control purposes.\r
88 This overlay is optional.\r
89 </para>\r
90 <para>\r
91 <graphic fileref="../images/UnversionedIcon.png"/> \r
92 This icon shows files and folders which are not under version control,\r
93 but have not been ignored.\r
94 This overlay is optional.\r
95 </para>\r
96 <para>\r
97 In fact, you may find that not all of these icons are used on your system.\r
98 This is because the number of overlays allowed by Windows is very limited\r
99 and if you are also using an old version of TortoiseCVS, then there are\r
100 not enough overlay slots available.\r
101 TortoiseGit tries to be a <quote>Good Citizen (TM)</quote>\r
102 and limits its use of overlays to give other apps a chance too.\r
103 </para>\r
104 <para>\r
105 Now that there are more Tortoise clients around (TortoiseCVS, TortoiseHG, ...)\r
106 the icon limit becomes a real problem. To work around this, the TortoiseGit\r
107 project introduced a common shared icon set, loaded as a DLL, which can be\r
108 used by all Tortoise clients. Check with your client provider to see if\r
109 this has been integrated yet :-)\r
110 </para>\r
111 <para>\r
112 For a description of how icon overlays correspond to Subversion\r
113 status and other technical details, read\r
114 <xref linkend="tsvn-app-internals-overlays"/>.\r
115 </para>\r
116 </sect2>\r
117 <sect2>\r
118 <title>TortoiseGit Columns In Windows Explorer</title>\r
119 <indexterm>\r
120 <primary>Explorer Columns</primary>\r
121 </indexterm>\r
122 <para>\r
123 The same information which is available from the icon overlays\r
124 (and much more) can be displayed as additional columns in\r
125 Windows Explorer's Details View.\r
126 </para>\r
127 <para>\r
128 Simply right click on one of the headings of a column, choose\r
129 <guimenuitem>More...</guimenuitem> from the context menu displayed. A\r
130 dialog will appear where you can specify the columns and their\r
131 order, which is displayed in the <quote>Detailed View</quote>. Scroll down\r
132 until the entries starting with SVN come into view. Check the\r
133 ones you would like to have displayed and close the dialog by\r
134 pressing <guibutton>OK</guibutton>. The columns will be appended\r
135 to the right of those currently displayed. You can reorder them by\r
136 drag and drop, or resize them, so that they fit your needs.\r
137 </para>\r
138 <important>\r
139 <para>The additional columns in the Windows Explorer are not\r
140 available on Vista, since Microsoft decided to not allow such\r
141 columns for <emphasis>all</emphasis> files anymore but only\r
142 for specific file types.</para>\r
143 </important>\r
144 <tip>\r
145 <para>\r
146 If you want the current layout to be displayed in all your\r
147 working copies, you may want to make this the default view.\r
148 </para>\r
149 </tip>\r
150 </sect2>\r
151 <sect2 id="tsvn-dug-wcstatus-2">\r
152 <?dbhh topicname="HIDD_CHANGEDFILES"?>\r
153 <title>Local and Remote Status</title>\r
154 <indexterm>\r
155 <primary>status</primary>\r
156 </indexterm>\r
157 <indexterm>\r
158 <primary>modifications</primary>\r
159 </indexterm>\r
160 <para>\r
161 <figure id="tsvn-dug-wcstatus-dia-2">\r
162 <title>Check for Modifications</title>\r
163 <graphic fileref="../images/RepoStatus.png"/>\r
164 </figure>\r
165 It's often very useful to know which files you have\r
166 changed and also which files got changed and\r
167 committed by others. That's where the command\r
168 <menuchoice>\r
169 <guimenu>TortoiseGit</guimenu>\r
170 <guimenuitem>Check For Modifications...</guimenuitem>\r
171 </menuchoice>\r
172 comes in handy.\r
173 This dialog will show you every file that has changed in any\r
174 way in your working copy, as well as any unversioned files\r
175 you may have.\r
176 </para>\r
177 <para>\r
178 If you click on the\r
179 <guibutton>Check Repository</guibutton> then you can also\r
180 look for changes in the repository. That way\r
181 you can check before an update if there's a possible conflict.\r
182 You can also update selected files from the repository without\r
183 updating the whole folder. By default, the <guibutton>Check Repository</guibutton>\r
184 button only fetches the remote status with the checkout depth\r
185 of the working copy. If you want to see all files and folders\r
186 in the repository, even those you have not checked out, then you\r
187 have to hold down the <keycap>Shift</keycap> key when you \r
188 click on the <guibutton>Check Repository</guibutton> button.\r
189 </para>\r
190 <para>\r
191 The dialog uses colour coding to highlight the status.\r
192 <variablelist>\r
193 <varlistentry>\r
194 <term>Blue</term>\r
195 <listitem>\r
196 <para>\r
197 Locally modified items.\r
198 </para>\r
199 </listitem>\r
200 </varlistentry>\r
201 <varlistentry>\r
202 <term>Purple</term>\r
203 <listitem>\r
204 <para>\r
205 Added items.\r
206 Items which have been added with history have a\r
207 <literal>+</literal> sign in the\r
208 <guilabel>Text status</guilabel> column,\r
209 and a tooltip shows where the item was copied from.\r
210 </para>\r
211 </listitem>\r
212 </varlistentry>\r
213 <varlistentry>\r
214 <term>Dark red</term>\r
215 <listitem>\r
216 <para>\r
217 Deleted or missing items.\r
218 </para>\r
219 </listitem>\r
220 </varlistentry>\r
221 <varlistentry>\r
222 <term>Green</term>\r
223 <listitem>\r
224 <para>\r
225 Items modified locally and in the repository.\r
226 The changes will be merged on update.\r
227 These <emphasis>may</emphasis> produce conflicts on update.\r
228 </para>\r
229 </listitem>\r
230 </varlistentry>\r
231 <varlistentry>\r
232 <term>Bright red</term>\r
233 <listitem>\r
234 <para>\r
235 Items modified locally and deleted in repository,\r
236 or modified in repository and deleted locally.\r
237 These <emphasis>will</emphasis> produce conflicts on update.\r
238 </para>\r
239 </listitem>\r
240 </varlistentry>\r
241 <varlistentry>\r
242 <term>Black</term>\r
243 <listitem>\r
244 <para>\r
245 Unchanged and unversioned items.\r
246 </para>\r
247 </listitem>\r
248 </varlistentry>\r
249 </variablelist>\r
250 </para>\r
251 <para>\r
252 This is the default colour scheme, but you can customise those colours\r
253 using the settings dialog.\r
254 Read <xref linkend="tsvn-dug-settings-colours"/> for more information.\r
255 </para>\r
256 <para>\r
257 Items which have been switched to a different repository path are\r
258 also indicated using an <literal>(s)</literal> marker. You may have\r
259 switched something while working on a branch and forgotten to switch\r
260 back to trunk. This is your warning sign!\r
261 </para>\r
262 <para>\r
263 From the context menu of the dialog you can show a diff of the\r
264 changes. Check the local changes <emphasis>you</emphasis> made using\r
265 <menuchoice>\r
266 <guimenu>Context Menu</guimenu>\r
267 <guimenuitem>Compare with Base</guimenuitem>\r
268 </menuchoice>.\r
269 Check the changes in the repository made by others using\r
270 <menuchoice>\r
271 <guimenu>Context Menu</guimenu>\r
272 <guimenuitem>Show Differences as Unified Diff</guimenuitem>\r
273 </menuchoice>.\r
274 </para>\r
275 <para>\r
276 You can also revert changes in individual files. If you have deleted\r
277 a file accidentally, it will show up as <emphasis>Missing</emphasis>\r
278 and you can use <emphasis>Revert</emphasis> to recover it.\r
279 </para>\r
280 <para>\r
281 Unversioned and ignored files can be sent to the recycle bin from here using\r
282 <menuchoice>\r
283 <guimenu>Context Menu</guimenu>\r
284 <guimenuitem>Delete</guimenuitem>\r
285 </menuchoice>.\r
286 If you want to delete files permanently (bypassing the recycle bin) hold\r
287 the <keycap>Shift</keycap> key while clicking on <guilabel>Delete</guilabel>.\r
288 </para>\r
289 <para>\r
290 If you want to examine a file in detail, you can drag it from here\r
291 into another application such as a text editor or IDE.\r
292 </para>\r
293 <para>\r
294 The columns are customizable. If you\r
295 <action>right click</action> on any column header you will see a\r
296 context menu allowing you to select which columns are displayed.\r
297 You can also change column width by using the drag handle which\r
298 appears when you move the mouse over a column boundary. These\r
299 customizations are preserved, so you will see the same headings\r
300 next time.\r
301 </para>\r
302 <para>\r
303 If you are working on several unrelated tasks at once, you can also\r
304 group files together into changelists.\r
305 Read <xref linkend="tsvn-dug-commit-changelists"/> for more information.\r
306 </para>\r
307 <para>\r
308 At the bottom of the dialog you can see a summary of the range of repository\r
309 revisions in use in your working copy. These are the <emphasis>commit</emphasis>\r
310 revisions, not the <emphasis>update</emphasis> revisions; they represent the\r
311 range of revisions where these files were last committed, not the revisions\r
312 to which they have been updated. Note that the revision range shown applies\r
313 only to the items displayed, not to the entire working copy. If you want to\r
314 see that information for the whole working copy you must check the\r
315 <guilabel>Show unmodified files</guilabel> checkbox.\r
316 </para>\r
317 <tip>\r
318 <para>\r
319 If you want a flat view of your working copy, i.e. showing all files\r
320 and folders at every level of the folder hierarchy, then the\r
321 <guilabel>Check for Modifications</guilabel> dialog is the\r
322 easiest way to achieve that. Just check the\r
323 <guilabel>Show unmodified files</guilabel> checkbox to show\r
324 all files in your working copy.\r
325 </para>\r
326 </tip>\r
327 <tip>\r
328 <title>Repairing External Renames</title>\r
329 <para>\r
330 Sometimes files get renamed outside of Subversion, and they show up\r
331 in the file list as a missing file and an unversioned file. To avoid\r
332 losing the history you need to notify Subversion about the connection.\r
333 Simply select both the old name (missing) and the new name (unversioned)\r
334 and use\r
335 <menuchoice>\r
336 <guimenu>Context Menu</guimenu>\r
337 <guimenuitem>Repair Move</guimenuitem>\r
338 </menuchoice>\r
339 to pair the two files as a rename.\r
340 </para>\r
341 </tip>\r
342 </sect2>\r
343 <sect2 id="tsvn-dug-diffing">\r
344 <title>Viewing Diffs</title>\r
345 <indexterm>\r
346 <primary>diffing</primary>\r
347 </indexterm>\r
348 <para>\r
349 Often you want to look inside your files, to have a look at what\r
350 you've changed. You can accomplish this by selecting a file which\r
351 has changed, and selecting <guimenuitem>Diff</guimenuitem> from\r
352 TortoiseGit's context menu. This starts the external\r
353 diff-viewer, which will then compare the current file with the\r
354 pristine copy (<literal>BASE</literal> revision), which was stored\r
355 after the last checkout or update.\r
356 </para>\r
357 <tip>\r
358 <para>\r
359 Even when not inside a working copy or when you have multiple\r
360 versions of the file lying around, you can still display diffs:\r
361 </para>\r
362 <para>\r
363 Select the two files you want to compare in explorer\r
364 (e.g. using <keycap>Ctrl</keycap> and the mouse) and\r
365 choose <guimenuitem>Diff</guimenuitem> from TortoiseGit's\r
366 context menu. The file clicked last (the one with the focus,\r
367 i.e. the dotted rectangle) will be regarded as the later\r
368 one. \r
369 </para>\r
370 </tip>\r
371 </sect2>\r
372 </sect1>\r