/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: 2009-08-20 13:26:36 UTC
  • mto: (4672.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4673.
  • Revision ID: v.ladeuil+lp@free.fr-20090820132636-i3rs1vf3d3fn46hq
Update doc and add NEWS entry.

* bzrlib/tests/test_plugins.py:
(TestEnvPluginPath.test_disable_core,
TestEnvPluginPath.test_disable_site,
TestEnvPluginPath.test_override_site,
TestEnvPluginPath.test_override_core):

* bzrlib/plugin.py:
(get_standard_plugins_path): Give a better explanantion and don't
break compatibility.

* bzrlib/help_topics/en/configuration.txt: 
(BZR_PLUGIN_PATH): Update doc.

* doc/en/user-guide/plugins.txt: 
Fix doc.

* doc/en/user-guide/writing_a_plugin.txt: 
Fix doc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
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 size 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 all directories specified in ``BZR_PLUGIN_PATH``
 
84
replace 'user' in the but keep searching in 'core' then 'site'.
 
85
 
 
86
If you need to change the order or remove one of these
 
87
directories, you should use special values:
 
88
 
 
89
* ``-user``, ``-core``, ``-site`` will remove the corresponding
 
90
  path from the default values,
 
91
 
 
92
* ``+user``, ``+core``, ``+site`` will add the corresponding path
 
93
  before the remaining default values (and also remove it from
 
94
  the default values).
 
95
 
 
96
Note that the special values 'user', 'core' and 'site' should be
 
97
used literally, they will be substituted by the corresponding,
 
98
platform specific, values.
 
99
 
 
100
Examples:
 
101
^^^^^^^^^
 
102
 
 
103
The examples below uses ':' as the separator, windows users
 
104
should use ';'.
 
105
 
 
106
Overriding the default user plugin directory:
 
107
``BZR_PLUGIN_PATH='/path/to/my/other/plugins'``
 
108
 
 
109
Disabling the site directory while retaining the user directory:
 
110
``BZR_PLUGIN_PATH='-site:+user'``
 
111
 
 
112
Disabling all plugins (better achieved with --no-plugins):
 
113
``BZR_PLUGIN_PATH='-user:-core:-site'``
 
114
 
 
115
Overriding the default site plugin directory:
 
116
``BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user``
 
117
 
 
118
 
66
119
 
67
120
BZRPATH
68
121
~~~~~~~