← 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-09-01 08:02:42 UTC
  • mfrom: (5390.3.3 faster-revert-593560)
  • Revision ID: pqm@pqm.ubuntu.com-20100901080242-esg62ody4frwmy66
(spiv) Avoid repeatedly calling self.target.all_file_ids() in
 InterTree.iter_changes. (Andrew Bennetts)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
59
59
 
60
60
Path to the editor Bazaar should use for commit messages, etc.
61
61
 
 
62
BZR_LOG
 
63
~~~~~~~
 
64
 
 
65
Location of the Bazaar log file. You can check the current location by
 
66
running ``bzr version``.
 
67
 
 
68
The log file contains debug information that is useful for diagnosing or
 
69
reporting problems with Bazaar.
 
70
 
 
71
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
 
72
will disable logging.
 
73
 
 
74
 
62
75
BZR_PLUGIN_PATH
63
76
~~~~~~~~~~~~~~~
64
77
 
65
78
The path to the plugins directory that Bazaar should use.
 
79
If not set, Bazaar will search for plugins in:
 
80
 
 
81
* the user specific plugin directory (containing the ``user`` plugins),
 
82
 
 
83
* the bzrlib directory (containing the ``core`` plugins),
 
84
 
 
85
* the site specific plugin directory if applicable (containing
 
86
  the ``site`` plugins).
 
87
 
 
88
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
 
89
the way the plugin are searched. 
 
90
 
 
91
As for the ``PATH`` variables, if multiple directories are
 
92
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
 
93
platform specific appropriate character (':' on Unix,
 
94
';' on windows)
 
95
 
 
96
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
 
97
in ``user``.  However it will continue to search in ``core`` and
 
98
``site`` unless they are explicitly removed.
 
99
 
 
100
If you need to change the order or remove one of these
 
101
directories, you should use special values:
 
102
 
 
103
* ``-user``, ``-core``, ``-site`` will remove the corresponding
 
104
  path from the default values,
 
105
 
 
106
* ``+user``, ``+core``, ``+site`` will add the corresponding path
 
107
  before the remaining default values (and also remove it from
 
108
  the default values).
 
109
 
 
110
Note that the special values 'user', 'core' and 'site' should be
 
111
used literally, they will be substituted by the corresponding,
 
112
platform specific, values.
 
113
 
 
114
The examples below use ':' as the separator, windows users
 
115
should use ';'.
 
116
 
 
117
Overriding the default user plugin directory::
 
118
 
 
119
  BZR_PLUGIN_PATH='/path/to/my/other/plugins'
 
120
 
 
121
Disabling the site directory while retaining the user directory::
 
122
 
 
123
  BZR_PLUGIN_PATH='-site:+user'
 
124
 
 
125
Disabling all plugins (better achieved with --no-plugins)::
 
126
 
 
127
  BZR_PLUGIN_PATH='-user:-core:-site'
 
128
 
 
129
Overriding the default site plugin directory::
 
130
 
 
131
  BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
 
132
 
 
133
BZR_DISABLE_PLUGINS
 
134
~~~~~~~~~~~~~~~~~~~
 
135
 
 
136
Under special circumstances (mostly when trying to diagnose a
 
137
bug), it's better to disable a plugin (or several) rather than
 
138
uninstalling them completely. Such plugins can be specified in
 
139
the ``BZR_DISABLE_PLUGINS`` environment variable.
 
140
 
 
141
In that case, ``bzr`` will stop loading the specified plugins and
 
142
will raise an import error if they are explicitly imported (by
 
143
another plugin that depends on them for example).
 
144
 
 
145
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
 
146
 
 
147
  BZR_DISABLE_PLUGINS='myplugin:yourplugin'
 
148
 
 
149
BZR_PLUGINS_AT
 
150
~~~~~~~~~~~~~~
 
151
 
 
152
When adding a new feature or working on a bug in a plugin,
 
153
developers often need to use a specific version of a given
 
154
plugin. Since python requires that the directory containing the
 
155
code is named like the plugin itself this make it impossible to
 
