Kiln » TortoiseHg » TortoiseHg
Clone URL:  
/ doc/ source
settings.txt
1
2
3
4
5
6
7
8
9
10
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
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
=================== TortoiseHg Settings =================== .. module:: settings.dialog :synopsis: Dialog used to set preferences This page describes the 0.7 version of settings The Settings dialog is used to configure both TortoiseHg and the underlying Mercurial DVCS. Since TortoiseHg uses Mercurial's underlying configuration system to store and retrieve its settings, these are essentially the same thing. Mercurial on Windows has a three-tier configuration system. 1) A site-wide configuration file in :file:`C:\Program Files\TortoiseHg\Mercurial.ini` This file is read first and thus has the lowest priority. 2) A per-user configuration file in :file:`C:\Documents and Settings\username\Mercurial.ini` This file is read second and thus can override settings in the site-wide configuration file. 3) A per-repository configuration file in :file:`repo-root\.hg\hgrc` This file is read last and can override site-wide and user global settings. The site-wide file can be overwritten on upgrades so it is recommended that you do not make changes to this file. Instead, you should make changes to your user :file:`Mercurial.ini` and/or the repository :file:`hgrc` file. The TortoiseHg Settings dialog enforces this suggestion by only operating in two modes: Global edits your user :file:`Mercurial.ini` file Repository edits a repository :file:`.hg/hgrc` file Most TortoiseHg users will want to store all configurables in their global user settings, and only use the repository hgrc to store paths (remote repository aliases) and web settings, though it is possible to override many configurables per-repository (a common example is to configure a different username for use in a repository). Also note that the user and repository configuration files may not exist until you run the Settings dialog for the first time. The Settings tool is a tabbed application. .. figure:: figures/settings.png :alt: Settings dialog Settings dialog Each tab corresponds roughly to a section of your :file:`Mercurial.ini` file, though there is a certain amount of overlap. Some sections were split across multiple tabs for clarity. Every tab except of the :guilabel:`Paths` tab has the same format, a list of configurable options with a drop-down combo box with possible values and a history of options you have used for that setting. The configurable name (label) has a tooltip which describes in more detail what you are configuring and its default value. The :guilabel:`Paths` tab is where you can store URLs (paths) to related repositories. It is rare to store paths in the site-wide or user configuration files, most of the time you will only store these in a repository configuration file. Mercurial has two special path names that can be used as default targets for some operations. default the default URL to pull from, usually clone source default-push the default push target when using the command line Please consult the Mercurial wiki for more detailed information about these configurables (except for the first three tabs: :guilabel:`TortoiseHg`, :guilabel:`Commit`, :guilabel:`Changelog`, which are specifically for TortoiseHg).