doc/source/en/TortoiseGit/tsvn_dug/dug_settings_registry.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE sect2 SYSTEM "../../../dtd/dblite.dtd">\r
   3 <sect2 id="tsvn-dug-settings-registry">\r
   4         <title>Registry Settings</title>\r
   5         <indexterm>\r
   6                 <primary>registry</primary>\r
   7         </indexterm>\r
   8         <para>\r
   9                 A few infrequently used settings are available only by editing\r
  10                 the registry directly. It goes without saying that you should\r
  11                 only edit registry values if you know what you are doing.\r
  12         </para>\r
  13         <variablelist>\r
  14                 <varlistentry>\r
  15                         <term>Configuration</term>\r
  16                         <listitem>\r
  17                                 <para>\r
  18                                         You can specify a different location for the Git\r
  19                                         configuration file using registry location\r
  20                                         <literal>HKCU\Software\TortoiseGit\ConfigDir</literal>.\r
  21                                         This will affect all TortoiseGit operations.\r
  22                                 </para>\r
  23                         </listitem>\r
  24                 </varlistentry>\r
  25                 <varlistentry>\r
  26                         <term>Cache tray icon</term>\r
  27                         <listitem>\r
  28                                 <para>\r
  29                                         To add a cache tray icon for the TSVNCache program,\r
  30                                         create a <literal>DWORD</literal> key with a value of 1 at\r
  31                                         <literal>HKCU\Software\TortoiseGit\CacheTrayIcon</literal>.\r
  32                                         This is really only useful for developers as it allows\r
  33                                         you to terminate the program gracefully.\r
  34                                 </para>\r
  35                         </listitem>\r
  36                 </varlistentry>\r
  37                 <varlistentry>\r
  38                         <term>Debug</term>\r
  39                         <listitem>\r
  40                                 <para>\r
  41                                         To show the command line parameters passed from the shell\r
  42                                         extension to TortoiseProc.exe\r
  43                                         create a <literal>DWORD</literal> key with a value of 1 at\r
  44                                         <literal>HKCU\Software\TortoiseGit\Debug</literal>.\r
  45                                 </para>\r
  46                         </listitem>\r
  47                 </varlistentry>\r
  48                 <varlistentry>\r
  49                         <term>Owner-Drawn Menus</term>\r
  50                         <listitem>\r
  51                                 <para>\r
  52                                         This can be useful if you use something other than the windows explorer\r
  53                                         or if you get problems with the context menu displaying correctly.\r
  54                                         create a <literal>DWORD</literal> key with a value of 0 at\r
  55                                         <literal>HKCU\Software\TortoiseGit\OwnerdrawnMenus</literal>\r
  56                                         if you don't want TortoiseGit to use owner-draw menu items in the shell\r
  57                                         context menu. Set this value to 2 if you don't want TortoiseGit to use\r
  58                                         icons in the context menu at all.\r
  59                                 </para>\r
  60                         </listitem>\r
  61                 </varlistentry>\r
  62                 <varlistentry>\r
  63                         <term>Block Overlay Status</term>\r
  64                         <listitem>\r
  65                                 <para>\r
  66                                         If you don't want the explorer to update the status overlays while another\r
  67                                         TortoiseGit command is running (e.g. Update, Commit, ...) then\r
  68                                         create a <literal>DWORD</literal> key with a value of 1 at\r
  69                                         <literal>HKCU\Software\TortoiseGit\BlockStatus</literal>.\r
  70                                 </para>\r
  71                         </listitem>\r
  72                 </varlistentry>\r
  73                 <varlistentry>\r
  74                         <term>Update Check URL</term>\r
  75                         <listitem>\r
  76                                 <para>\r
  77                                         <literal>HKCU\Software\TortoiseGit\UpdateCheckURL</literal>\r
  78                                         contains the URL from which TortoiseGit tries to download a text file\r
  79                                         to find out if there are updates available. You can also set this under\r
  80                                         <literal>HKLM</literal> instead of <literal>HKCU</literal> if you want,\r
  81                                         but <literal>HKCU</literal> overwrites the setting in <literal>HKLM</literal>.\r
  82                                         This might be useful for company admins who don't want their users to\r
  83                                         update TortoiseGit until they approve it.\r
  84                                 </para>\r
  85                         </listitem>\r
  86                 </varlistentry>\r
  87                 <varlistentry>\r
  88                         <term>Filenames without extensions in auto-completion list</term>\r
  89                         <listitem>\r
  90                                 <para>\r
  91                                         The auto-completion list shown in the commit message editor\r
  92                                         displays the names of files listed for commit.\r
  93                                         To also include these names with extensions removed,\r
  94                                         create a <literal>DWORD</literal> key with a value of 1 at\r
  95                                         <literal>HKCU\Software\TortoiseGit\AutocompleteRemovesExtensions</literal>.\r
  96                                 </para>\r
  97                         </listitem>\r
  98                 </varlistentry>\r
  99                 <varlistentry>\r
 100                         <term>Explorer columns everywhere</term>\r
 101                         <listitem>\r
 102                                 <para>\r
 103                                         The extra columns the TortoiseGit adds to the details view\r
 104                                         in Windows Explorer are normally only active in a working\r
 105                                         copy. If you want those to be accessible everywhere, not\r
 106                                         just in working copies, create a <literal>DWORD</literal>\r
 107                                         key with a value of 1 at\r
 108                                         <literal>HKCU\Software\TortoiseGit\ColumnsEveryWhere</literal>.\r
 109                                 </para>\r
 110                         </listitem>\r
 111                 </varlistentry>\r
 112                 <varlistentry>\r
 113                         <term>Merge log separator</term>\r
 114                         <listitem>\r
 115                                 <para>\r
 116                                         When you merge revisions from another branch, and merge tracking\r
 117                                         information is available, the log messages from the revisions\r
 118                                         you merge will be collected to make up a commit log message.\r
 119                                         A pre-defined string is used to separate the individual log\r
 120                                         messages of the merged revisions. If you prefer, you can create\r
 121                                         a <literal>SZ</literal> key at\r
 122                                         <literal>HKCU\Software\TortoiseGit\MergeLogSeparator</literal>\r
 123                                         containing a separator string of your choice.\r
 124                                 </para>\r
 125                         </listitem>\r
 126                 </varlistentry>\r
 127                 <varlistentry>\r
 128                         <term>Always blame changes with TortoiseMerge</term>\r
 129                         <listitem>\r
 130                                 <para>\r
 131                                         TortoiseGit allows you to assign external diff viewer.\r
 132                                         Most such viewers, however, are not suited for change blaming\r
 133                                         (<xref linkend="tsvn-dug-blame-diffs"/>),\r
 134                                         so you might wish to fall back to TortoiseMerge in this case.\r
 135                                         To do so, create a <literal>DWORD</literal>     key with a value of 1 at\r
 136                                         <literal>HKCU\Software\TortoiseGit\DiffBlamesWithTortoiseMerge</literal>.\r
 137                                 </para>\r
 138                         </listitem>\r
 139                 </varlistentry>\r
 140                 <varlistentry>\r
 141                         <term>Current revision highlighting for folders in log dialog</term>\r
 142                         <listitem>\r
 143                                 <para>\r
 144                                         The log dialog highlights the current working copy revision\r
 145                                         when the log is shown for a file. To do the same thing for a\r
 146                                         folder requires a working copy crawl, which can be a slow\r
 147                                         operation for large working copies.\r
 148                                         If you want to enable this feature you must create a\r
 149                                         <literal>DWORD</literal> registry key at\r
 150                                         <literal>HKCU\Software\TortoiseGit\RecursiveLogRev</literal>.\r
 151                                         A value of 0 disables the feature (no highlighting for folders),\r
 152                                         a value of 1 (default) will fetch the status recursively (find the\r
 153                                         highest revision in the working copy tree), and a value of 2 will\r
 154                                         check the revision of the selected folder itself, but will\r
 155                                         not check any child items.\r
 156                                 </para>\r
 157                         </listitem>\r
 158                 </varlistentry>\r
 159                 <varlistentry>\r
 160                         <term>Make checkout fail if an item of the same name exists</term>\r
 161                         <listitem>\r
 162                                 <para>\r
 163                                         By default, if you checkout a working copy over an existing\r
 164                                         unversioned folder structure, as you might do after import,\r
 165                                         then any existing which differ from the repository content\r
 166                                         will be left unchanged and marked as modified. When you come\r
 167                                         to commit, it is your local copy which will then be sent back\r
 168                                         to the repository. Some people would prefer the checkout to\r
 169                                         fail if the existing content differs, so that if two people\r
 170                                         add the same file the second person's version does not\r
 171                                         overwrite the original version by mistake.\r
 172                                         If you want to force checkouts to fail in this instance you must\r
 173                                         create a <literal>DWORD</literal> registry key with value 0 at\r
 174                                         <literal>HKCU\Software\TortoiseGit\AllowUnversionedObstruction</literal>.\r
 175                                 </para>\r
 176                         </listitem>\r
 177                 </varlistentry>\r
 178         </variablelist>\r
 179 </sect2>\r