~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Robert Collins
  • Date: 2005-10-15 00:32:03 UTC
  • mto: This revision was merged to the branch mainline in revision 1456.
  • Revision ID: robertc@lifelesslap.robertcollins.net-20051015003203-38a52da69f847663
add some documentation on options

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
17
 
18
 
"""Configuration that affects the behaviour of Bazaar."""
 
18
"""Configuration that affects the behaviour of Bazaar.
 
19
 
 
20
Currently this configuration resides in ~/.bazaar/bazaar.conf
 
21
and ~/.bazaar/branches.conf, which is written to by bzr.
 
22
 
 
23
In bazaar.config the following options may be set:
 
24
[DEFAULT]
 
25
editor=name-of-program
 
26
email=Your Name <your@email.address>
 
27
check_signatures=require|ignore|check-available(default)
 
28
create_signatures=always|never|when-required(default)
 
29
 
 
30
in branches.conf, you specify the url of a branch and options for it.
 
31
Wildcards may be used - * and ? as normal in shell completion. Options
 
32
set in both bazaar.conf and branches.conf are overriden by the branches.conf
 
33
setting.
 
34
[/home/robertc/source]
 
35
recurse=False|True(default)
 
36
email= as above
 
37
check_signatures= as abive 
 
38
create_signatures= as above.
 
39
 
 
40
explanation of options
 
41
----------------------
 
42
editor - this option sets the pop up editor to use during commits.
 
43
email - this option sets the user id bzr will use when committing.
 
44
check_signatures - this option controls whether bzr will require good gpg
 
45
                   signatures, ignore them, or check them if they are 
 
46
                   present.
 
47
create_signatures - this option controls whether bzr will always create 
 
48
                    gpg signatures, never create them, or create them if the
 
49
                    branch is configured to require them.
 
50
"""
19
51
 
20
52
from ConfigParser import ConfigParser
21
53
import os