/breezy/unstable

To get this branch, use:
bzr branch https://code.breezy-vcs.org/breezy/unstable

« back to all changes in this revision

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

  • Committer: Jelmer Vernooij
  • Date: 2017-05-24 01:39:33 UTC
  • mfrom: (3815.3776.6)
  • Revision ID: jelmer@jelmer.uk-20170524013933-ir4y4tqtrsiz2ka2
New upstream snapshot.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
Configuring email
2
2
=================
3
3
 
4
 
.. Description of the various ways to specify to Bazaar your email address for commits.
 
4
.. Description of the various ways to specify to Breezy your email address for commits.
5
5
 
6
 
Why set up an email address with Bazaar?
 
6
Why set up an email address with Breezy?
7
7
----------------------------------------
8
8
 
9
 
Bazaar stores the specified email address in revisions when they're
 
9
Breezy stores the specified email address in revisions when they're
10
10
created so that people can tell who committed which revisions.  The
11
11
email addresses are not verified, therefore they could be bogus, so
12
12
you have to trust the people involved in your project.  Additionally,
16
16
How to set up your email address
17
17
--------------------------------
18
18
 
19
 
Bazaar will try to guess an email address based on your username and the
 
19
Breezy 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
 
ways exist to tell Bazaar what email to use:
 
21
ways exist to tell Breezy what email to use:
22
22
 
23
23
You can set your email in one of several configuration files.  Like
24
24
other configuration values, you can set it in ``bazaar.conf`` as a
25
25
general setting.  If you want to override the value for a particular
26
26
branch, or set of branches, you can use ``locations.conf``.
27
 
``.bzr/branch/branch.conf`` will also work, but will cause all commits
 
27
``.brz/branch/branch.conf`` will also work, but will cause all commits
28
28
to that branch to use the same email address, even if someone else
29
29
does them.
30
30
 
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
 
    ``.bzr/branch/branch.conf`` file.
 
37
    ``.brz/branch/branch.conf`` file.
38
38
 #. If an email is set in the ``bazaar.conf`` default configuration file.
39
39
 #. If the `EMAIL` environment variable is set.
40
 
 #. Bazaar will try to guess based on your username and the hostname.
 
40
 #. Breezy will try to guess based on your username and the hostname.
41
41
 
42
 
To check on what Bazaar thinks your current email is, use the ``whoami``
 
42
To check on what Breezy thinks your current email is, use the ``whoami``
43
43
("who am i?") command::
44
44
 
45
 
    % bzr whoami
 
45
    % brz whoami
46
46
    Joe Cool <joe@example.com>
47
47
 
48
48
Setting email via the 'whoami' command
50
50
 
51
51
You can use the whoami command to set your email globally::
52
52
 
53
 
    % bzr whoami "Joe Cool <joe@example.com>"
 
53
    % brz whoami "Joe Cool <joe@example.com>"
54
54
 
55
55
or only for the current branch::
56
56
 
57
 
    % bzr whoami --branch "Joe Cool <joe@example.com>"
 
57
    % brz whoami --branch "Joe Cool <joe@example.com>"
58
58
 
59
59
These modify your global ``bazaar.conf`` or branch ``branch.conf`` file, respectively.
60
60
 
72
72
 
73
73
 
74
74
For more information on the ini file format, see `Configuration Settings`_ in
75
 
the Bazaar User Reference.
 
75
the Breezy User Reference.
76
76
 
77
77
.. _Configuration Settings: ../user-reference/index.html#configuration-settings
78
78
 
90
90
 
91
91
Setting email via environment variable
92
92
--------------------------------------
93
 
The final method Bazaar will use is checking for the ``BZR_EMAIL``
 
93
The final method Breezy will use is checking for the ``BZR_EMAIL``
94
94
and ``EMAIL`` environment variables.  Generally, you would use this
95
95
method to override the email in a script context.  If you would like
96
96
to set a general default, then please see the ini methods above.
98
98
Concerns about spam
99
99
-------------------
100
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
 
101
spam.  Breezy will never disclose your email address, unless you publish
102
102
a branch or changeset in a public location.  It's recommended that you
103
103
*do* use a real address, so that people can contact you about your work,
104
104
but it's not required.  You can use an address which is obfuscated, which