Kiln » TortoiseHg » TortoiseHg
Clone URL:  
Pushed to one repository · View In Graph Contained in 0.9, 0.9.1, and 0.9.1.1

doc: update documentation to new realities

Point people at the changelog tool for synchronize functions
New menu entry names
External commit tool support was removed

Changeset 991e661b4b13

Parent 8b40a32f72ed

by Steve Borho

Changes to 5 files · Browse files at 991e661b4b13 Showing diff from parent 8b40a32f72ed Diff from another changeset...

 
179
180
181
 
 
 
182
183
184
 
330
331
332
333
334
335
336
337
 
341
342
343
344
 
345
346
347
 
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
179
180
181
182
183
184
185
186
187
 
333
334
335
 
 
336
337
338
 
342
343
344
 
345
346
347
348
 
366
367
368
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
369
@@ -179,6 +179,9 @@
  but highlighted) diff hunks to the clipboard. These can be pasted   into a text buffer to generate any arbitrary patch based from the   changes in your working directory. +:kbd:`Alt-Q` + Reflow the paragraph currently under the cursor. You must configure + a message format policy for this key to work.    The code which copies the hunks to the clipboard is intelligent about  diff headers. The clipboard contents will always be a valid patch. @@ -330,8 +333,6 @@
   :menuselection:`Commit --> Username`   Sets username associated with your commits (see :doc:`quick`) -:menuselection:`Commit --> External Tool` - Allows you to select Qct as the your commit tool [DEPRECATED]  :menuselection:`Commit --> Summary Line Length`   Configures a 'policy' limit for summary lines  :menuselection:`Commit --> Message Line Length` @@ -341,7 +342,7 @@
 :menuselection:`TortoiseHg --> Max Diff Size`   Configures the diff size limit   -External tool configuration is deprecated and will be removed in 0.9 +External tool configuration has been removed in 0.9    From command line  ----------------- @@ -365,30 +366,4 @@
    hg help dates   - -Changes since 0.7 ------------------ - -* The :guilabel:`Show Diff` button has been removed. Diffs are always shown. -* The commit tool no longer shows all diffs at startup. Only the first - currently selected file is shown. -* Added support for closing a named branch -* The commit tool is now launchable from the merge dialog -* The message pane context menu now has options for inserting selected - filenames, and configuring/applying a layout format. -* :guilabel:`Ctrl-O` keyboard accelerator for triggering commit has been - replaced with :guilabel:`Ctrl-Enter` accelerator which is common to - many TortoiseHg dialogs -* Support for two-parent state (merging) has been improved, especially - the file context menus. -* There is now a limit on the size of files that will be diffed by the commit - and changelog tools. Files above this size will only show a message - indicating why the file was not diffed. This limit (default: 1MB) is - configurable (per-repository if necessary) via the settings dialog - :menuselection:`TortoiseHg --> Max Diff Size`. -* You can specify the committer and date via the command line: see - :command:`hgtk commit -h` for details -* The :file:`qct.py` extension file is no longer bundled. It must be - downloaded separately if you wish to use Qct. -  .. vim: noet ts=4
 
14
15
16
17
 
18
19
20
21
22
23
24
 
25
26
27
 
 
28
29
30
 
39
40
41
42
 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
67
68
69
 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
 
 
 
144
145
146
 
167
168
169
170
171
172
173
174
175
 
189
190
191
192
193
 
 
194
195
196
 
197
198
199
 
204
205
206
207
 
208
209
210
 
223
224
225
 
 
226
227
228
 
247
248
249
250
251
252
253
254
 
 
 
 
 
255
256
257
 
14
15
16
 
17
18
19
20
21
22
23
 
24
25
 
 
26
27
28
29
30
 
39
40
41
 
42
43
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
44
45
46
47
 
99
100
101
 
 
 
 
 
 
 
 
102
103
 
 
 
 
 
 
 
 
 
 
104
105
106
107
108
109
110
 
131
132
133
 
 
 
134
135
136
 
150
151
152
 
 
153
154
155
 
 
156
157
158
159
 
164
165
166
 
167
168
169
170
 
183
184
185
186
187
188
189
190
 
209
210
211
 
 
 
 
 
