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

merge Alex's changes to support Windows installer and use bzrlib/help for topics

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help/configuration.txt
1
1
Configuration Settings
2
2
=======================
3
3
 
 
4
.. Information on how to configure Bazaar.
 
5
 
 
6
.. TODO: Should have some explanation of why you'd want things in
 
7
.. branch.conf.
 
8
 
 
9
 
4
10
Environment settings
5
11
---------------------
6
12
 
25
31
~~~~~~~~~~~~~~~
26
32
 
27
33
Control whether SIGQUIT behaves normally or invokes a breakin debugger.
28
 
 
29
 
* 0 = Standard SIGQUIT behavior (normally, exit with a core dump)
30
 
* 1 = Invoke breakin debugger (default)
 
34
0 = Standard SIGQUIT behavior
 
35
1 = Invoke breakin debugger (default)
31
36
 
32
37
BZR_HOME
33
38
~~~~~~~~
43
48
~~~~~~~
44
49
 
45
50
Control whether to launch a debugger on error.
46
 
 
47
 
* 0 = Standard behavior
48
 
* 1 = Launch debugger
 
51
0 = Standard behavior
 
52
1 = Launch debugger
49
53
 
50
54
BZR_REMOTE_PATH
51
55
~~~~~~~~~~~~~~~
52
56
 
53
57
Path to the Bazaar executable to use when using the bzr+ssh protocol.
54
58
 
55
 
See also the ``bzr_remote_path`` configuration value.
 
59
See also the ``bzr_remote_path`` configuration value
56
60
 
57
61
BZR_EDITOR
58
62
~~~~~~~~~~
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
~~~~~~~
172
80
Location
173
81
~~~~~~~~
174
82
 
175
 
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
176
 
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
177
 
Windows. (You can check the location for your system by using
178
 
``bzr version``.)
179
 
 
180
 
There are three primary configuration files in this location:
 
83
Configuration files are located in ``$HOME/.bazaar`` and are
 
84
sometimes referred to as ``ini files``:
181
85
 
182
86
* ``bazaar.conf`` describes default configuration options,
183
87
 
214
118
 
215
119
    [DEFAULT]
216
120
 
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.
 
121
The only valid section header for bazaar.conf is [DEFAULT], which is
 
122
case sensitive. The default section provides for setting variables
 
123
which can be overridden with the branch config file.
220
124
 
221
125
For ``locations.conf``, the variables from the section with the
222
126
longest matching section header are used to the exclusion of other
270
174
The main configuration file, bazaar.conf
271
175
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
272
176
 
273
 
``bazaar.conf`` allows two sections: ``[DEFAULT]`` and ``[ALIASES]``.
274
 
The default section contains the default
 
177
The main configuration file, ``$HOME/.bazaar/bazaar.conf``, only allows one
 
178
section called ``[DEFAULT]``. This default section contains the default
275
179
configuration options for all branches. The default section can be
276
180
overriden by providing a branch-specific section in ``locations.conf``.
277
181
 
287
191
The branch location configuration file, locations.conf
288
192
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
289
193
 
290
 
``locations.conf`` allows one to specify overriding settings for
 
194
``$HOME/.bazaar/locations.conf`` allows one to specify overriding settings for
291
195
a specific branch. The format is almost identical to the default section in
292
196
bazaar.conf with one significant change: The section header, instead of saying
293
197
default, will be the path to a branch that you wish to override a value
306
210
The authentication configuration file, authentication.conf
307
211
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
308
212
 
309
 
``authentication.conf`` allows one to specify credentials for
 
213
``$HOME/.bazaar/authentication.conf`` allows one to specify credentials for
310
214
remote servers. This can be used for all the supported transports and any part
311
215
of bzr that requires authentication (smtp for example).
312
216
 
314
218
variable policies which don't apply.
315
219
 
316
220
For more information on the possible uses of the authentication configuration
317
 
file see :doc:`authentication-help`.
 
221
file see the `authentication configuration file documentation`_.
318
222
 
 
223
.. _authentication configuration file documentation: authentication_conf.html
319
224
 
320
225
Common variable options
321
226
-----------------------
322
227
 
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
228
email
333
229
~~~~~
334
230
 
342
238
 
343
239
The path of the editor that you wish to use if *bzr commit* is run without
344
240
a commit message. This setting is trumped by the environment variable
345
 
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
346
 
variables.
347
 
 
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``.
 
241
``$BZR_EDITOR``, and overrides ``$VISUAL`` and ``$EDITOR``.
354
242
 
355
243
check_signatures
356
244
~~~~~~~~~~~~~~~~
441
329
 
442
330
Supported values for specific clients:
443
331
 
444
 
:claws: Use Claws.  This skips a dialog for attaching files.
445
332
:evolution: Use Evolution.
446
333
:kmail: Use KMail.
447
334
:mutt: Use Mutt.
470
357
A publically-accessible version of this branch (implying that this version is
471
358
not publically-accessible).  Used (and set) by ``bzr send``.
472
359
 
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
 
 
486
 
Branch type specific options
487
 
----------------------------
488
 
 
489
 
These options apply only to branches that use the ``dirstate-tags`` or
490
 
later format.  They
 
360
 
 
361
Branch 6 options
 
362
----------------
 
363
 
 
364
These options apply only to branches that use the "dirstate-tags" format.  They
491
365
are usually set in ``.bzr/branch/branch.conf`` automatically, but may be
492
366
manually set in ``locations.conf`` or ``bazaar.conf``.
493
367
 
495
369
~~~~~~~~~~~~~~~~~~~~~
496
370
 
497
371
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).
 
372
removed.  A branch with this setting enabled can only pull from
 
373
another branch if the other branch's log is a longer version of its
 
374
own.  This is normally set by ``bzr init --append-revisions-only``.
503
375
 
504
376
parent_location
505
377
~~~~~~~~~~~~~~~
514
386
If present, the location of the default branch for push.  This option
515
387
is normally set by ``push --remember``.
516
388
 
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
389
bound_location
531
390
~~~~~~~~~~~~~~
532
391
 
539
398
If set to "True", the branch should act as a checkout, and push each commit to
540
399
the bound_location.  This option is normally set by ``bind``/``unbind``.
541
400
 
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