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

stable doc: improve readability, add content. Part 1

Changeset 7a0ebe7e757c…

Parent 3b95b30faec0…

by Steve Borho

Changes to 6 files · Browse files at 7a0ebe7e757c Showing diff from parent 3b95b30faec0 Diff from another changeset...

Change 1 of 1 Show Entire File doc/​source/​commit.txt Stacked
 
1
2
 
 
3
4
5
 
 
 
1
2
3
4
5
@@ -1,5 +1,5 @@
-TortoiseHg Commit Tool -====================== +Commit +======    .. module:: commit.dialog   :synopsis: Dialog used to perform commit
Change 1 of 3 Show Entire File doc/​source/​common.txt Stacked
 
17
18
19
20
21
 
 
22
23
24
 
50
51
52
53
 
54
55
56
57
58
59
60
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61
62
63
 
84
85
86
87
88
89
 
90
91
92
93
 
 
94
95
96
 
 
 
97
98
 
17
18
19
 
 
20
21
22
23
24
 
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
115
116
117
 
 
 
118
119
 
 
 
120
121
122
 
 
123
124
125
126
127
@@ -17,8 +17,8 @@
 If the state to be restored does not fit within your current screen  dimensions, the application will revert to factory default dimensions.   -The TortoiseHg dialogs which are more transitory in nature allow the -window manager to place them where it wishes. +Dialogs which have fixed geometry or are transitory allow the window +manager to place them where it wishes.    Keyboard Accelerators  --------------------- @@ -50,14 +50,45 @@
   0.8 introduced a visual diff dialog that solves four usability issues:   -1) The ability to select visual diff tools for individual files +1) Allows you to select a visual diff tool for each individual file  2) Allows you to use visual diff tools that fork background processes  3) Allows you to use visual diff tools that do not support directory diffs  4) Provides feedback when no files were modified   -If you prefer the previous (<=0.7) behavior of directly launching your -visual diff tool, you can recover that behavior via the user settings -dialog and :menuselection:`TortoiseHg --> Skip Diff Window`. +Providing visual diffs requires TortoiseHg to generate temporary files +which contain older versions of data. Those temporary files are deleted +when the visual diff dialog is closed. + +If you would like to bypass this visual diff window and directly launch +your visual diff tool open the global settings dialog and set +:menuselection:`TortoiseHg --> Skip Diff Window` to true. + +.. note:: + The `Skip Diff Window` configurable does not change the behavior of + visual diffs launched by the shell context menu. The visual diff + window is always shown. + +.. warning:: + When you bypass the visual diff window, your visual diff tool must + be able to handle directory diffs and it must not fork a background + process. Caveat emptor. + +Configuring a visual diff application for use in TortoiseHg is a two +step process. First you must configure your application as an +`Extdiff <http://mercurial.selenic.com/wiki/ExtdiffExtension>`_ +command in your user :file:`Mercurial.ini`:: + + [extdiff] + myapp = C:\Path\to\tool.exe + +Then you can select `myapp` from the list of available extdiff +commands in :menuselection:`TortoiseHg --> Visual Diff Command`. +See the :doc:`faq` for some configuration examples. + +When more than one `Extdiff` command is configured, the visual diff +window will allow you to select the command to use as you open each +file. +    Treeview searches  ----------------- @@ -84,15 +115,13 @@
 -----------------    Many TortoiseHg tools use the *hgcmd* dialog to execute Mercurial -commands that could potentially be interactive. In release 0.8, the -dialog was changed to draw all error messages in a dark red color to -give them more contrast from normal output messages. +commands that could potentially be interactive.   -The dialog focuses its :guilabel:`Close` button when the command has -completed, so a simple :kbd:`Enter` is all that is required to close -the window. +.. note:: + Error messages are given a dark red color for contrast   -*hgcmd* also responds appropriately to the global :kbd:`Ctrl-W` and -:kbd:`Ctrl-Q` keyboard accelerators. +When the Mercurial command has completed, the dialog gives focus to its +:guilabel:`Close` button. So pressing :kbd:`Enter` is all that is +required to close the window.    .. vim: noet ts=4
Change 1 of 2 Show Entire File doc/​source/​explorer.txt Stacked
 
11
12
13
14
15
 
 
16
17
18
19
20
21
 
22
23
24
25
26
27
 
 
 
 
 
 
 
 
 
 
 
 
28
29
30
 
33
34
35
36
37
38
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
70
71
 
 
 
 
72
73
74
75
76
77
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
78
79
 
11
12
13
 
 
14
15
16
17
18
19
20
 
21
22
 
 
 
 
 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
