← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Aaron Bentley
  • Date: 2008-10-16 21:37:21 UTC
  • mfrom: (0.12.63 shelf-manager)
  • mto: This revision was merged to the branch mainline in revision 3823.
  • Revision ID: aaron@aaronbentley.com-20081016213721-4evccj16q9mb05uf
Merge with shelf-manager

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/setting_up_email.txt
 
1
Configuring email
 
2
=================
 
3
 
 
4
.. Description of the various ways to specify to Bazaar your email address for commits.
 
5
 
 
6
Why set up an email address with Bazaar?
 
7
----------------------------------------
 
8
 
 
9
Bazaar stores the specified email address in revisions when they're
 
10
created so that people can tell who commited which revisions.  The
 
11
email addresses are not verified, therefore they could be bogus, so
 
12
you have to trust the people involved in your project.  Additionally,
 
13
the email address in a revision gives others a way to contact the
 
14
author of a revision for credit and/or blame.  :)
 
15
 
 
16
How to set up your email address 
 
17
--------------------------------
 
18
 
 
19
Bazaar will try to guess an email address based on your username and the
 
20
hostname if none is set.  This will probably not be what you want, so three
 
21
ways exist to tell Bazaar what email to use:
 
22
 
 
23
You can set your email in one of several configuration files.  Like
 
24
other configuration values, you can set it in ``bazaar.conf`` as a
 
25
general setting.  If you want to override the value for a particular
 
26
branch, or set of branches, you can use ``locations.conf``.
 
27
``.bzr/branch/branch.conf`` will also work, but will cause all commits
 
28
to that branch to use the same email address, even if someone else
 
29
does them.
 
30
 
 
31
The order of precedence is
 
32
 
 
33
 1. If the ``BZR_EMAIL`` environment variable is set.
 
34
 #. If an email is set for your current branch in the ``locations.conf``
 
35
    file.
 
36
 #. If an email is set four your current branch in the
 
37
    ``.bzr/branch/branch.conf`` file.
 
38
 #. If an email is set in the ``bazaar.conf`` default configuration file.
 
39
 #. If the `EMAIL` environment variable is set.
 
40
 #. Bazaar will try to guess based on your username and the hostname.
 
41
 
 
42
To check on what Bazaar thinks your current email is, use the ``whoami``
 
43
("who am i?") command::
 
44
 
 
45
    % bzr whoami
 
46
    Joe Cool <joe@example.com>
 
47
    
 
48
Setting email via the 'whoami' command
 
49
--------------------------------------
 
50
 
 
51
You can use the whoami command to set your email globally::
 
52
 
 
53
    % bzr whoami "Joe Cool <joe@example.com>"
 
54
 
 
55
or only for the current branch::
 
56
 
 
57
    % bzr whoami --branch "Joe Cool <joe@example.com>"
 
58
 
 
59
These modify your global ``bazaar.conf`` or branch ``branch.conf`` file, respectively.
 
60
 
 
61
Setting email via default configuration file
 
62
--------------------------------------------
 
63
 
 
64
To use the default ini file, create or edit the ``bazaar.conf`` file (in
 
65
``~/.bazaar/`` on Linix and in ``%APPDATA%\bazaar\2.0\`` in Windows)
 
66
and set an email address as shown below.  Please note that the word DEFAULT
 
67
is case sensitive, and must be in upper-case.
 
68
::
 
69
 
 
70
    [DEFAULT]
 
71
    email=Your Name <name@isp.com>
 
72
 
 
73
 
 
74
For more information on the ini file format, see `Configuration Settings`_ in
 
75
the Bazaar User Reference.
 
76
 
 
77
.. _Configuration Settings: ../user-reference/bzr_man.html#configuration-settings
 
78
 
 
79
Setting email on a per-branch basis
 
80
-----------------------------------
 
81
 
 
82
The second approach is to set email on a branch by branch basis by
 
83
using the ``locations.conf`` configuration file like this::
 
84
 
 
85
    [/some/branch/location]
 
86
    email=Your Name <name@other-isp.com>
 
87
 
 
88
This will set your email address in the branch at ``/some/branch/location``,
 
89
overriding the default specified in the ``bazaar.conf`` above.
 
90
 
 
91
Setting email via environment variable
 
92
--------------------------------------
 
93
The final method Bazaar will use is checking for the ``BZR_EMAIL``
 
94
and ``EMAIL`` environment variables.  Generally, you would use this
 
95
method to override the email in a script context.  If you would like
 
96
to set a general default, then please see the ini methods above.
 
97
 
 
98
Concerns about spam
 
99
-------------------
 
100
Some people want to avoid sharing their email address so as not to get
 
101
spam.  Bazaar will never disclose your email address, unless you publish
 
102
a branch or changeset in a public location.  It's recommended that you
 
103
*do* use a real address, so that people can contact you about your work,
 
104
but it's not required.  You can use an address which is obfuscated, which
 
105
bounces, or which goes through an anti-spam service such as
 
106
`spamgourmet.com`.