| blob | 978994b53002930810f3d2d5bc83e78a8252c538 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect2 id="tgit-dug-settings-main">\r
4 <?dbhh topicname="HIDD_SETTINGSMAIN"?>\r
5 <?dbhh topicname="HIDD_FIRSTSTARTWIZARD_GIT"?>\r
6 <title>General Settings</title>\r
7 <indexterm>\r
8 <primary>git.exe path</primary>\r
9 </indexterm>\r
10 <indexterm>\r
11 <primary>Cygwin git</primary>\r
12 </indexterm>\r
13 <indexterm>\r
14 <primary>Msys2 git</primary>\r
15 </indexterm>\r
16 <indexterm>\r
17 <primary>Extern DLL Path</primary>\r
18 </indexterm>\r
19 <indexterm>\r
20 <primary>Extra PATH</primary>\r
21 </indexterm>\r
22 <para>\r
23 <figure id="tgit-dug-settings-dia-main">\r
24 <title>The Settings Dialog, General Page</title>\r
25 <graphic fileref="../images/SettingsMain.png"/>\r
26 </figure>\r
27 This dialog allows you to specify your preferred language,\r
28 and the Git-specific settings.\r
29 </para>\r
30 <variablelist>\r
31 <varlistentry>\r
32 <term>Language</term>\r
33 <listitem>\r
34 <para>\r
35 Selects your user interface language.\r
36 What else did you expect? Only languages of installed LanguagePacks are listed.\r
37 You can download language packs on the <ulink url="https://tortoisegit.org/download">TortoiseGit download page</ulink>\r
38 or <ulink url="https://tortoisegit.org/translate">help translating</ulink>.\r
39 </para>\r
40 </listitem>\r
41 </varlistentry>\r
42 <varlistentry>\r
43 <term>Automatically check for newer versions every week</term>\r
44 <listitem>\r
45 <para>\r
46 If checked, TortoiseGit will contact its download site once a week \r
47 to see if there is a newer version of the program available.\r
48 Use <guibutton>Check now</guibutton> if you want an answer\r
49 right away. The new version will not be downloaded; you\r
50 simply receive an information dialog telling you that the\r
51 new version is available.\r
52 </para>\r
53 </listitem>\r
54 </varlistentry>\r
55 <varlistentry>\r
56 <term>Create Library</term>\r
57 <listitem>\r
58 <para>\r
59 On Windows 7 you can create a Library in which to group working copies\r
60 which are scattered in various places on your system.\r
61 </para>\r
62 </listitem>\r
63 </varlistentry>\r
64 <varlistentry>\r
65 <term>Git.exe Path</term>\r
66 <listitem>\r
67 <para>\r
68 TortoiseGit needs to know which <literal>git.exe</literal> to use for it's operations. Enter the full path to <literal>git.exe</literal> here.\r
69 </para>\r
70 <para>\r
71 <caution>\r
72 <para>\r
73 git.exe must not be marked to be run in elevated mode (i.e. "Run as administrator" or run in any compatibility mode).\r
74 </para>\r
75 </caution>\r
76 <caution>\r
77 <para>\r
78 There is a <ulink url="https://github.com/msysgit/msysgit/issues/103"><citetitle>known issue in msysGit/Git for Windows</citetitle></ulink>:\r
79 Git for Windows provides two <literal>git.exe</literal>-files (one in a folder named <literal>bin</literal> and one in a folder named <literal>cmd</literal>).\r
80 Make sure <guilabel>Git.exe Path</guilabel> points to the <literal>bin</literal>-folder within the Git for Windows installation folder.\r
81 </para>\r
82 </caution>\r
83 <caution>\r
84 <para>\r
85 If you don't use Git for Windows, please see the sections for "Cygwin git" and "Msys2 git" below as special settings are required here.\r
86 </para>\r
87 <para>\r
88 As a general note: There is no official support for Cygwin or Msys2 git in TortoiseGit. The TortoiseGit developers only use Git for Windows. Bug reports, however, are welcome.\r
89 </para>\r
90 </caution>\r
91 </para>\r
92 <para>\r
93 <tip>\r
94 <para>\r
95 In order to debug problems you can open TortoiseGit advanced settings and set "DebugOutputString" to "true" (<xref linkend="tgit-dug-settings-registry"/>). Start capturing the debug output.\r
96 Then start TortoiseGit settings, click on <guilabel>Check now</guilabel> and observe the debug messages.\r
97 </para>\r
98 </tip>\r
99 </para>\r
100 </listitem>\r
101 </varlistentry>\r
102 <varlistentry>\r
103 <term>Extra PATH</term>\r
104 <listitem>\r
105 <para>\r
106 If your git installation needs an extra entry in the PATH environment variable,\r
107 you can enter it here and it will get added to the PATH environment variable automatically when TortoiseGit starts.\r
108 </para>\r
109 <para>\r
110 This is especially needed if you installed the developer version of msysGit ("Full installer (self-contained) if you want to hack on Git" with the filename <literal>msysGit-fullinstall-*.exe</literal>),\r
111 in this case it is necessary that the <literal>[MSYSGIT-INSTALL-PATH]\mingw\bin</literal>-folder is on the path (i.e. entered in the <guilabel>Extra PATH</guilabel> textbox) in order to execute git.exe.\r
112 </para>\r
113 <para>\r
114 Often you can see if you need this when you start git.exe in <literal>[MSYSGIT-INSTALL-PATH]\mingw\bin</literal>-folder and you get a messagebox saying that a dll is missing.\r
115 </para>\r
116 </listitem>\r
117 </varlistentry>\r
118 <varlistentry>\r
119 <term>Cygwin Git</term>\r
120 <listitem>\r
121 <para>\r
122 As noted above: There is no official support for Cygwin git in TortoiseGit (do not enable this for the "Git for Windows package!). The TortoiseGit developers only use Git for Windows. Bug reports, however, are welcome. If you really want to use it here are the steps you have to perform:\r
123 </para>\r
124 <para>\r
125 1) Select the <literal>[CYGWIN-INSTALL-PATH]\bin</literal>-folder as git.exe folder.\r
126 </para>\r
127 <para>\r
128 2) Configure the <literal>HOME</literal> environment variable in Windows, so that Cygwin and TortoiseGit are using the same home directory and global git-config. Use the normal Windows notation here (e.g., "C:\Users\USERNAME"). By default, TortoiseGit uses the Windows home directory which is normally located under <literal>c:\Users</literal> and Cygwin uses its own home directories which are located under <literal>[CYGWIN-INSTALL-PATH]\home</literal>.\r
129 </para>\r
130 <para>\r
131 3) Configure AutoCrLf, this is necessary as TortoiseGit and Cygwin Git have different defaults. The default in Cygwin Git is <literal>true</literal>.\r
132 </para>\r
133 <para>\r
134 4) Go to TortoiseGit <xref linkend="tgit-dug-settings-registry"/> and set <literal>CygwinHack</literal> to <literal>true</literal> in order to activate cygwin workarounds.\r
135 </para>\r
136 <para>\r
137 5) Reboot.\r
138 </para>\r
139 </listitem>\r
140 </varlistentry>\r
141 <varlistentry>\r
142 <term>Msys2 Git</term>\r
143 <listitem>\r
144 <para>\r
145 As noted above: There is no official support for Msys2 git in TortoiseGit (do not enable this for the "Git for Windows package!). The TortoiseGit developers only use Git for Windows. Bugreports, however, are welcome. If you really want to use it here are the steps you have to perform:\r
146 </para>\r
147 <para>\r
148 1) Select the <literal>[MSYS2-INSTALL-PATH]\usr\bin</literal>-folder as git.exe folder.\r
149 </para>\r
150 <para>\r
151 2) Configure the <literal>HOME</literal> environment variable in Windows, so that Msys2 and TortoiseGit are using the same home directory and global git-config. Use the normal Windows notation here (e.g., "C:\Users\USERNAME"). By default, TortoiseGit uses the Windows home directory which is normally located under <literal>c:\Users</literal> and Msys2 uses its own home directories which are located under <literal>[MSYS2-INSTALL-PATH]\home</literal>.\r
152 </para>\r
153 <para>\r
154 3) Configure AutoCrLf, this is necessary as TortoiseGit and Msys2 Git might have different defaults.\r
155 </para>\r
156 <para>\r
157 4) Go to TortoiseGit <xref linkend="tgit-dug-settings-registry"/> and set <literal>Msys2Hack</literal> to <literal>true</literal> in order to activate Msys2 workarounds.\r
158 </para>\r
159 <para>\r
160 5) Reboot.\r
161 </para>\r
162 </listitem>\r
163 </varlistentry>\r
164 </variablelist>\r
165 <sect3 id="tgit-dug-settings-look-feel">\r
166 <title>Context Menu Settings</title>\r
167 <?dbhh topicname="HIDD_SETTINGSLOOKANDFEEL"?>\r
168 <para>\r
169 <figure id="tgit-dug-settings-dia-context">\r
170 <title>The Settings Dialog, Context Menu Page</title>\r
171 <graphic fileref="../images/SettingsContext.png"/>\r
172 </figure>\r
173 This page allows you to specify which of the TortoiseGit context menu\r
174 entries will show up in the main context menu, and which will appear\r
175 in the TortoiseGit submenu. By default most items are unchecked and\r
176 appear in the submenu.\r
177 </para>\r
178 <para>\r
179 Most of the time, you won't need the TortoiseGit context menu, apart\r
180 for folders that are under version control by Git. For non-\r
181 versioned folders, you only really need the context menu when you\r
182 want to do a checkout. If you check the option <literal>Hide menus\r
183 for unversioned paths</literal>, TortoiseGit will not add its entries\r
184 to the context menu for unversioned folders. But the entries are\r
185 added for all items and paths in a versioned folder. And you can\r
186 get the entries back for unversioned folders by holding the \r
187 <keycap>Shift</keycap> key down while showing the context menu.\r
188 </para>\r
189 <para>\r
190 If there are some paths on your computer where you just don't want\r
191 TortoiseGit's context menu to appear at all, you can list them in\r
192 the box at the bottom.\r
193 </para>\r
194 <para>\r
195 If you right click and drag folder/file in Windows Explorer, \r
196 a context menu will be shown when you drop. It provides some TortoiseGit actions.\r
197 You can uncheck <guibutton>Enable drag context menu</guibutton>\r
198 to prevent from carelessly clicking the TortoiseGit actions.\r
199 </para>\r
200 </sect3>\r
201 \r
202 <sect3 id="tgit-dug-settings-look-feel-extended">\r
203 <title>Set Extend Menu Item</title>\r
204 <?dbhh topicname="HIDD_SETTINGSEXTMENU"?>\r
205 <para>\r
206 <figure id="tgit-dug-settings-ext-menu">\r
207 <title>The Settings Dialog, Set Extend Menu Item</title>\r
208 <graphic fileref="../images/SettingsExtendMenu.png"/>\r
209 </figure>\r
210 This page allows you to specify which of the TortoiseGit context menu\r
211 entries will show up in the extend context menu (press <keycap>Shift</keycap>\r
212 key on <action>right click</action>), \r
213 and which will appear in the normal context menu. \r
214 This config will help reduce the context menu number at normal usage case\r
215 according to your usage module. \r
216 </para>\r
217 </sect3>\r
218 \r
219 <sect3 id="tgit-dug-settings-dialogs">\r
220 <title>TortoiseGit Dialog Settings</title>\r
221 <?dbhh topicname="HIDD_SETTINGSDIALOGS"?>\r
222 <para>\r
223 <figure id="tgit-dug-settings-dia-dialogs">\r
224 <title>The Settings Dialog, Dialogs Page</title>\r
225 <graphic fileref="../images/SettingsDialog.png"/>\r
226 </figure>\r
227 This dialog allows you to configure some of TortoiseGit's\r
228 dialogs the way you like them.\r
229 </para>\r
230 <variablelist>\r
231 <varlistentry>\r
232 <term>Font for log messages</term>\r
233 <listitem>\r
234 <para>\r
235 Selects the font face and size used to display the log\r
236 message itself in the middle pane of the Revision Log\r
237 dialog, and when composing log messages in the Commit\r
238 dialog.\r
239 </para>\r
240 </listitem>\r
241 </varlistentry>\r
242 <varlistentry>\r
243 <term>Short date / time format in log messages</term>\r
244 <listitem>\r
245 <para>\r
246 If the standard long messages use up too much \r
247 space on your screen use the short format.\r
248 </para>\r
249 </listitem>\r
250 </varlistentry>\r
251 <varlistentry>\r
252 <term>Show asterisk log prefix</term>\r
253 <listitem>\r
254 <para>\r
255 An asterisk is inserted as the prefix of log message in Log dialog.\r
256 </para>\r
257 </listitem>\r
258 </varlistentry>\r
259 <varlistentry>\r
260 <term>apply --topo-order</term>\r
261 <listitem>\r
262 <para>\r
263 Normally log entries/commits are ordered in descending order of the commit date.\r
264 '--topo-order' makes the commits appear in topological order (i.e. descendant\r
265 commits are shown before their parents). Not using this option, might break\r
266 the graph in the log dialog. However, this option is slower, because all\r
267 log entries have to be processed before displaying them.\r
268 </para>\r
269 </listitem>\r
270 </varlistentry>\r
271 <varlistentry>\r
272 <term>Can double-click in log list to compare with previous revision</term>\r
273 <listitem>\r
274 <para>\r
275 If you frequently find yourself comparing revisions in the top\r
276 pane of the log dialog, you can use this option to allow that\r
277 action on double-click. It is not enabled by default because\r
278 fetching the diff is often a long process, and many people\r
279 prefer to avoid the wait after an accidental double-click,\r
280 which is why this option is not enabled by default.\r
281 </para>\r
282 </listitem>\r
283 </varlistentry>\r
284 <varlistentry>\r
285 <term>Abbreviate renamings</term>\r
286 <listitem>\r
287 <para>\r
288 Normally renamed files are listed as "long/path/for/file.txt (from long/path/to/file.txt)".\r
289 If you check this option renamed files will be listed in a shorter format ("long/path/{to => for}/file.txt"),\r
290 however, this abbreviated format might be harder to understand.\r
291 </para>\r
292 </listitem>\r
293 </varlistentry>\r
294 <varlistentry>\r
295 <term>Symbolize ref names</term>\r
296 <listitem>\r
297 <para>\r
298 Show symbols on ref labels to substitute part of the ref names in order to make them smaller.\r
299 If this option is enabled, the following description and example will apply.\r
300 If there is only a single remote, an up-arrow symbol (↑) will substitute the remote name part of each remote branch.\r
301 If the remote branch is the upstream of a local branch, an equivalent symbol (≡) will substitute the branch name part of the remote branch.\r
302 <figure id="tgit-dug-settings-symbolizerefname-example">\r
303 <title>Example of Symbolize ref names</title>\r
304 <graphic fileref="../images/SymbolizeRefNamesExample.png"/>\r
305 </figure>\r
306 </para>\r
307 </listitem>\r
308 </varlistentry>\r
309 <varlistentry>\r
310 <term>Enable log cache</term>\r
311 <listitem>\r
312 <para>\r
313 Load/saves log cache in .git folder (tortoisegit.data, tortoisegit.index) to boost performance of subsequent use of log list.\r
314 If this option is disabled, the cache files are not read or written.\r
315 Default is enabled.\r
316 </para>\r
317 </listitem>\r
318 </varlistentry>\r
319 <varlistentry>\r
320 <term>Enable Gravatar</term>\r
321 <listitem>\r
322 <para>\r
323 Shows the Gravatar image of the author of the commit in Log Dialog.\r
324 The URL is customizable so you may specify more options supported by the server,\r
325 or use your own avatar server.\r
326 The default URL is <literal>http://www.gravatar.com/avatar/%HASH%?d=identicon</literal>\r
327 Currently, the supported parameter is <literal>%HASH%</literal>, which is the MD5 email hash.\r
328 To specify a default image, add <literal>d=</literal> parameter, \r
329 e.g. <literal>http://www.gravatar.com/avatar/%HASH%?d=identicon</literal>\r
330 See <ulink url="http://en.gravatar.com/site/implement/images/">\r
331 <citetitle>Gravatar: Image Requests</citetitle>\r
332 </ulink> for a list of parameters.\r
333 </para>\r
334 </listitem>\r
335 </varlistentry>\r
336 <varlistentry>\r
337 <term>Draw tag/branch labels on right side</term>\r
338 <listitem>\r
339 <para>\r
340 Shows tag/branch labels after the commit message.\r
341 </para>\r
342 </listitem>\r
343 </varlistentry>\r
344 <varlistentry>\r
345 <term>Display branch revision number</term>\r
346 <listitem>\r
347 <para>\r
348 Displays for every selected commit a so called "branch revision number" in the commit message field of the Log Dialog.\r
349 The branch revision number is calculated by calling <literal>git rev-list --count --first-parent [SHA1]</literal> and\r
350 represents the number of commits between the beginning of time and the selected commit.\r
351 This number is NOT guaranteed to be unique, especially if you alter the history (e.g., using rebase) or\r
352 use several branches at the same time. It can be seen "kinda unique" per branch in case you don't alter its history\r
353 (e.g. by rebasing, resetting) and only commit or merge other branches on it. This number is only displayed\r
354 for first-parent commits and not for commits on non-fast-forward merges (here duplicate numbers could occur).\r
355 See <ulink url="https://gcc.gnu.org/ml/gcc/2015-08/msg00148.html">\r
356 <citetitle>https://gcc.gnu.org/ml/gcc/2015-08/msg00148.html</citetitle>\r
357 </ulink>\r
358 and\r
359 <ulink url="https://gitlab.com/tortoisegit/tortoisegit/merge_requests/1">\r
360 <citetitle>https://gitlab.com/tortoisegit/tortoisegit/merge_requests/1</citetitle>\r
361 </ulink> for more details.\r
362 </para>\r
363 </listitem>\r
364 </varlistentry>\r
365 <varlistentry>\r
366 <term>Show describe in log</term>\r
367 <listitem>\r
368 <para>\r
369 Shows describe above commit message in in Log dialog.\r
370 For example, <literal>v0.21.0-589-gdeadc43</literal> refers to the commit\r
371 <literal>deadc43</literal> that is 589 commits ahead the tag <literal>v0.21.0</literal>.\r
372 Note: Describe may take longer to run if the commit\r
373 is far ahead away from a tag.\r
374 </para>\r
375 </listitem>\r
376 </varlistentry>\r
377 <varlistentry>\r
378 <term>Describe strategy</term>\r
379 <listitem>\r
380 <para>\r
381 Determine reference lookup strategy:\r
382 Available options: Annotated tags, All tags, All refs.\r
383 Default strategy is annotated tags only.\r
384 If your repository uses lightweight tags to mark releases, choose All tags.\r
385 </para>\r
386 </listitem>\r
387 </varlistentry>\r
388 <varlistentry>\r
389 <term>Describe Abbreviated size</term>\r
390 <listitem>\r
391 <para>\r
392 Number of chars of the abbreviated commit id to show in describe.\r
393 Default is 7.\r
394 </para>\r
395 </listitem>\r
396 </varlistentry>\r
397 <varlistentry>\r
398 <term>Describe Always show long format</term>\r
399 <listitem>\r
400 <para>\r
401 Whether to use the long format even when a shorter name could be used.\r
402 For example, when the commit <literal>g28f087c</literal> has tag <literal>v0.21.0</literal>, \r
403 it still shows long format <literal>v0.21.0-0-g28f087c</literal> instead of just <literal>v0.21.0</literal>.\r
404 </para>\r
405 </listitem>\r
406 </varlistentry>\r
407 </variablelist>\r
408 </sect3>\r
409 <sect3 id="tgit-dug-settings-dialogs2">\r
410 <title>TortoiseGit Dialog Settings 2</title>\r
411 <?dbhh topicname="HIDD_SETTINGSDIALOGS2"?>\r
412 <para>\r
413 <figure id="tgit-dug-settings-dia-dialogs">\r
414 <title>The Settings Dialog, Dialogs Page 2</title>\r
415 <graphic fileref="../images/SettingsDialog2.png"/>\r
416 </figure>\r
417 This dialog allows you to configure some more of TortoiseGit's\r
418 dialogs the way you like them.\r
419 </para>\r
420 <variablelist>\r
421 <varlistentry>\r
422 <term>Git.exe Progress Dialog</term>\r
423 <listitem>\r
424 <para>\r
425 TortoiseGit can automatically close all progress dialogs \r
426 when the action is finished without error. This setting\r
427 allows you to select the conditions for closing the\r
428 dialogs. The default (recommended) setting is\r
429 <guilabel>Close manually</guilabel>\r
430 which allows you to review all messages and check what\r
431 has happened. However, you may decide that you want to\r
432 ignore some types of message and have the dialog\r
433 close automatically if there are no critical changes.\r
434 </para>\r
435 <!--\r
436 <para>\r
437 <guilabel>Auto-close if no merges, adds or deletes</guilabel>\r
438 means that the progress dialog will close if there were\r
439 simple updates, but if changes from the repository were\r
440 merged with yours, or if any files were added or deleted,\r
441 the dialog will remain open. It will also stay open if\r
442 there were any conflicts or errors during the operation.\r
443 </para>\r
444 <para>\r
445 <guilabel>Auto-close if no merges, adds or deletes for\r
446 local operations</guilabel> means that the progress dialog\r
447 will close as for <guilabel>Auto-close if no merges, adds\r
448 or deletes</guilabel> but only for local operations like adding\r
449 files or reverting changes. For remote operations the\r
450 dialog will stay open.\r
451 </para>\r
452 <para>\r
453 <guilabel>Auto-close if no conflicts</guilabel>\r
454 relaxes the criteria further and will close the dialog\r
455 even if there were merges, adds or deletes. However,\r
456 if there were any conflicts or errors, the dialog\r
457 remains open.\r
458 </para>\r
459 -->\r
460 <para>\r
461 <guilabel>Auto-close if no further options are available</guilabel>\r
462 will close the dialog if git.exe exited cleanly (i.e. no error occurred)\r
463 and no further options are presented in the progress dialog.\r
464 </para>\r
465 <para>\r
466 <guilabel>Auto-close if no errors</guilabel>\r
467 always closes the dialog if git.exe exited with 0 error code.\r
468 </para>\r
469 </listitem>\r
470 </varlistentry>\r
471 <varlistentry>\r
472 <term>Use recycle bin when reverting</term>\r
473 <listitem>\r
474 <para>\r
475 When you revert local modifications, your changes are\r
476 discarded. TortoiseGit gives you an extra safety net by\r
477 sending the modified file to the recycle bin before\r
478 bringing back the pristine copy. If you prefer to\r
479 skip the recycle bin, uncheck this option.\r
480 </para>\r
481 </listitem>\r
482 </varlistentry>\r
483 <varlistentry>\r
484 <term>Confirm to kill running git process</term>\r
485 <listitem>\r
486 <para>\r
487 When enabled, if you close Progress Dialog or Sync Dialog with a running git process,\r
488 you will be asked for confirmation before killing it.\r
489 This avoids closing the dialog by accident that kills running git process.\r
490 </para>\r
491 </listitem>\r
492 </varlistentry>\r
493 <varlistentry>\r
494 <term>Randomize Sync Dialog startup position</term>\r
495 <listitem>\r
496 <para>\r
497 When enabled, the startup position of Sync Dialog will be randomized.\r
498 If you open many Sync Dialogs and press pull button at the same time,\r
499 you may easily press the pull button in any previous Sync Dialog if it finishes and becomes foreground.\r
500 </para>\r
501 </listitem>\r
502 </varlistentry>\r
503 <varlistentry>\r
504 <term>Hide unchanged refs in Ref Compare List</term>\r
505 <listitem>\r
506 <para>\r
507 When enabled, unchanged refs will not be shown in Ref Compare List, so you can focus on changed refs.\r
508 Currently, this list is in Sync Dialog Ref List tab.\r
509 </para>\r
510 </listitem>\r
511 </varlistentry>\r
512 <varlistentry>\r
513 <term>Show git.exe execution timings and timestamp</term>\r
514 <listitem>\r
515 <para>\r
516 When enabled, git.exe execution timings and timestamp will be appended at the end of progress message.\r
517 </para>\r
518 </listitem>\r
519 </varlistentry>\r
520 <varlistentry>\r
521 <term>Sort tag list in reversed order</term>\r
522 <listitem>\r
523 <para>\r
524 When enabled, tag list is sorted in reversed order.\r
525 It is because newer versions are more useful.\r
526 e.g. Export Dialog allows to select the latest tag when this option is enabled.\r
527 </para>\r
528 </listitem>\r
529 </varlistentry>\r
530 <varlistentry>\r
531 <term>Use auto-completion of file paths and keywords</term>\r
532 <listitem>\r
533 <para>\r
534 The commit dialog includes a facility to parse the list\r
535 of filenames being committed. When you type the first 3\r
536 letters of an item in the list, the auto-completion\r
537 box pops up, and you can press Enter to complete the\r
538 filename. Check the box to enable this feature.\r
539 </para>\r
540 </listitem>\r
541 </varlistentry>\r
542 <varlistentry>\r
543 <term>Timeout in seconds to stop the auto-completion parsing</term>\r
544 <listitem>\r
545 <para>\r
546 The auto-completion parser can be quite slow if there are a lot\r
547 of large files to check. This timeout stops the commit dialog\r
548 being held up for too long. If you are missing important\r
549 auto-completion information, you can extend the timeout.\r
550 </para>\r
551 </listitem>\r
552 </varlistentry>\r
553 <varlistentry>\r
554 <term>Max. items to keep in the log message history</term>\r
555 <listitem>\r
556 <para>\r
557 When you type in a log message in the commit dialog, TortoiseGit\r
558 stores it for possible re-use later. By default it will keep the\r
559 last 25 log messages for each repository, but you can customize\r
560 that number here.\r
561 If you have many different repositories, you may wish to\r
562 reduce this to avoid filling your registry.\r
563 </para>\r
564 <para>\r
565 Note that this setting applies only to messages that you type\r
566 in on this computer. It has nothing to do with the log cache.\r
567 </para>\r
568 </listitem>\r
569 </varlistentry>\r
570 <varlistentry>\r
571 <term>Select items automatically</term>\r
572 <listitem>\r
573 <para>\r
574 The normal behaviour in the commit dialog is for all modified\r
575 (versioned) items to be selected for commit automatically.\r
576 If you prefer to start with nothing selected and pick the\r
577 items for commit manually, uncheck this box.\r
578 </para>\r
579 </listitem>\r
580 </varlistentry>\r
581 </variablelist>\r
582 </sect3>\r
583 <sect3 id="tgit-dug-settings-dialogs3">\r
584 <title>TortoiseGit Dialog Settings 3</title>\r
585 <?dbhh topicname="HIDD_SETTINGSDIALOGS3"?>\r
586 <para>\r
587 <figure id="tgit-dug-settings-dia-dialogs">\r
588 <title>The Settings Dialog, Dialogs 3 Page</title>\r
589 <graphic fileref="../images/SettingsDialog3.png"/>\r
590 </figure>\r
591 This dialog allows you to configure some of TortoiseGit's\r
592 dialogs the way you like them.\r
593 This third page mainly affects the Commit dialog and the settings which are stored in git config files.\r
594 </para>\r
595 <important>\r
596 <para>\r
597 If you have problems entering/storing data please see <xref linkend="tgit-dug-settings-hierachical"/>.\r
598 </para>\r
599 </important>\r
600 <variablelist>\r
601 <varlistentry>\r
602 <term>Language</term>\r
603 <listitem>\r
604 <para>\r
605 TortoiseGit can use spell checker modules which are also\r
606 used by OpenOffice and Mozilla. If you have those installed\r
607 this property will determine which spell checker to use, i.e.\r
608 in which language the log messages for your project should\r
609 be written.\r
610 The <literal>tgit.projectlanguage</literal> config key sets the language\r
611 module the spell checking engine should use when you enter\r
612 a log message. You can find the values for your language\r
613 on this page:\r
614 <ulink url="http://msdn2.microsoft.com/en-us/library/ms776260.aspx">\r
615 <citetitle>MSDN: Language Identifiers</citetitle>\r
616 </ulink>.\r
617 </para>\r
618 <para>\r
619 Enter this value in decimal. For example English (US) can be entered as <literal>1033</literal>.\r
620 </para>\r
621 <para>\r
622 Use <literal>-1</literal> to disable the spell checker.\r
623 </para>\r
624 </listitem>\r
625 </varlistentry>\r
626 <varlistentry>\r
627 <term>Limit</term>\r
628 <listitem>\r
629 <para>\r
630 <literal>tgit.logminsize</literal>\r
631 sets the minimum length of a log message for a commit.\r
632 If you enter a shorter message than specified here, the commit button\r
633 is disabled. This feature is very useful for reminding you to\r
634 supply a proper descriptive message for every commit.\r
635 If this property is not set,\r
636 or the value is zero, empty log messages are allowed.\r
637 </para>\r
638 </listitem>\r
639 </varlistentry>\r
640 <varlistentry>\r
641 <term>Border</term>\r
642 <listitem>\r
643 <para>\r
644 <literal>tgit.logwidthmarker</literal> is used with projects which\r
645 require log messages to be formatted with some maximum width\r
646 (typically 72 characters) before a line break. Setting this\r
647 property to a non-zero will place a marker to indicate the maximum width\r
648 and performs line wrapping. Note: this feature\r
649 will only work correctly if you have a fixed-width font\r
650 selected for log messages.\r
651 </para>\r
652 </listitem>\r
653 </varlistentry>\r
654 <varlistentry>\r
655 <term>Warn on Signed-Off-By on commit</term>\r
656 <listitem>\r
657 <para>\r
658 <literal>tgit.warnnosignedoffby</literal> is used with projects which\r
659 require Signed-off-by line in commit messages.\r
660 </para>\r
661 </listitem>\r
662 </varlistentry>\r
663 <varlistentry>\r
664 <term>Overlay Icon</term>\r
665 <listitem>\r
666 <para>\r
667 <literal>tgit.icon</literal> is used with projects which wish to show the logo \r
668 on the taskbar for easier identification when multiple TortoiseGit application instances\r
669 of different projects are running at the same time.\r
670 <graphic fileref="../images/TaskbarOverlayIcon.png"/>\r
671 If icon is not 16x16 px in size, it will be automatically scaled.\r
672 Supported formats are ico, png, jpg, gif, bmp.\r
673 If no icon is included by that project, you may find one on you own, \r
674 put it in .git folder and set the relative path in local config. e.g. <literal>.git/logo.ico</literal>\r
675 If you want to disable it, you may set <literal>tgit.icon</literal> as an empty string in local config.\r
676 It will fallback to a color block when disabled or load failed.\r
677 Note that the advanced option <literal>GroupTaskbarIconsPerRepo</literal> should be 3 or 4 in order to use this function.\r
678 </para>\r
679 </listitem>\r
680 </varlistentry>\r
681 </variablelist>\r
682 </sect3>\r
683 <sect3 id="tgit-dug-settings-colours">\r
684 <title>TortoiseGit Colour Settings</title>\r
685 <?dbhh topicname="HIDD_SETTINGSCOLORS_1"?>\r
686 <para>\r
687 <figure id="tgit-dug-settings-dia-colors">\r
688 <title>The Settings Dialog, Colours Page</title>\r
689 <graphic fileref="../images/SettingsColors.png"/>\r
690 </figure>\r
691 This dialog allows you to configure the text colours\r
692 used in TortoiseGit's dialogs the way you like them.\r
693 </para>\r
694 <variablelist>\r
695 <varlistentry>\r
696 <term>Possible or real conflict / obstructed</term>\r
697 <listitem>\r
698 <para>\r
699 A conflict has occurred during update, or may occur during merge.\r
700 Update is obstructed by an existing unversioned file/folder of\r
701 the same name as a versioned one.\r
702 </para>\r
703 <para>\r
704 This colour is also used for error messages in the progress dialogs.\r
705 </para>\r
706 </listitem>\r
707 </varlistentry>\r
708 <varlistentry>\r
709 <term>Added files</term>\r
710 <listitem>\r
711 <para>\r
712 Items added to the repository.\r
713 </para>\r
714 </listitem>\r
715 </varlistentry>\r
716 <varlistentry>\r
717 <term>Missing / deleted / replaced</term>\r
718 <listitem>\r
719 <para>\r
720 Items deleted from the repository, missing from the working\r
721 copy, or deleted from the working tree and replaced with\r
722 another file of the same name.\r
723 </para>\r
724 </listitem>\r
725 </varlistentry>\r
726 <varlistentry>\r
727 <term>Merged</term>\r
728 <listitem>\r
729 <para>\r
730 Changes from the repository successfully merged into the working tree\r
731 without creating any conflicts.\r
732 </para>\r
733 </listitem>\r
734 </varlistentry>\r
735 <varlistentry>\r
736 <term>Modified / copied</term>\r
737 <listitem>\r
738 <para>\r
739 Add with history, or paths copied in the repository.\r
740 Also used in the log dialog for entries which include\r
741 copied items.\r
742 </para>\r
743 </listitem>\r
744 </varlistentry>\r
745 <varlistentry>\r
746 <term>Note node</term>\r
747 <listitem>\r
748 <para>\r
749 A reference which points to git notes, under refs/notes namespace.\r
750 </para>\r
751 </listitem>\r
752 </varlistentry>\r
753 <varlistentry>\r
754 <term>Use local branch color for current branch</term>\r
755 <listitem>\r
756 <para>\r
757 In revision graph, use local branch color for current branch.\r
758 You may not want to emphasize current branch of a local\r
759 repository in revision graph.\r
760 </para>\r
761 </listitem>\r
762 </varlistentry>\r
763 </variablelist>\r
764 </sect3>\r
765 <sect3 id="tgit-dug-settings-colours2">\r
766 <title>TortoiseGit Colour Settings 2</title>\r
767 <?dbhh topicname="HIDD_SETTINGSCOLORS_2"?>\r
768 <para>\r
769 <figure id="tgit-dug-settings-dia-colors2">\r
770 <title>The Settings Dialog, Colours Page</title>\r
771 <graphic fileref="../images/SettingsColors2.png"/>\r
772 </figure>\r
773 This dialog allows you to configure the text colours\r
774 used in TortoiseGit's dialogs the way you like them.\r
775 </para>\r
776 </sect3>\r
777 <sect3 id="tgit-dug-settings-colours3">\r
778 <title>TortoiseGit Colour Settings 3</title>\r
779 <?dbhh topicname="HIDD_SETTINGSCOLORS_3"?>\r
780 <para>\r
781 <figure id="tgit-dug-settings-dia-colors-3">\r
782 <title>The Settings Dialog, Colours Page</title>\r
783 <graphic fileref="../images/SettingsColors3.png"/>\r
784 </figure>\r
785 This dialog allows you to configure the line colours, line width and node size\r
786 in the graph column used in TortoiseGit's log dialog the way you like them.\r
787 </para>\r
788 </sect3>\r
789 </sect2>