← 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: Ian Clatworthy
  • Date: 2007-11-14 03:50:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/setting_up_email.txt
1
 
================
2
1
Setting up email
3
2
================
4
3
 
5
 
Description of the various ways to specify to Bazaar your email address for
6
 
commits.
 
4
.. Description of the various ways to specify to Bazaar your email address for commits.
7
5
 
8
6
Why set up an email address with Bazaar?
9
 
========================================
 
7
----------------------------------------
 
8
 
10
9
Bazaar stores the specified email address in revisions when they're
11
10
created so that people can tell who commited which revisions.  The
12
11
email addresses are not verified, therefore they could be bogus, so
15
14
author of a revision for credit and/or blame.  :)
16
15
 
17
16
How to set up your email address 
18
 
================================
 
17
--------------------------------
 
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:
46
46
    Joe Cool <joe@example.com>
47
47
    
48
48
Setting email via the 'whoami' command
49
 
======================================
 
49
--------------------------------------
 
50
 
50
51
You can use the whoami command to set your email globally::
51
52
 
52
53
    % bzr whoami 'Joe Cool <joe@example.com>'
58
59
These modify your global ``bazaar.conf`` or branch ``branch.conf`` file, respectively.
59
60
 
60
61
Setting email via default configuration file
61
 
============================================
 
62
--------------------------------------------
 
63
 
62
64
To use the default ini file, create the file ``$HOME/.bazaar/bazaar.conf`` (on
63
65
Windows this is ``%APPDATA%\bazaar\2.0\bazaar.conf``) and set an email address
64
66
as shown below.  Please note that the word DEFAULT is case sensitive, and
72
74
For more information on the ini file format, see ConfiguringBzr.
73
75
 
74
76
Setting email on a per-branch basis
75
 
===================================
 
77
-----------------------------------
76
78
 
77
79
The second approach is to set email on a branch by branch basis by
78
80
using the ``$HOME/.bazaar/locations.conf`` configuration file,
92
94
to set a general default, then please see the ini methods above.
93
95
 
94
96
Concerns about spam
95
 
===================
 
97
-------------------
96
98
Some people want to avoid sharing their email address so as not to get
97
99
spam.  Bazaar will never disclose your email address, unless you publish
98
100
a branch or changeset in a public location.  It's recommended that you