← 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: John Arbash Meinel
  • Date: 2007-04-12 21:33:07 UTC
  • mfrom: (2413.4.1 api-doc-builders)
  • mto: This revision was merged to the branch mainline in revision 2566.
  • Revision ID: john@arbash-meinel.com-20070412213307-kuh07cnzaud12wx1
[merge] api-doc-builder and remove the pydoctor build code for now.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/setting_up_email.txt
1
 
Configuring email
2
 
=================
 
1
================
 
2
Setting up email
 
3
================
3
4
 
4
 
.. Description of the various ways to specify to Bazaar your email address for commits.
 
5
Description of the various ways to specify to Bazaar your email address for
 
6
commits.
5
7
 
6
8
Why set up an email address with Bazaar?
7
 
----------------------------------------
8
 
 
 
9
========================================
9
10
Bazaar stores the specified email address in revisions when they're
10
 
created so that people can tell who committed which revisions.  The
 
11
created so that people can tell who commited which revisions.  The
11
12
email addresses are not verified, therefore they could be bogus, so
12
13
you have to trust the people involved in your project.  Additionally,
13
14
the email address in a revision gives others a way to contact the
14
15
author of a revision for credit and/or blame.  :)
15
16
 
16
 
How to set up your email address
17
 
--------------------------------
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:
30
30
 
31
31
The order of precedence is
32
32
 
33
 
 1. If the ``BZR_EMAIL`` environment variable is set.
 
33
 1. If the ``$BZR_EMAIL`` environment variable is set.
34
34
 #. If an email is set for your current branch in the ``locations.conf``
35
35
    file.
36
36
 #. If an email is set four your current branch in the
37
37
    ``.bzr/branch/branch.conf`` file.
38
38
 #. If an email is set in the ``bazaar.conf`` default configuration file.
39
 
 #. If the `EMAIL` environment variable is set.
 
39
 #. If the `$EMAIL` environment variable is set.
40
40
 #. Bazaar will try to guess based on your username and the hostname.
41
41
 
42
42
To check on what Bazaar thinks your current email is, use the ``whoami``
44
44
 
45
45
    % bzr whoami
46
46
    Joe Cool <joe@example.com>
47
 
 
 
47
    
48
48
Setting email via the 'whoami' command
49
 
--------------------------------------
50
 
 
 
49
======================================
51
50
You can use the whoami command to set your email globally::
52
51
 
53
 
    % bzr whoami "Joe Cool <joe@example.com>"
 
52
    % bzr whoami 'Joe Cool <joe@example.com>'
54
53
 
55
54
or only for the current branch::
56
55
 
57
 
    % bzr whoami --branch "Joe Cool <joe@example.com>"
 
56
    % bzr whoami --branch 'Joe Cool <joe@example.com>'
58
57
 
59
58
These modify your global ``bazaar.conf`` or branch ``branch.conf`` file, respectively.
60
59
 
61
60
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 Linux 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.
 
61
============================================
 
62
To use the default ini file, create the file ``$HOME/.bazaar/bazaar.conf`` (on
 
63
Windows this is ``%APPDATA%\bazaar\2.0\bazaar.conf``) and set an email address
 
64
as shown below.  Please note that the word DEFAULT is case sensitive, and
 
65
must be in upper-case.
68
66
::
69
67
 
70
68
    [DEFAULT]
71
69
    email=Your Name <name@isp.com>
72
70
 
73
71
 
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
 
72
For more information on the ini file format, see ConfiguringBzr.
78
73
 
79
74
Setting email on a per-branch basis
80
 
-----------------------------------
 
75
===================================
81
76
 
82
77
The second approach is to set email on a branch by branch basis by
83
 
using the ``locations.conf`` configuration file like this::
 
78
using the ``$HOME/.bazaar/locations.conf`` configuration file,
 
79
thusly::
84
80
 
85
81
    [/some/branch/location]
86
82
    email=Your Name <name@other-isp.com>
90
86
 
91
87
Setting email via environment variable
92
88
--------------------------------------
93
 
The final method Bazaar will use is checking for the ``BZR_EMAIL``
94
 
and ``EMAIL`` environment variables.  Generally, you would use this
 
89
The final method Bazaar will use is checking for the ``$BZR_EMAIL``
 
90
and ``$EMAIL`` environment variables.  Generally, you would use this
95
91
method to override the email in a script context.  If you would like
96
92
to set a general default, then please see the ini methods above.
97
93
 
98
94
Concerns about spam
99
 
-------------------
 
95
===================
100
96
Some people want to avoid sharing their email address so as not to get
101
97
spam.  Bazaar will never disclose your email address, unless you publish
102
98
a branch or changeset in a public location.  It's recommended that you