/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 bzrlib/help_topics/en/configuration.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-04-09 23:35:55 UTC
  • mfrom: (3316.2.15 api-cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20080409233555-n26cmi0y1hb98tf6
(robertc) Many VersionedFile api cleanups and deprecations. Some
        incompatible changes included (see NEWS). (Robert Collins)

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
 
4
8
Environment settings
5
9
---------------------
6
10
 
63
67
~~~~~~~~~~~~~~~
64
68
 
65
69
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
 
The examples below use ':' as the separator, windows users
102
 
should use ';'.
103
 
 
104
 
Overriding the default user plugin directory::
105
 
 
106
 
  BZR_PLUGIN_PATH='/path/to/my/other/plugins'
107
 
 
108
 
Disabling the site directory while retaining the user directory::
109
 
 
110
 
  BZR_PLUGIN_PATH='-site:+user'
111
 
 
112
 
Disabling all plugins (better achieved with --no-plugins)::
113
 
 
114
 
  BZR_PLUGIN_PATH='-user:-core:-site'
115
 
 
116
 
Overriding the default site plugin directory::
117
 
 
118
 
  BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
119
 
 
120
 
BZR_DISABLE_PLUGINS
121
 
~~~~~~~~~~~~~~~~~~~
122
 
 
123
 
Under special circumstances (mostly when trying to diagnose a
124
 
bug), it's better to disable a plugin (or several) rather than
125
 
uninstalling them completely. Such plugins can be specified in
126
 
the ``BZR_DISABLE_PLUGINS`` environment variable.
127
 
 
128
 
In that case, ``bzr`` will stop loading the specified plugins and
129
 
will raise an import error if they are explicitly imported (by
130
 
another plugin that depends on them for example).
131
 
 
132
 
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
133
 
 
134
 
  BZR_DISABLE_PLUGINS='myplugin:yourplugin'
135
 
 
136
 
BZR_PLUGINS_AT
137
 
~~~~~~~~~~~~~~
138
 
 
139
 
When adding a new feature or working on a bug in a plugin,
140
 
developers often need to use a specific version of a given
141
 
plugin. Since python requires that the directory containing the
142
 
code is named like the plugin itself this make it impossible to
143
 
use arbitrary directory names (using a two-level directory scheme
144
 
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
145
 
if they don't appear in ``BZR_PLUGIN_PATH`` .
146
 
 
147
 
Plugins specified in this environment variable takes precedence
148
 
over the ones in ``BZR_PLUGIN_PATH``.
149
 
 
150
 
The variable specified a list of ``plugin_name@plugin path``,
151
 
``plugin_name`` being the name of the plugin as it appears in
152
 
python module paths, ``plugin_path`` being the path to the
153
 
directory containing the plugin code itself
154
 
(i.e. ``plugins/myplugin`` not ``plugins``).  Use ':' as the list
155
 
separator, use ';' on windows.
156
 
 
157
 
Example:
158
 
~~~~~~~~
159
 
 
160
 
Using a specific version of ``myplugin``:
161
 
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
162
70
 
163
71
BZRPATH
164
72
~~~~~~~
214
122
 
215
123
    [DEFAULT]
216
124
 
217
 
The only valid section headers for bazaar.conf currently are [DEFAULT] and
218
 
[ALIASES].  Section headers are case sensitive. The default section provides for
219
 
setting variables which can be overridden with the branch config file.
 
125
The only valid section header for bazaar.conf is [DEFAULT], which is
 
126
case sensitive. The default section provides for setting variables
 
127
which can be overridden with the branch config file.
220
128
 
221
129
For ``locations.conf``, the variables from the section with the
222
130
longest matching section header are used to the exclusion of other
270
178
The main configuration file, bazaar.conf
271
179
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272
180
 
273
 
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
274
 
The default section contains the default
 
181
``bazaar.conf`` only allows one
 
182
section called ``[DEFAULT]``. This default section contains the default
275
183
configuration options for all branches. The default section can be
276
184
overriden by providing a branch-specific section in ``locations.conf``.
277
185
 
314
222
variable policies which don't apply.
315
223
 
316
224
For more information on the possible uses of the authentication configuration
317
 
file see :doc:`authentication-help`.
 
225
file see `Authentication Settings`_.
318
226
 
319
227
 
320
228
Common variable options
321
229
-----------------------
322
230
 
323
 
debug_flags
324
 
~~~~~~~~~~~
325
 
 
326
 
A comma-separated list of debugging options to turn on.  The same values
327
 
can be used as with the -D command-line option (see `help global-options`).
328
 
For example::
329
 
 
330
 
    debug_flags = hpss
331
 
 
332
231
email
333
232
~~~~~
334
233
 
345
244
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
346
245
variables.
347
246
 
348
 
log_format
349
 
~~~~~~~~~~
350
 
 
351
 
The default log format to use. Standard log formats are ``long``, ``short``
352
 
and ``line``. Additional formats may be provided by plugins. The default
353
 
value is ``long``.
354
 
 
355
247
check_signatures
356
248
~~~~~~~~~~~~~~~~
357
249
 
441
333
 
442
334
Supported values for specific clients:
443
335
 
444
 
:claws: Use Claws.  This skips a dialog for attaching files.
445
336
:evolution: Use Evolution.
446
337
:kmail: Use KMail.
447
338
:mutt: Use Mutt.
470
361
A publically-accessible version of this branch (implying that this version is
471
362
not publically-accessible).  Used (and set) by ``bzr send``.
472
363
 
473
 
suppress_warnings
474
 
~~~~~~~~~~~~~~~~~
475
 
 
476
 
A list of strings, each string represent a warning that can be emitted by
477
 
bzr. Mentioning a warning in this list tells bzr to not emit it.
478
 
 
479
 
Valid values:
480
 
 
481
 
* ``format_deprecation``:
482
 
    whether the format deprecation warning is shown on repositories that are
483
 
    using deprecated formats.
484
 
 
485
364
 
486
365
Branch type specific options
487
366
----------------------------
495
374
~~~~~~~~~~~~~~~~~~~~~
496
375
 
497
376
If set to "True" then revisions can only be appended to the log, not
498
 
removed.  A branch with this setting enabled can only pull from another
499
 
branch if the other branch's log is a longer version of its own.  This is
500
 
normally set by ``bzr init --append-revisions-only``. If you set it
501
 
manually, use either 'True' or 'False' (case-sensitive) to maintain
502
 
compatibility with previous bzr versions (older than 2.2).
 
377
removed.  A branch with this setting enabled can only pull from
 
378
another branch if the other branch's log is a longer version of its
 
379
own.  This is normally set by ``bzr init --append-revisions-only``.
503
380
 
504
381
parent_location
505
382
~~~~~~~~~~~~~~~
514
391
If present, the location of the default branch for push.  This option
515
392
is normally set by ``push --remember``.
516
393
 
517
 
push_strict
518
 
~~~~~~~~~~~
519
 
 
520
 
If present, defines the ``--strict`` option default value for checking
521
 
uncommitted changes before pushing.
522
 
 
523
 
dpush_strict
524
 
~~~~~~~~~~~~
525
 
 
526
 
If present, defines the ``--strict`` option default value for checking
527
 
uncommitted changes before pushing into a different VCS without any
528
 
custom bzr metadata.
529
 
 
530
394
bound_location
531
395
~~~~~~~~~~~~~~
532
396
 
538
402
 
539
403
If set to "True", the branch should act as a checkout, and push each commit to
540
404
the bound_location.  This option is normally set by ``bind``/``unbind``.
541
 
 
542
 
send_strict
543
 
~~~~~~~~~~~
544
 
 
545
 
If present, defines the ``--strict`` option default value for checking
546
 
uncommitted changes before sending a merge directive.
547