← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/setting_up_email.txt

Factor out another win32 special case and add platform independent tests for it.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/setting_up_email.txt
 
1
Why set up an email address with Bazaar-NG?
 
2
===========================================
 
3
Bazaar-NG stores the claimed email address in revisions when they're
 
4
created, so that people can tell who commited which revisions.  Of course,
 
5
people can change the email address claimed, so you have to trust the
 
6
people involved.  Additionally, the email address in a revision gives
 
7
others a way to contact the author of a revision for credit and/or blame.
 
8
:)
 
9
 
 
10
How to setup your email address 
 
11
===============================
 
12
Bazaar-NG will try to guess an email address based on your username and the
 
13
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
 
15
 
 
16
 * You can set your email in the default ini file,
 
17
 * You can set emails per-branch in the branch specific ini file,
 
18
 * Or your email can be set by an environmental variable.
 
19
 
 
20
The order of precedence is
 
21
 
 
22
 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.
 
24
 3. If an email is set in the `bazaar.conf` default ini file.
 
25
 4. If the `$EMAIL` env variable is set.
 
26
 5. Bazaar-NG will try to guess based on your username and the hostname.
 
27
 
 
28
To check on what Bazaar-NG thinks your current email is, use the '''whoami'''
 
29
("who am i?") command::
 
30
 
 
31
    % bzr whoami
 
32
    Joe Cool <joe@example.com>
 
33
 
 
34
Setting email via default ini file
 
35
==================================
 
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
 
40
upper-case.::
 
41
 
 
42
    [DEFAULT]
 
43
    email=Your Name <name@isp.com>
 
44
 
 
45
 
 
46
For more information on the ini file format, see ConfiguringBzr.
 
47
 
 
48
Setting email on a per-branch basis
 
49
===================================
 
50
 
 
51
The second approach is to set email on a branch by branch basis by using the
 
52
`$HOME/.bazaar/branches.conf` ini file, thusly::
 
53
 
 
54
    [/some/branch/location]
 
55
    email=Your Name <name@other-isp.com>
 
56
 
 
57
This will set your email address in the branch at `/some/branch/location`,
 
58
overriding the default specified in the `bazaar.conf` above.
 
59
 
 
60
Setting email via environment
 
61
-----------------------------
 
62
The final method Bazaar-NG will use is checking for the `$BZREMAIL` and
 
63
`$EMAIL` environment variables.  Generally, one would use this method to
 
64
override the email in a script context.  If you would like to set a general
 
65
default, then please see the ini methods above.
 
66
 
 
67
 
 
68
Concerns for spam
 
69
=================
 
70
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
 
72
a branch or changeset in a public location.  It's recommended that you
 
73
''do'' use a real address, so that people can contact you about your work,
 
74
but it's not required.  You can use an address which is obfuscated, which
 
75
bounces, or which goes through an anti-spam service such as
 
76
`spamgourmet.com`.