2977.1.13
by Ian Clatworthy
more cleanups and creation of tutorials directory |
1 |
Configuring Bazaar |
2 |
================== |
|
3 |
||
4 |
Telling Bazaar about yourself |
|
5 |
----------------------------- |
|
6 |
||
7 |
One function of a version control system is to keep track of who changed |
|
8 |
what. In a decentralized system, that requires an identifier for each |
|
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 |
|
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 |
|
13 |
identifier you want:: |
|
14 |
||
15 |
% bzr whoami "Your Name <email@example.com>" |
|
16 |
||
17 |
If ``whoami`` is used without an argument, the current value is displayed. |
|
18 |
||
19 |
Configuration files |
|
20 |
------------------- |
|
21 |
||
22 |
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and |
|
23 |
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on |
|
24 |
Windows. There are three primary configuration files in this location: |
|
25 |
||
26 |
* ``bazaar.conf`` describes default configuration options, |
|
27 |
||
28 |
* ``locations.conf`` describes configuration information for |
|
29 |
specific branch locations, |
|
30 |
||
31 |
* ``authentication.conf`` describes credential information for |
|
32 |
remote servers. |
|
33 |
||
34 |
Each branch can also contain a configuration file that sets values specific |
|
35 |
to that branch. This file is found at ``.bzr/branch/branch.conf`` within the |
|
3418.5.1
by Vincent Ladeuil
Fix #183705 by updating the authentication docs regarding ssh agents. |
36 |
branch. This file is visible to **all users of a branch**. If you wish to |
37 |
override one of the values for a branch with a setting that is specific to you, |
|
38 |
then you can do so in ``locations.conf``. |
|
2977.1.13
by Ian Clatworthy
more cleanups and creation of tutorials directory |
39 |
|
40 |
Here is sample content of ``bazaar.conf`` after setting an email address using |
|
41 |
the ``whoami`` command:: |
|
42 |
||
43 |
[DEFAULT] |
|
44 |
email = Your Name <email@example.com> |
|
45 |
||
46 |
For further details on the syntax and configuration settings supported, see |
|
3089.3.1
by Ian Clatworthy
move reference material out of User Guide into User Reference |
47 |
`Configuration Settings <../user-reference/bzr_man.html#configuration-settings>`_ |
48 |
in the Bazaar User Reference. |
|
3398.1.21
by Ian Clatworthy
add 'Rule-based references' section to the User Guide |
49 |
|
50 |
||
51 |
Rule-based preferences |
|
52 |
---------------------- |
|
53 |
||
54 |
Some commands and plugins provide custom processing on files matching |
|
3606.2.5
by Robert Collins
Cherry pick Robert's 'disable .bzrrules in-tree' patch |
55 |
certain patterns. Per-user rule-based preferences are defined in |
56 |
``BZR_HOME/rules``. |
|
3398.1.21
by Ian Clatworthy
add 'Rule-based references' section to the User Guide |
57 |
|
58 |
For further information on how rules are searched and the detailed syntax of |
|
59 |
the relevant files, see `Rules <../user-reference/bzr_man.html#rules>`_ |
|
60 |
in the Bazaar User Reference. |