← 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

Fixed as per review comments.

* bzrlib/tests/test_plugins.py:
(TestDisablePlugin.test_not_loaded,
TestDisablePlugin.test_cannot_import): Update tests.

* bzrlib/tests/__init__.py:
(TestCase._cleanEnvironment): Add BZR_DISABLE_PLUGINS.

* bzrlib/plugin.py:
(set_plugins_path): Use a dedicated BZR_DISABLE_PLUGINS env var
instead of mucking with BZR_PLUGIN_PATH.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
121
121
Overriding the default site plugin directory:
122
122
``BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user``
123
123
 
124
 
Disabling a given ``myplugin`` plugin while retaining the others:
125
 
``BZR_PLUGIN_PATH='-myplugin:+user'``
 
124
BZR_DISABLE_PLUGINS
 
125
~~~~~~~~~~~~~~~~~~~
 
126
 
 
127
Under special circumstances, it's better to disable a plugin (or
 
128
several) rather than uninstalling them completely. Such plugins
 
129
can be specified in the ``BZR_DISABLE_PLUGINS`` environment
 
130
variable.
 
131
 
 
132
In that case, ``bzr`` will stop loading the specified plugins and
 
133
will raise an import error if you try to import them explicitly.
 
134
 
 
135
Example:
 
136
~~~~~~~~
 
137
 
 
138
Disabling ``myplugin`` and ``yourplugin``:
 
139
``BZR_DISABLE_PLUGINS='myplugin:yourplugin'``
126
140
 
127
141
 
128
142
BZRPATH