212
213
214
215
216
217
218
219
@@ -14,17 +14,17 @@
  `Mercurial <http://mercurial.selenic.com/wiki/>`_,   `kdiff3 <http://kdiff3.sourceforge.net/>`_,   `TortoisePlink <http://www.chiark.greenend.org.uk/%7Esgtatham/putty/>`_ - and one bonus extension: hgfold. + and two bonus extensions: hgfold, hgcr-gui.    *How can I get translations for the Explorer context menu?*     See the `Download <http://bitbucket.org/tortoisehg/stable/wiki/download>`_   wiki page   -*How do I do merges and arbitrary version checkouts in 0.8?* +*How do I do merges and arbitrary version checkouts?*   - Merges and updates intended to be done from within the Changelog - tool (:guilabel:`View Changelog` menu option) in 0.8. + Merges and updates are intended to be done from within the Changelog + tool (:guilabel:`Repository Explorer` menu option)    *How do I fix* ``failed to import extension hgext.hgconfig...`` *warnings?*   @@ -39,31 +39,9 @@
  this problem. See also   `ssh <http://bitbucket.org/tortoisehg/stable/wiki/ssh>`_.   -*How can I use Qct with TortoiseHg, after version 0.7?* +*How can I use Qct with TortoiseHg?*   - We recommend that you try the commit tool that comes with TortoiseHg - before running back to Qct, but here are the instructions should you - decide to stick with ole' reliable: - - 1. Download and install Qct-1.7-standalone-win32.exe from - http://qct.sourceforge.net - 2. Add (or merge) the following into your :file:`Mercurial.ini` :: - - [extensions] - qct = C:\path\to\qct.py - - [tortoisehg] - extcommit = qct - - [qct] - path = "C:\Program Files\qct\qct.exe" - - Now the :guilabel:`HG Commit` menu option should launch Qct, and - :command:`hg qct` should work from the command line and hgtk ci - should also launch Qct. - - In 0.9, hgtk ci will no longer launch Qct. We will drop support for - any external commit tools. + In 0.9, we have dropped support for external commit tools.    *How can I use hgk (hg view) with TortoiseHg?*   @@ -121,26 +99,12 @@
  available in the drop-down list for :guilabel:`Visual Diff Command`.   Select :guilabel:`adiff`, apply, then close.   -*Does TortoiseHg work on Vista?* - - TortoiseHg 0.8.n works well on x86 and x64 versions of Vista and Windows 7. - -*How can I get the context menus working on 64-bit Vista?* - - Upgrade to TortoiseHg 0.8.n -  *I'm a CLI user, how do I disable the shell extensions (overlay icons and context menus)?*   - If you have TortoiseHg 0.8 or later, you can disable overlays via - the taskbar options menu. The only way to disable the context menu - is to rename :file:`ThgShell.dll` in your install directory and then - restart explorer (this completely disables the shell extension). - - If you have an older TortoiseHg release, run this command with - appropriate permissions: - :command:`regsvr32 /u "C:\\Program Files\\TortoiseHg\\tortoisehg.dll` - Run that command without the :command:`/u` argument to re-enable the - extensions. Both operations take effect after the next reboot. + You can disable overlays via the taskbar options menu. The only way + to disable the context menu is to rename :file:`ThgShell.dll` in + your install directory and then restart explorer (this completely + disables the shell extension).    *How is TortoiseHg configured?*   @@ -167,9 +131,6 @@
  authorcolor = True   authorcolor.steve = blue   - See also :doc:`settings`, and - `issue #50 <http://bitbucket.org/tortoisehg/stable/issue/50/>`_. -  *Is it possible to change fonts?*     In some cases, yes. The gtools based dialogs (commit, status, @@ -189,11 +150,10 @@
   *How do I switch GTK themes?*   - In 0.7, the theme was selectable at install time. For other - releases, (and after install on 0.7) you can still do this manually + In 0.7, the theme was selectable at install time. For later + releases, you can still do this manually.   - * cd :file:`C:\\Program Files\\TortoiseHg\\share\\themes` - (>=0.8, this is :file:`gtk\\share\\themes`) + * cd :file:`C:\\Program Files\\TortoiseHg\\gtk\\share\\themes`   * look at the themes in this directory, remember their names or   keep this folder open.   * :command:`cd ..\\..\\etc\\gtk-2.0` @@ -204,7 +164,7 @@
  * Changes immediately take affect on all newly launched applications     You also should be able to download new themes and copy them into - the :file:`share\\themes` directory and then enable them in your + the :file:`gtk\\share\\themes` directory and then enable them in your   :file:`gtkrc`.    *After uninstalling, it left a bunch of DLL and PYD files behind.* @@ -223,6 +183,8 @@
  problems/questions about the convert extension to the Mercurial   mailing list or #mercurial on irc.freenode.net.   + Alternatively, you can use the hgsubversion extension. +  *Where do TortoiseHg extensions look for external Python modules on Windows?*     TortoiseHg includes an entire Python distribution bundled up as @@ -247,11 +209,11 @@
   *How do I fix odd characters in dialog?*   - In 0.8, we no longer distribute multiple themes and switched default - theme to MS-Windows. As a result, it might causes an issue related - default font of MS-Windows theme in some environments. In order to - fix this issue, add following setting to TortoiseHg's :file:`gtkrc` - file:: + Since 0.8, we no longer distribute multiple themes and switched + default theme to MS-Windows. As a result, it might causes an issue + related default font of MS-Windows theme in some environments. In + order to fix this issue, add following setting to TortoiseHg's + :file:`gtkrc` file::     style "msw-default"   {
 
20
21
22
23
 
24
25
26
27
28
29
30
 
31
32
33
 
46
47
48
49
50
51
52
 
53
54
55
56
57
58
59
 
 
 
60
61
62
63
64
65
66
67
68
69
 
 
 
 
70
71
72
73
74
75
76
 
 
 
 
77
78
79
 
20
21
22
 
23
24
25
26
27
28
29
 
30
31
32
33
 
46
47
48
 
 
 
 
49
50
51
 
 
 
 
 
52
53
54
55
56
57
58
59
 
 
 
 
 
60
61
62
63
64
65
66
 
 
 
 
67
68
69
70
71
72
73
@@ -20,14 +20,14 @@
  merge tool and are thus completely ready for use "Out of the Box".    On Linux, - TortoiseHg consists of a command line hgtk script, and a Nautilus + TortoiseHg consists of a command line hgtk script and a Nautilus   extension which provides overlays and context menus in your file   explorer. You must have Mercurial installed separately in order to   run TortoiseHg on Linux. TortoiseHg binary packages list Mercurial   as a dependency, so it is usually installed for you automatically.    TortoiseHg is primarily written in Python and PyGtk (the Windows shell -extension being a noticeable exception). The hgtk script and TortoiseHg +extension being the notable exception). The hgtk script and TortoiseHg  dialogs can be used on any platform that supports PyGtk, including Mac  OS X.   @@ -46,34 +46,28 @@
 .. note::   If you have an older (<0.8) version already installed, the installer   will ask that you to remove the previous version of TortoiseHg. The - uninstall can be done from the control panel or the start menu. If - no other applications are using TortoiseOverlays, it is recommended, - but not strictly required, to uninstall them when you upgrade an - earlier release. + uninstall can be done from the control panel or the start menu.    .. note:: - If you have 0.8 or later already installed, you must close all - instances of the ThgTaskBar application (:file:`thgtaskbar.exe`) before - installation can proceed. To close it, choose menu :guilabel:`Exit` from - the context menu of Mercurial notification icon on the taskbar tray. - + If you have 0.8 or later already installed, the installer will close + the ThgTaskbar application when it begins copying files. +    Language settings  ^^^^^^^^^^^^^^^^^    The TortoiseHg user interface has been translated into many languages. -You don't need to download a language pack. All the available languages -are shipped with the installer. Look in -:file:`C:\\Program Files\\TortoiseHg\\locale` for the available -languages. To enable a language just set the environment variable -``LANGUAGE`` to the desidered language, e.g. for italian +Language packs are not required since all available languages are +installed. Look in :file:`C:\\Program Files\\TortoiseHg\\locale` for the +available languages. To enable a language just set the environment +variable ``LANGUAGE`` to the desidered language, e.g. for italian  ``set LANGUAGE=it``.    .. note:: - After setting LANGUAGE, if the standard GUI elements like - :guilabel:`OK` and :guilabel:`Apply` still appear in English, it - means the TortoiseHg installer did not include a translation of GTK+ - for your locale. This means the translation of TortoiseHg for your + After setting LANGUAGE, if standard GUI elements like :guilabel:`OK` + and :guilabel:`Apply` still appear in English, it means the + TortoiseHg installer did not include translations of GTK+ for your + locale. This usually means the translation of TortoiseHg for your   locale was incomplete at release time.    The Windows shell extension context menus get their translations from
 
34
35
36
37
38
 
 
39
40
41
 
58
59
60
61
 
62
63
64
 
34
35
36
 
 
37
38
39
40
41
 
58
59
60
 
61
62
63
64
@@ -34,8 +34,8 @@
   :doc:`settings` describes how to configure TortoiseHg.   -:doc:`recovery` describes the recovery operations to do on -a project. +:doc:`recovery` describes the recovery operations one can perform on a +project.    :doc:`faq` has a list of common questions and their answers.   @@ -58,7 +58,7 @@
 * `Developers <https://lists.sourceforge.net/lists/listinfo/tortoisehg-develop>`_ - Patches, bug reports, development discussions.  * `Issues <https://lists.sourceforge.net/lists/listinfo/tortoisehg-issues>`_ - Notifications from the issue tracker.   -And our `wiki <http://bitbucket.org/tortoisehg/stable/wiki/Home>`_ on BitBucket. +And our `wiki <http://bitbucket.org/tortoisehg/stable/wiki/Home>`_ on Bitbucket.    Acknowledgement  ===============
 
14
15
16
17
18
 
 
19
20
21
 
 
22
23
24
 
57
58
59
60
 
61
62
63
 
102
103
104
105
106
107
108
109
 
 
 
 
110
111
112
 
120
121
122
123
124
125
126
127
 
 
 
 
 
128
129
130
 
133
134
135
136
137
 
 
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
 
 
 
 
 
 
 
152
153
154
 
163
164
165
166
167
168
169
 
 
 
170
171
 
 
172
173
174
 
183
184
185
186
 
 
187
188
189
 
226
227
228
229
230
 
231
232
233
234
 
 
 
235
236
237
 
238
239
240
241
242
243
244
 
245
246
247
248
 
249
250
251
 
14
15
16
 
 
17
18
19
 
 
20
21
22
23
24
 
57
58
59
 
60
61
62
63
 
102
103
104
 
 
 
 
 
105
106
107
108
109
110
111
 
119
120
121
 
 
 
 
 
122
123
124
125
126
127
128
129
 
132
133
134
 
 
135
136
137
138
139
140
141
142
 
 
 
 
 
 
 
 
143
144
145
146
147
148
149
150
151
152
153
 
162
163
164
 
 
 
 
165
166
167
168
 
169
170
171
172
173
 
182
183
184
 
185
186
187
188
189
 
226
227
228
 
 
229
230
 
 
 
231
232
233
234
235
 
236
237
238
239
240
241
242
 
243
244
245
246
 
247
248
249
250
@@ -14,11 +14,11 @@
   To get started, suppose you volunteer to create the central repository.  There are ways to `convert <http://mercurial.selenic.com/wiki/RepositoryConversion>`_ -non-Mercurial repositories into Mercurial repositories, but for this -example lets assume we're starting from scratch. +non-Mercurial repositories into Mercurial repositories, but this example +assumes you are starting from scratch.   -The rest of this tutorial assumes you already have TortoiseHg properly -installed, and you have your project folder open in your file browser. +This tutorial assumes you already have TortoiseHg properly installed, +and you have your project folder open in your file browser.      Configuring TortoiseHg @@ -57,7 +57,7 @@
  prevent SPAM.    If you are not using one of our Windows installers, you will also have -to configure a visual diff tool. Type :command:`hgtk userconfig`, on +to configure a visual diff tool. Type :command:`hgtk userconfig` and on  the TortoiseHg tab you will find :guilabel:`Visual Diff Command`. If  there are no options in the drop-down list, you must enable and  configure Mercurial's ExtDiff extension and then restart the userconfig @@ -102,11 +102,10 @@
 files must be ignored. There are a lot of way to do this:    1. To add files, select them in explorer and then right click and select - :menuselection:`TortoiseHg --> Add Files` in the context menu. In - this way the adding action happens immediately and no TortoiseHg - dialogs appear, but you will see the overlay icons change to indicate - added files. - + :menuselection:`TortoiseHg --> Add Files...` in the context menu. A + dialog will open for you to double check the selected files and + accept the add operation. +  2. Or open the status tool (:menuselection:`TortoiseHg --> View File Status`   or :command:`hgtk status` from the command line). Check the files you   want to add and then press the :guilabel:`Add` button. From the @@ -120,11 +119,11 @@
  pressing :guilabel:`Commit`.    4. To ignore files, open the ignore filter dialog: - :menuselection:`TortoiseHg --> Edit Ignore Filter` - or from command line :command:`hgtk hgignore`. Choose a file from - the list or manually type in a *Glob* or *Regular expression* - filter and then press :guilabel:`Add`. Changes to the ignore filter - take effect immediately. + :menuselection:`TortoiseHg --> Edit Ignore Filter` or from command + line :command:`hgtk hgignore`. Choose a file from the list or + manually type in a *Glob* or *Regular expression* filter and then + press :guilabel:`Add`. Changes to the ignore filter take effect + immediately.    .. note::   The :file:`.hgignore` file, contained in the working directory root, @@ -133,22 +132,22 @@
 .. note::   It is good practice to not have many *unknown* files in your working   directory, as it makes it too easy to forget to add vital new files. - So it is recommended that you keep your :file:`.hgignore` - file up to date. + It is recommended that you keep your :file:`.hgignore` file up to + date.      Commit  ======    Commit your local repository by right-clicking anywhere in the folder, -or on the folder itself, and then selecting -:guilabel:`HG Commit ...`, or from command line type :command:`hgtk commit`. -Write a commit message, select the files you wish to commit, then press -:guilabel:`Commit`. If, after the commit, you realize that something was wrong -with the message or the selected files, you can cancel the last commit -using the :guilabel:`Undo` button. Your previous commit message will be -in the message history drop-down, so you do not have to type it in again -from scratch. +or on the folder itself, and then selecting :guilabel:`HG Commit ...`, +or from command line type :command:`hgtk commit`. Write a commit +message, select the files you wish to commit, then press +:guilabel:`Commit`. If, after the commit, you realize that something was +wrong with the message or the selected files, you can cancel the last +commit using the :guilabel:`Undo` button. Your previous commit message +will be in the message history drop-down, so you do not have to type it +in again from scratch.    .. note::   You lose the ability to easily undo the last commit when you close @@ -163,12 +162,12 @@
 ====================    Now you are ready to share your work. You do this by making a copy of -your repository in a public place that everyone in your group can -access. Mercurial calls this *cloning your repository*. To clone your -repository to a common area, such as a shared drive or web site which -will be the merge point for the team. From the shared drive select +your repository in a public location that everyone in your group can +read. Mercurial calls this copy operation *cloning your repository*. To +clone your repository to a shared drive, open the clone tool  :menuselection:`TortoiseHg --> Clone a Repository`, or -:command:`hgtk clone` from command line. +:command:`hgtk clone` from command line. Then enter the destination +path.    .. figure:: figures/share.png   :alt: Clone dialog @@ -183,7 +182,8 @@
 central repository clone. It will only have the :file:`.hg` directory,  which stores the entire revision history of the project.   -Other team members can then work from this clone. +Other team members can clone from this clone with or without a checked +out working directory.      Fetching from the group repository @@ -226,26 +226,25 @@
   When you're ready to publish your changes, you   -1. Commit your changes to your local repository, if you haven't already - (see above). +1. Commit your changes to your local repository (see above).  2. Pull changes from the group repository into your repository, - :menuselection:`TortoiseHg --> Synchronize` or - :command:`hgtk synch`, choose the path to the group repository - and then :guilabel:`Pull`. + :menuselection:`TortoiseHg --> Repository Browser` or + :command:`hgtk log`, choose the path to the group repository + in the syncbar and then :guilabel:`Pull`.  3. If some changesets were pulled, merge those changes with your local   changes and then commit the merge into your local repository. From - the changelog viewer (:menuselection:`TortoiseHg --> View Changelog` + the changelog viewer (:menuselection:`TortoiseHg --> Repository Browser`   or :command:`hgtk log`) open the context menu over the changeset   which you want to merge and select :guilabel:`merge with`.   Finally, in the merge dialog, press :guilabel:`Merge` and then   :guilabel:`Commit`.  4. Ensure your merged work still builds and passes your extensive test suite.  5. Push your changes to the group repository, - :menuselection:`TortoiseHg --> Synchronize` or :command:`hgtk synch`, + :menuselection:`TortoiseHg --> Repository Browser` or :command:`hgtk log`,   choose the path to group repository and then :guilabel:`Push`.    Which may sound complicated, but most of the time it is just pushing the -buttons in the synchronize tool. +buttons in the commit and changelog tools.    .. note::   Merges can be safely restarted if necessary.