/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

Viewing changes to doc/en/user-guide/configuring_bazaar.txt

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
Configuring Bazaar
 
1
Configuring Breezy
2
2
==================
3
3
 
4
 
Telling Bazaar about yourself
 
4
Telling Breezy about yourself
5
5
-----------------------------
6
6
 
7
7
One function of a version control system is to keep track of who changed
8
8
what.  In a decentralized system, that requires an identifier for each
9
9
author that is globally unique.  Most people already have one of these: an
10
 
email address. Bazaar is smart enough to automatically generate an email
 
10
email address. Breezy is smart enough to automatically generate an email
11
11
address by looking up your username and hostname. If you don't like the
12
 
guess that Bazaar makes, then use the ``whoami`` command to set the
 
12
guess that Breezy makes, then use the ``whoami`` command to set the
13
13
identifier you want::
14
14
 
15
 
    % bzr whoami "Your Name <email@example.com>"
 
15
    % brz whoami "Your Name <email@example.com>"
16
16
 
17
17
If ``whoami`` is used without an argument, the current value is displayed.
18
18
 
41
41
-------------------------
42
42
 
43
43
As shown in the example above, there are various ways to
44
 
configure Bazaar, they all share some common properties though.
 
44
configure Breezy, they all share some common properties though.
45
45
An option has:
46
46
 
47
47
- a name which is generally a valid python identifier,
48
48
 
49
 
- a value which is a string. In some cases, Bazaar will be able
 
49
- a value which is a string. In some cases, Breezy will be able
50
50
  to recognize special values like 'True', 'False' to infer a
51
51
  boolean type, but basically, as a user, you will always specify
52
52
  a value as a string.
60
60
-------------------
61
61
 
62
62
Configuration files are located in ``$HOME/.bazaar`` on Unix and
63
 
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
 
63
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0`` on
64
64
Windows. There are three primary configuration files in this location:
65
65
 
66
66
* ``bazaar.conf`` describes default configuration options,
72
72
  remote servers.
73
73
 
74
74
Each branch can also contain a configuration file that sets values specific
75
 
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the
 
75
to that branch. This file is found at ``.brz/branch/branch.conf`` within the
76
76
branch. This file is visible to **all users of a branch**. If you wish to
77
77
override one of the values for a branch with a setting that is specific to you,
78
78
then you can do so in ``locations.conf``.
85
85
 
86
86
For further details on the syntax and configuration settings supported, see
87
87
`Configuration Settings <../user-reference/index.html#configuration-settings>`_
88
 
in the Bazaar User Reference.
 
88
in the Breezy User Reference.
89
89
 
90
90
 
91
91
Looking at the active configuration
94
94
To look at all the currently defined options, you can use the following
95
95
command::
96
96
 
97
 
  bzr config
 
97
  brz config
98
98
 
99
 
``bzr`` implements some rules to decide where to get the value of a
 
99
``brz`` implements some rules to decide where to get the value of a
100
100
configuration option.
101
101
 
102
102
The current policy is to examine the existing configurations files in a
110
110
  * ``bazaar.conf`` is searched next,
111
111
 
112
112
  * finally, some options can have default values generally defined in the
113
 
    code itself and not displayed by ``bzr config`` (see `Configuration
 
113
    code itself and not displayed by ``brz config`` (see `Configuration
114
114
    Settings <../user-reference/index.html#configuration-settings>`_).
115
115
 
116
 
This is better understood by using ```bzr config`` with no arguments, which
 
116
This is better understood by using ```brz config`` with no arguments, which
117
117
will display some output of the form::
118
118
 
119
119
  locations:
120
120
    post_commit_to = commits@example.com
121
121
    news_merge_files = NEWS
122
122
  branch:
123
 
    parent_location = bzr+ssh://bazaar.launchpad.net/+branch/bzr/
 
123
    parent_location = bzr+ssh://bazaar.launchpad.net/+branch/brz/
124
124
    nickname = config-modify
125
 
    push_location = bzr+ssh://bazaar.launchpad.net/~vila/bzr/config-modify/
 
125
    push_location = bzr+ssh://bazaar.launchpad.net/~vila/brz/config-modify/
126
126
  bazaar:
127
127
    debug_flags = hpss,
128
128
 
131
131
 
132
132
If you need to look at a specific option, you can use::
133
133
 
134
 
  bzr config <option>
 
134
  brz config <option>
135
135
 
136
136
This will display only the option value and is intended to be used in
137
137
scripts.
141
141
 
142
142
To set an option to a given value use::
143
143
 
144
 
  bzr config opt=value
 
144
  brz config opt=value
145
145
 
146
146
An option value can reference another option by enclosing it in curly
147
147
braces::
148
148
 
149
 
  bzr config opt={other_opt}/subdir
 
149
  brz config opt={other_opt}/subdir
150
150
 
151
 
If ``other_opt`` is set to ``'root``, ``bzr config opt`` will display::
 
151
If ``other_opt`` is set to ``'root``, ``brz config opt`` will display::
152
152
 
153
153
  root/subdir
154
154
 
155
155
Note that when ``--all`` is used, the references are left as-is to better
156
156
reflect the content of the config files and make it easier to organize them::
157
157
 
158
 
  bzr config --all .*opt
 
158
  brz config --all .*opt
159
159
 
160
160
  bazaar:
161
161
    [DEFAULT]
168
168
 
169
169
To remove an option use::
170
170
 
171
 
  bzr config --remove opt
 
171
  brz config --remove opt
172
172
 
173
173
 
174
174
Rule-based preferences
180
180
 
181
181
For further information on how rules are searched and the detailed syntax of
182
182
the relevant files, see `Rules <../user-reference/index.html#rules>`_
183
 
in the Bazaar User Reference.
 
183
in the Breezy User Reference.
184
184
 
185
185
 
186
186
Escaping command lines