/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: Michael Hudson
  • Date: 2009-11-24 02:25:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4822.
  • Revision ID: michael.hudson@canonical.com-20091124022523-0pism3bgkg0ip73t
final tweak

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
 
 
75
62
BZR_PLUGIN_PATH
76
63
~~~~~~~~~~~~~~~
77
64
 
111
98
used literally, they will be substituted by the corresponding,
112
99
platform specific, values.
113
100
 
114
 
The examples below use ':' as the separator, windows users
 
101
Examples:
 
102
^^^^^^^^^
 
103
 
 
104
The examples below uses ':' as the separator, windows users
115
105
should use ';'.
116
106
 
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``
 
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
 
175
120
 
176
121
BZRPATH
177
122
~~~~~~~
327
272
variable policies which don't apply.
328
273
 
329
274
For more information on the possible uses of the authentication configuration
330
 
file see :doc:`authentication-help`.
 
275
file see `Authentication Settings`_.
331
276
 
332
277
 
333
278
Common variable options
483
428
A publically-accessible version of this branch (implying that this version is
484
429
not publically-accessible).  Used (and set) by ``bzr send``.
485
430
 
486
 
suppress_warnings
487
 
~~~~~~~~~~~~~~~~~
488
 
 
489
 
A list of strings, each string represent a warning that can be emitted by
490
 
bzr. Mentioning a warning in this list tells bzr to not emit it.
491
 
 
492
 
Valid values:
493
 
 
494
 
* ``format_deprecation``:
495
 
    whether the format deprecation warning is shown on repositories that are
496
 
    using deprecated formats.
497
 
 
498
431
 
499
432
Branch type specific options
500
433
----------------------------
508
441
~~~~~~~~~~~~~~~~~~~~~
509
442
 
510
443
If set to "True" then revisions can only be appended to the log, not
511
 
removed.  A branch with this setting enabled can only pull from another
512
 
branch if the other branch's log is a longer version of its own.  This is
513
 
normally set by ``bzr init --append-revisions-only``. If you set it
514
 
manually, use either 'True' or 'False' (case-sensitive) to maintain
515
 
compatibility with previous bzr versions (older than 2.2).
 
444
removed.  A branch with this setting enabled can only pull from
 
445
another branch if the other branch's log is a longer version of its
 
446
own.  This is normally set by ``bzr init --append-revisions-only``.
516
447
 
517
448
parent_location
518
449
~~~~~~~~~~~~~~~