156
use arbitrary directory names (using a two-level directory scheme
 
157
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
 
158
if they don't appear in ``BZR_PLUGIN_PATH`` .
 
159
 
 
160
Plugins specified in this environment variable takes precedence
 
161
over the ones in ``BZR_PLUGIN_PATH``.
 
162
 
 
163
The variable specified a list of ``plugin_name@plugin path``,
 
164
``plugin_name`` being the name of the plugin as it appears in
 
165
python module paths, ``plugin_path`` being the path to the
 
166
directory containing the plugin code itself
 
167
(i.e. ``plugins/myplugin`` not ``plugins``).  Use ':' as the list
 
168
separator, use ';' on windows.
 
169
 
 
170
Example:
 
171
~~~~~~~~
 
172
 
 
173
Using a specific version of ``myplugin``:
 
174
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
66
175
 
67
176
BZRPATH
68
177
~~~~~~~
70
179
The path where Bazaar should look for shell plugin external commands.
71
180
 
72
181
 
 
182
http_proxy, https_proxy
 
183
~~~~~~~~~~~~~~~~~~~~~~~
 
184
 
 
185
Specifies the network proxy for outgoing connections, for example::
 
186
 
 
187
  http_proxy=http://proxy.example.com:3128/ 
 
188
  https_proxy=http://proxy.example.com:3128/
 
189
 
 
190
 
73
191
Configuration files
74
192
-------------------
75
193
 
76
194
Location
77
195
~~~~~~~~
78
196
 
79
 
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
 
197
Configuration files are located in ``$HOME/.bazaar`` on Unix and
80
198
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
81
199
Windows. (You can check the location for your system by using
82
200
``bzr version``.)
218
336
variable policies which don't apply.
219
337
 
220
338
For more information on the possible uses of the authentication configuration
221
 
file see `Authentication Settings`_.
 
339
file see :doc:`authentication-help`.
222
340
 
223
341
 
224
342
Common variable options
374
492
A publically-accessible version of this branch (implying that this version is
375
493
not publically-accessible).  Used (and set) by ``bzr send``.
376
494
 
 
495
suppress_warnings
 
496
~~~~~~~~~~~~~~~~~
 
497
 
 
498
A list of strings, each string represent a warning that can be emitted by
 
499
bzr. Mentioning a warning in this list tells bzr to not emit it.
 
500
 
 
501
Valid values:
 
502
 
 
503
* ``format_deprecation``:
 
504
    whether the format deprecation warning is shown on repositories that are
 
505
    using deprecated formats.
 
506
 
 
507
 
 
508
Unicode options
 
509
---------------
 
510
 
 
511
output_encoding
 
512
~~~~~~~~~~~~~~~
 
513
 
 
514
A Python unicode encoding name for text output from bzr, such as log
 
515
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
 
516
is the terminal encoding prefered by the operating system.
 
517
 
377
518
 
378
519
Branch type specific options
379
520
----------------------------
387
528
~~~~~~~~~~~~~~~~~~~~~
388
529
 
389
530
If set to "True" then revisions can only be appended to the log, not
390
 
removed.  A branch with this setting enabled can only pull from
391
 
another branch if the other branch's log is a longer version of its
392
 
own.  This is normally set by ``bzr init --append-revisions-only``.
 
531
removed.  A branch with this setting enabled can only pull from another
 
532
branch if the other branch's log is a longer version of its own.  This is
 
533
normally set by ``bzr init --append-revisions-only``. If you set it
 
534
manually, use either 'True' or 'False' (case-sensitive) to maintain
 
535
compatibility with previous bzr versions (older than 2.2).
393
536
 
394
537
parent_location
395
538
~~~~~~~~~~~~~~~
404
547
If present, the location of the default branch for push.  This option
405
548
is normally set by ``push --remember``.
406
549
 
 
550
push_strict
 
551
~~~~~~~~~~~
 
552
 
 
553
If present, defines the ``--strict`` option default value for checking
 
554
uncommitted changes before pushing.
 
555
 
 
556
dpush_strict
 
557
~~~~~~~~~~~~
 
558
 
 
559
If present, defines the ``--strict`` option default value for checking
 
560
uncommitted changes before pushing into a different VCS without any
 
561
custom bzr metadata.
 
562
 
407
563
bound_location
408
564
~~~~~~~~~~~~~~
409
565
 
415
571
 
416
572
If set to "True", the branch should act as a checkout, and push each commit to
417
573
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
574
 
 
575
send_strict
 
576
~~~~~~~~~~~
 
577
 
 
578
If present, defines the ``--strict`` option default value for checking
 
579
uncommitted changes before sending a merge directive.
 
580