← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/setting_up_email.txt

  • Committer: Brad Crittenden
  • Date: 2007-03-02 12:40:45 UTC
  • mto: This revision was merged to the branch mainline in revision 2311.
  • Revision ID: bac@canonical.com-20070302124045-3a9o45va231z0w0a
post review changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/setting_up_email.txt
14
14
the email address in a revision gives others a way to contact the
15
15
author of a revision for credit and/or blame.  :)
16
16
 
17
 
How to setup your email address 
18
 
===============================
 
17
How to set up your email address 
 
18
================================
19
19
Bazaar will try to guess an email address based on your username and the
20
20
hostname if none is set.  This will probably not be what you want, so three
21
21
ways exist to tell Bazaar what email to use:
22
22
 
23
 
 * You can set your email in the default configuration file,
24
 
 * You can set emails per-branch in the branch specific ini file,
25
 
 * Or your email can be set by an environmental variable.
 
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.
26
30
 
27
31
The order of precedence is
28
32
 
58
62
To use the default ini file, create the file ``$HOME/.bazaar/bazaar.conf`` (on
59
63
Windows this is ``%APPDATA%\bazaar\2.0\bazaar.conf``) and set an email address
60
64
as shown below.  Please note that the word DEFAULT is case sensitive, and
61
 
must be in upper-case. ::
 
65
must be in upper-case.
 
66
::
62
67
 
63
68
    [DEFAULT]
64
69
    email=Your Name <name@isp.com>
69
74
Setting email on a per-branch basis
70
75
===================================
71
76
 
72
 
The second approach is to set email on a branch by branch basis by using the
73
 
``$HOME/.bazaar/locations.conf`` ini file, thusly::
 
77
The second approach is to set email on a branch by branch basis by
 
78
using the ``$HOME/.bazaar/locations.conf`` configuration file,
 
79
thusly::
74
80
 
75
81
    [/some/branch/location]
76
82
    email=Your Name <name@other-isp.com>
80
86
 
81
87
Setting email via environment variable
82
88
--------------------------------------
83
 
The final method Bazaar will use is checking for the ``$BZR_EMAIL`` and
84
 
``$EMAIL`` environment variables.  Generally, one would use this method to
85
 
override the email in a script context.  If you would like to set a general
86
 
default, then please see the ini methods above.
 
89
The final method Bazaar will use is checking for the ``$BZR_EMAIL``
 
90
and ``$EMAIL`` environment variables.  Generally, you would use this
 
91
method to override the email in a script context.  If you would like
 
92
to set a general default, then please see the ini methods above.
87
93
 
88
 
Concerns for spam
89
 
=================
 
94
Concerns about spam
 
95
==============--===
90
96
Some people want to avoid sharing their email address so as not to get
91
97
spam.  Bazaar will never disclose your email address, unless you publish
92
98
a branch or changeset in a public location.  It's recommended that you