/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to doc/setting_up_email.txt

  • Committer: Jan Balster
  • Date: 2006-08-15 12:39:42 UTC
  • mfrom: (1923 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1928.
  • Revision ID: jan@merlinux.de-20060815123942-22c388c6e9a8ac91
merge bzr.dev 1923

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
33
40
    Joe Cool <joe@example.com>
 
41
    
 
42
Setting email via the 'whoami' command
 
43
======================================
 
44
You can use the whoami command to set your email globally::
 
45
 
 
46
    % bzr whoami 'Joe Cool <joe@example.com>'
 
47
 
 
48
or only for the current branch::
 
49
 
 
50
    % bzr whoami --branch 'Joe Cool <joe@example.com>'
 
51
 
 
52
These modify your global bazaar.conf or branch branch.conf file, respectively.
34
53
 
35
54
Setting email via default ini file
36
55
==================================
37
 
The first method is using the default ini file.  To use the default ini
38
 
method, create the file `$HOME/.bazaar/bazaar.conf` (on Windows this is
39
 
`%APPDATA%\bazaar\2.0\bazaar.conf`) and set an email address as shown
40
 
below.  Please note that the word DEFAULT is case sensitive, and must be in
41
 
upper-case.::
 
56
To use the default ini file, create the file `$HOME/.bazaar/bazaar.conf` (on
 
57
Windows this is `%APPDATA%\bazaar\2.0\bazaar.conf`) and set an email address
 
58
as shown below.  Please note that the word DEFAULT is case sensitive, and
 
59
must be in upper-case.::
42
60
 
43
61
    [DEFAULT]
44
62
    email=Your Name <name@isp.com>
60
78
 
61
79
Setting email via environment
62
80
-----------------------------
63
 
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
64
82
`$EMAIL` environment variables.  Generally, one would use this method to
65
83
override the email in a script context.  If you would like to set a general
66
84
default, then please see the ini methods above.
69
87
Concerns for spam
70
88
=================
71
89
Some people want to avoid sharing their email address so as not to get
72
 
spam.  Bazaar-NG will never disclose your email address, unless you publish
 
90
spam.  Bazaar will never disclose your email address, unless you publish
73
91
a branch or changeset in a public location.  It's recommended that you
74
92
''do'' use a real address, so that people can contact you about your work,
75
93
but it's not required.  You can use an address which is obfuscated, which