@@ -11,20 +11,27 @@
 icons in the MS-Explorer windows. This is similar to those that found on  other Tortoise client, such as TortoiseCVS and TortoiseSVN.   -Beginning from TortoiseHg version 0.5, the overlay icons are shared with -TortoiseSVN (version 1.5.x or later) via the support of TortoiseOverlays +TortoiseHg shares the overlay icons with TortoiseSVN (version 1.5.x or +later) and the other "Tortoise" projects via the use of TortoiseOverlays  (another project created by TortoiseSVN team).    .. figure:: figures/overlayicons.png   :alt: Overlay icons   - Overlay icons in Icons view (this image shows release 0.7 overlays) + Overlay icons in Icons view (XP)   -In release 0.8, we added an :guilabel:`Update Icons` context menu option -which forces TortoiseHg to refresh the icons in the currently browsed -repository or directory of repositories. The taskbar icon will turn -green and the directory icons will turn into question marks while this -refresh is in progress. +The context menu has an :guilabel:`Update Icons` option which forces +TortoiseHg to refresh the icons in the currently browsed repository or +directory of repositories. The taskbar icon will turn green and the +directory icons will turn into question marks while this refresh is in +progress. + +The new C++ shell extension is an order of magnitude faster than the +Python extension used in previous releases, but we still make the +overlays configurable via the taskbar menu. Simply click on the +Mercurial (droplet) icon in the system tray and select +:guilabel:`Options`. In the options dialog you can disable overlays +globally, or enable them for local disks only.    Release 0.8.1 introduced the ability to selectively disable overlay  icons in specific repositories. This can be done be editing the @@ -33,47 +40,45 @@
    @@noicons   -Performance Issues ------------------- - -When the repository being viewed contains a large number of folders or -files, the overlay icons may appear case a perceivable delay in -displaying/refreshing the windows explorer. In most cases, the delay is -more prominent when the first time the repositories are viewed. -Subsequently the caching of the file system usually helps to reduce the -delay rather significantly. - -The delay may also be felt on repositories located on network drives or -other slower media. - -In 0.8, the new C++ shell extension is an order of magnitude faster than -the Python extension used in previous releases, but we still make the -overlays configurable via the taskbar menu. Simply click on the -Mercurial (droplet) icon in the system tray and select :guilabel:`Options`. -In the options dialog you can disable overlays globally, or enable them for -local disks only. -  Context Menus  -------------    The TortoiseHg commands (GUI window & dialogs) may be accessed via the  context menu of Explorer windows. The TortoiseHg context menu is -context sensitive, which varies according to the folder being viewed. +context sensitive and which varies according to the current folder and +file selection.    .. figure:: figures/contextmenu.png   :alt: Context menu     Context menu for a folder under Mercurial revision control (version 0.7)   -Currently TortoiseHg provides only the most regularly used Mercurial -commands, hence the less frequently used, or newly add, Mercurial -commands may still need be accessed on the CLI (command line interface) -through the :file:`cmd.exe` windows. +TortoiseHg provides dialogs for the most regularly used Mercurial +commands. Less frequently used, and newly added, Mercurial commands +must need be accessed on the CLI (command line interface) through the +:file:`cmd.exe` windows.   -In 0.8, the new C++ shell extension makes the context menu somewhat -configurable via the taskbar menu. Simply click on the Mercurial -(droplet) icon in the system tray and select :guilabel:`Options`. -In the options dialog you can promote individual menu options to -the top menu. +The context menus are configurable via the taskbar menu. Simply click on +the Mercurial (droplet) icon in the system tray and select +:guilabel:`Options`. In the options dialog you can promote individual +menu options to the top menu. + +Nautilus +-------- + +TortoiseHg also provides shell integration with the GNOME desktop via a +nautilus-python plugin. If you have installed TortoiseHg from a +distribution package, the odds are that this extension is already +configured. If not, please consult our Wiki for instructions on how to +enable this feature. + +While the nautilus extension does not have it's own GUI for managing the +overlays and context menus, it does support command promotion into the +top menu. It requires you to edit your :file:`~/.hgrc` file and add +lines like these:: + + [tortoisehg] + promoteditems = commit, log, synch +    .. vim: noet ts=4
Change 1 of 4 Show Entire File doc/​source/​intro.txt Stacked
 
1
2
3
 
 
 
4
5
6
 
42
43
44
45
46
47
48
49
 
 
 
 
 
 
50
51
52
53
 
54
55
56
 
61
62
63
64
 
 
65
66
67
68
69
70
71
 
 
 
 
 
72
73
74
 
88
89
90
91
 
92
93
94
 
 
 
 
1
2
3
4
5
6
 
42
43
44
 
 
 
 
 
45
46
47
48
49
50
51
52
53
 
54
55
56
57
 
62
63
64
 
65
66
67
68
 
 
 
 
 
69
70
71
72
73
74
75
76
 
