← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/configuration.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-11 13:47:06 UTC
  • mfrom: (5051.3.16 use-branch-open)
  • Revision ID: pqm@pqm.ubuntu.com-20100311134706-kaerqhx3lf7xn6rh
(Jelmer) Pass colocated branch names further down the call stack.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
1
1
Configuration Settings
2
2
=======================
3
3
 
4
 
.. TODO: Should have some explanation of why you'd want things in
5
 
.. branch.conf.
6
 
 
7
 
 
8
4
Environment settings
9
5
---------------------
10
6
 
67
63
~~~~~~~~~~~~~~~
68
64
 
69
65
The path to the plugins directory that Bazaar should use.
 
66
If not set, Bazaar will search for plugins in:
 
67
 
 
68
* the user specific plugin directory (containing the ``user`` plugins),
 
69
 
 
70
* the bzrlib directory (containing the ``core`` plugins),
 
71
 
 
72
* the site specific plugin directory if applicable (containing
 
73
  the ``site`` plugins).
 
74
 
 
75
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
 
76
the way the plugin are searched. 
 
77
 
 
78
As for the ``PATH`` variables, if multiple directories are
 
79
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
 
80
platform specific appropriate character (':' on Unix/Linux/etc,
 
81
';' on windows)
 
82
 
 
83
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
 
84
in ``user``.  However it will continue to search in ``core`` and
 
85
``site`` unless they are explicitly removed.
 
86
 
 
87
If you need to change the order or remove one of these
 
88
directories, you should use special values:
 
89
 
 
90
* ``-user``, ``-core``, ``-site`` will remove the corresponding
 
91
  path from the default values,
 
92
 
 
93
* ``+user``, ``+core``, ``+site`` will add the corresponding path
 
94
  before the remaining default values (and also remove it from
 
95
  the default values).
 
96
 
 
97
Note that the special values 'user', 'core' and 'site' should be
 
98
used literally, they will be substituted by the corresponding,
 
99
platform specific, values.
 
100
 
 
101
Examples:
 
102
^^^^^^^^^
 
103
 
 
104
The examples below uses ':' as the separator, windows users
 
105
should use ';'.
 
106
 
 
107
Overriding the default user plugin directory:
 
108
``BZR_PLUGIN_PATH='/path/to/my/other/plugins'``
 
109
 
 
110
Disabling the site directory while retaining the user directory:
 
111
``BZR_PLUGIN_PATH='-site:+user'``
 
112
 
 
113
Disabling all plugins (better achieved with --no-plugins):
 
114
``BZR_PLUGIN_PATH='-user:-core:-site'``
 
115
 
 
116
Overriding the default site plugin directory:
 
117
``BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user``
 
118
 
 
119
 
70
120
 
71
121
BZRPATH
72
122
~~~~~~~
178
228
The main configuration file, bazaar.conf
179
229
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180
230
 
181
 
``bazaar.conf`` only allows one
182
 
section called ``[DEFAULT]``. This default section contains the default
 
231
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
 
232
The default section contains the default
183
233
configuration options for all branches. The default section can be
184
234
overriden by providing a branch-specific section in ``locations.conf``.
185
235
 
222
272
variable policies which don't apply.
223
273
 
224
274
For more information on the possible uses of the authentication configuration
225
 
file see `Authentication Settings`_.
 
275
file see :doc:`authentication-help`.
226
276
 
227
277
 
228
278
Common variable options
229
279
-----------------------
230
280
 
 
281
debug_flags
 
282
~~~~~~~~~~~
 
283
 
 
284
A comma-separated list of debugging options to turn on.  The same values
 
285
can be used as with the -D command-line option (see `help global-options`).
 
286
For example::
 
287
 
 
288
    debug_flags = hpss
 
289
 
231
290
email
232
291
~~~~~
233
292
 
244
303
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
245
304
variables.
246
305
 
 
306
log_format
 
307
~~~~~~~~~~
 
308
 
 
309
The default log format to use. Standard log formats are ``long``, ``short``
 
310
and ``line``. Additional formats may be provided by plugins. The default
 
311
value is ``long``.
 
312
 
247
313
check_signatures
248
314
~~~~~~~~~~~~~~~~
249
315
 
333
399
 
334
400
Supported values for specific clients:
335
401
 
 
402
:claws: Use Claws.  This skips a dialog for attaching files.
336
403
:evolution: Use Evolution.
337
404
:kmail: Use KMail.
338
405
:mutt: Use Mutt.
361
428
A publically-accessible version of this branch (implying that this version is
362
429
not publically-accessible).  Used (and set) by ``bzr send``.
363
430
 
 
431
suppress_warnings
 
432
~~~~~~~~~~~~~~~~~
 
433
 
 
434
A list of strings, each string represent a warning that can be emitted by
 
435
bzr. Mentioning a warning in this list tells bzr to not emit it.
 
436
 
 
437
Valid values:
 
438
 
 
439
* ``format_deprecation``:
 
440
    whether the format deprecation warning is shown on repositories that are
 
441
    using deprecated formats.
 
442
 
364
443
 
365
444
Branch type specific options
366
445
----------------------------
391
470
If present, the location of the default branch for push.  This option
392
471
is normally set by ``push --remember``.
393
472
 
 
473
push_strict
 
474
~~~~~~~~~~~
 
475
 
 
476
If present, defines the ``--strict`` option default value for checking
 
477
uncommitted changes before pushing.
 
478
 
 
479
dpush_strict
 
480
~~~~~~~~~~~~
 
481
 
 
482
If present, defines the ``--strict`` option default value for checking
 
483
uncommitted changes before pushing into a different VCS without any
 
484
custom bzr metadata.
 
485
 
394
486
bound_location
395
487
~~~~~~~~~~~~~~
396
488
 
402
494
 
403
495
If set to "True", the branch should act as a checkout, and push each commit to
404
496
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
497
 
 
498
send_strict
 
499
~~~~~~~~~~~
 
500
 
 
501
If present, defines the ``--strict`` option default value for checking
 
502
uncommitted changes before sending a merge directive.
 
503