~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Vincent Ladeuil
  • Date: 2009-09-04 15:36:48 UTC
  • mfrom: (4628.2.5 412930-plugin-path)
  • mto: This revision was merged to the branch mainline in revision 4673.
  • Revision ID: v.ladeuil+lp@free.fr-20090904153648-f4ajhttkhs92mgjz
BZR_PLUGIN_PATH can be used to fully control the plugin directories

Show diffs side-by-side

added added

removed removed

Lines of Context:
63
63
~~~~~~~~~~~~~~~
64
64
 
65
65
The path to the plugins directory that Bazaar should use.
 
66
If not set, Bazaar will search for plugins in:
 
67
 
 
68
* the user specific plugin directory (containing the ``user`` plugins),
 
69
 
 
70
* the bzrlib directory (containing the ``core`` plugins),
 
71
 
 
72
* the site specific plugin directory if applicable (containing
 
73
  the ``site`` plugins).
 
74
 
 
75
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
 
76
the way the plugin are searched. 
 
77
 
 
78
As for the ``PATH`` variables, if multiple directories are
 
79
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
 
80
platform specific appropriate character (':' on Unix/Linux/etc,
 
81
';' on windows)
 
82
 
 
83
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
 
84
in ``user``.  However it will continue to search in ``core`` and
 
85
``site`` unless they are explicitly removed.
 
86
 
 
87
If you need to change the order or remove one of these
 
88
directories, you should use special values:
 
89
 
 
90
* ``-user``, ``-core``, ``-site`` will remove the corresponding
 
91
  path from the default values,
 
92
 
 
93
* ``+user``, ``+core``, ``+site`` will add the corresponding path
 
94
  before the remaining default values (and also remove it from
 
95
  the default values).
 
96
 
 
97
Note that the special values 'user', 'core' and 'site' should be
 
98
used literally, they will be substituted by the corresponding,
 
99
platform specific, values.
 
100
 
 
101
Examples:
 
102
^^^^^^^^^
 
103
 
 
104
The examples below uses ':' as the separator, windows users
 
105
should use ';'.
 
106
 
 
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
 
66
120
 
67
121
BZRPATH
68
122
~~~~~~~