90
91
92
 
93
94
95
96
@@ -1,6 +1,6 @@
-*********************** -TortoiseHg Introduction -*********************** +************ +Introduction +************    .. module:: introduction   :synopsis: Introduce TortoiseHg and its various parts @@ -42,15 +42,16 @@
 After installation a reboot is necessary.    .. note:: - If you have an older (less than 0.8) version already installed, the - installer will ask that you to remove the previous version of - TortoiseHg, which must be removed from control panel. Removing - TortoiseOverlays is also recommended, if no other apps are using - them, but not strictly required. + 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.     If you have 0.8 or later already installed, you must close all   instances of the ThgTaskBar application before installation can - procede. + proceed.      Language settings @@ -61,14 +62,15 @@
 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 -``LANG`` to the desidered language, e.g. for italian ``SET LANG=it``. +``LANGUAGE`` to the desidered language, e.g. for italian +``set LANGUAGE=it``.    .. note:: - After setting LANG, if the standard GUI elements like :guilabel:`OK`, - :guilabel:`Apply` etc. still appear in English, it means that the - TortoiseHg installer did not include the translation component of GTK+ - for your locale. This was probably due to an incomplete translation - of TortoiseHg at the moment of release it. + 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 + locale was incomplete at release time.    The Windows shell extension context menus get their translations from  the Windows registry. Translations for many locales are available from @@ -88,7 +90,7 @@
 `that <https://launchpad.net/~tortoisehg-ppa>`_ location.    For MacOSX, no packages are available but you can run hgtk and all the -dialogs via the source install method. +dialogs via the source install method. For details, see  `MacOSX <http://bitbucket.org/tortoisehg/stable/wiki/MacOSX>`_.    Language settings
Change 1 of 3 Show Entire File doc/​source/​preface.txt Stacked
 
10
11
12
13
14
 
 
15
16
17
 
24
25
26
27
 
28
29
30
 
31
32
 
 
 
 
 
33
34
35
 
46
47
48
 
49
50
51
 
10
11
12
 
 
13
14
15
16
17
 
24
25
26
 
27
28
29
 
30
31
 
32
33
34
35
36
37
38
39
 
50
51
52
53
54
55
56
@@ -10,8 +10,8 @@
   This book is written for computer literate folk who want to use  Mercurial to manage their data, but are uncomfortable using the command -line client to do so. Since TortoiseHg is a windows shell extension it's -assumed that the user is familiar with the windows explorer and knows +line client to do so. Since TortoiseHg is a Windows shell extension it's +assumed that the user is familiar with the Windows explorer and knows  how to use it.    You can find the most up to date version of this documentation at our @@ -24,12 +24,16 @@
 community of people who work on it, and the licensing conditions for  using it and distributing it.   -The :doc:`intro`, explains what TortoiseHg is, what it does, where it +The :doc:`intro` explains what TortoiseHg is, what it does, where it  comes from and the basics for installing it on your PC.   -The :doc:`quick`, is a quick tutorial on how to start with TortoiseHg. +:doc:`quick` is a quick tutorial on how to start with TortoiseHg.   -The remaining chapters describe the tools that are part of TortoiseHg. +:doc:`faq` has a list of common questions and their answers. + +:doc:`debugging` describes how to debug any problems that you find. + +The remaining chapters describe the components that make up TortoiseHg.    TortoiseHg is free!  =================== @@ -46,6 +50,7 @@
   * `Users <https://lists.sourceforge.net/lists/listinfo/tortoisehg-discuss>`_  * `Developers <https://lists.sourceforge.net/lists/listinfo/tortoisehg-develop>`_ +* `Issues <https://lists.sourceforge.net/lists/listinfo/tortoisehg-issues>`_    And our `wiki <http://bitbucket.org/tortoisehg/stable/wiki/Home>`_ on BitBucket.  
Change 1 of 1 Show Entire File doc/​source/​quick.txt Stacked
 
5
6
7
8
 
9
10
 
 
 
 
11
12
13
 
5
6
7
 
8
9
 
10
11
12
13
14
15
16
@@ -5,9 +5,12 @@
 .. module:: tour   :synopsis: A Gentle Introduction to Using TortoiseHg on Windows   -One of the great things about Mercurial is that there are lots of different +Mercurial supports many different  `collaboration models <http://hgbook.red-bean.com/read/collaborating-with-other-people.html>`_. -The following describes just one of those models: a single central repository. +This chapter describes just one of those models: a single central repository. +The central repository model does not scale as well as other models, but +it is the most familiar to those coming from other revision tools and +thus is the most common approach people start with.    To get started, suppose you volunteer to create the central repository.  There are ways to `convert <http://mercurial.selenic.com/wiki/RepositoryConversion>`_