/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: Vincent Ladeuil
  • Date: 2010-03-24 13:58:37 UTC
  • mfrom: (5086.5.12 82693-plugin-at-path)
  • mto: This revision was merged to the branch mainline in revision 5108.
  • Revision ID: v.ladeuil+lp@free.fr-20100324135837-06hiz4gj3b29zlr0
https://launchpad.net/bugs/82693
Add BZR_PLUGINS_AT support to specify a directory for a given plugin

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
120
120
BZR_DISABLE_PLUGINS
121
121
~~~~~~~~~~~~~~~~~~~
122
122
 
123
 
Under special circumstances, it's better to disable a plugin (or
124
 
several) rather than uninstalling them completely. Such plugins
125
 
can be specified in the ``BZR_DISABLE_PLUGINS`` environment
126
 
variable.
 
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
127
 
128
128
In that case, ``bzr`` will stop loading the specified plugins and
129
129
will raise an import error if they are explicitly imported (by
133
133
 
134
134
  BZR_DISABLE_PLUGINS='myplugin:yourplugin'
135
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``
136
162
 
137
163
BZRPATH
138
164
~~~~~~~