1
Why set up an email address with Bazaar-NG?
2
===========================================
3
Bazaar-NG stores the claimed email address in revisions when they're
5
The various ways that exist to tell Bazaar your email address for
8
Why set up an email address with Bazaar?
9
========================================
10
Bazaar stores the claimed email address in revisions when they're
4
11
created, so that people can tell who commited which revisions. Of course,
5
12
people can change the email address claimed, so you have to trust the
6
13
people involved. Additionally, the email address in a revision gives
10
17
How to setup your email address
11
18
===============================
12
Bazaar-NG will try to guess an email address based on your username and the
19
Bazaar will try to guess an email address based on your username and the
13
20
hostname if none is set. This will probably not be what you want, so three
14
ways exist to tell Bazaar-NG what email to use
21
ways exist to tell Bazaar what email to use
16
23
* You can set your email in the default ini file,
17
24
* You can set emails per-branch in the branch specific ini file,
20
27
The order of precedence is
22
29
1. If the `$BZREMAIL` env variable is set, use it.
23
2. If an email is set for your current branch in the `branches.conf` ini file.
30
2. If an email is set for your current branch in the `locations.conf` ini
24
32
3. If an email is set in the `bazaar.conf` default ini file.
25
33
4. If the `$EMAIL` env variable is set.
26
5. Bazaar-NG will try to guess based on your username and the hostname.
34
5. Bazaar will try to guess based on your username and the hostname.
28
To check on what Bazaar-NG thinks your current email is, use the '''whoami'''
36
To check on what Bazaar thinks your current email is, use the '''whoami'''
29
37
("who am i?") command::
32
40
Joe Cool <joe@example.com>
42
Setting email via the 'whoami' command
43
======================================
44
You can use the whoami command to set your email globally::
46
% bzr whoami 'Joe Cool <joe@example.com>'
48
or only for the current branch::
50
% bzr whoami --branch 'Joe Cool <joe@example.com>'
52
These modify your global bazaar.conf or branch branch.conf file, respectively.
34
54
Setting email via default ini file
35
55
==================================
36
The first method is using the default ini file. To use the default ini
37
method, create the file `$HOME/.bazaar/bazaar.conf` (on Windows this is
38
`%APPDATA%\bazaar\2.0\bazaar.conf`) and set an email address as shown
39
below. Please note that the word DEFAULT is case sensitive, and must be in
56
To use the default ini file, create the file `$HOME/.bazaar/bazaar.conf` (on
57
Windows this is `%APPDATA%\bazaar\2.0\bazaar.conf`) and set an email address
58
as shown below. Please note that the word DEFAULT is case sensitive, and
59
must be in upper-case.::
43
62
email=Your Name <name@isp.com>
49
68
===================================
51
70
The second approach is to set email on a branch by branch basis by using the
52
`$HOME/.bazaar/branches.conf` ini file, thusly::
71
`$HOME/.bazaar/locations.conf` ini file, thusly::
54
73
[/some/branch/location]
55
74
email=Your Name <name@other-isp.com>
60
79
Setting email via environment
61
80
-----------------------------
62
The final method Bazaar-NG will use is checking for the `$BZREMAIL` and
81
The final method Bazaar will use is checking for the `$BZREMAIL` and
63
82
`$EMAIL` environment variables. Generally, one would use this method to
64
83
override the email in a script context. If you would like to set a general
65
84
default, then please see the ini methods above.
70
89
Some people want to avoid sharing their email address so as not to get
71
spam. Bazaar-NG will never disclose your email address, unless you publish
90
spam. Bazaar will never disclose your email address, unless you publish
72
91
a branch or changeset in a public location. It's recommended that you
73
92
''do'' use a real address, so that people can contact you about your work,
74
93
but it's not required. You can use an address which is obfuscated, which
added
removed
doc/setting_up_email.txt
