~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/configuration.txt

  • Committer: Robert Collins
  • Date: 2010-04-08 04:34:03 UTC
  • mfrom: (5138 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5139.
  • Revision ID: robertc@robertcollins.net-20100408043403-56z0d07vdqrx7f3t
Update bugfix for 528114 to trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
98
98
used literally, they will be substituted by the corresponding,
99
99
platform specific, values.
100
100
 
101
 
Examples:
102
 
^^^^^^^^^
103
 
 
104
 
The examples below uses ':' as the separator, windows users
 
101
The examples below use ':' as the separator, windows users
105
102
should use ';'.
106
103
 
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
 
 
 
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``
120
162
 
121
163
BZRPATH
122
164
~~~~~~~