← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/setting_up_email.txt

[merge] bialix: add a win32 installer

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
 
1
================
 
2
Setting up email
 
3
================
 
4
 
 
5
The various ways that exist to tell Bazaar your email address for
 
6
commits.
 
7
 
 
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
9
16
 
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
15
22
 
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,
24
31
    file.
25
32
 3. If an email is set in the `bazaar.conf` default ini file.
26
33
 4. If the `$EMAIL` env variable is set.
27
 
 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
35
 
29
 
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'''
30
37
("who am i?") command::
31
38
 
32
39
    % bzr whoami
71
78
 
72
79
Setting email via environment
73
80
-----------------------------
74
 
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
75
82
`$EMAIL` environment variables.  Generally, one would use this method to
76
83
override the email in a script context.  If you would like to set a general
77
84
default, then please see the ini methods above.
80
87
Concerns for spam
81
88
=================
82
89
Some people want to avoid sharing their email address so as not to get
83
 
spam.  Bazaar-NG will never disclose your email address, unless you publish
 
90
spam.  Bazaar will never disclose your email address, unless you publish
84
91
a branch or changeset in a public location.  It's recommended that you
85
92
''do'' use a real address, so that people can contact you about your work,
86
93
but it's not required.  You can use an address which is obfuscated, which