/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: Robert Collins
  • Date: 2009-08-26 01:18:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4656.
  • Revision ID: robertc@robertcollins.net-20090826011813-46x8kcuzwz97opoi
Deserialise IncompatibleRepositories errors in the client, generating
nicer feedback when the smart server encounters such a situation.

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 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
 
The examples below use ':' as the separator, windows users
102
 
should use ';'.
103
 
 
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``
162
66
 
163
67
BZRPATH
164
68
~~~~~~~
314
218
variable policies which don't apply.
315
219
 
316
220
For more information on the possible uses of the authentication configuration
317
 
file see :doc:`authentication-help`.
 
221
file see `Authentication Settings`_.
318
222
 
319
223
 
320
224
Common variable options
470
374
A publically-accessible version of this branch (implying that this version is
471
375
not publically-accessible).  Used (and set) by ``bzr send``.
472
376
 
473
 
suppress_warnings
474
 
~~~~~~~~~~~~~~~~~
475
 
 
476
 
A list of strings, each string represent a warning that can be emitted by
477
 
bzr. Mentioning a warning in this list tells bzr to not emit it.
478
 
 
479
 
Valid values:
480
 
 
481
 
* ``format_deprecation``:
482
 
    whether the format deprecation warning is shown on repositories that are
483
 
    using deprecated formats.
484
 
 
485
377
 
486
378
Branch type specific options
487
379
----------------------------
495
387
~~~~~~~~~~~~~~~~~~~~~
496
388
 
497
389
If set to "True" then revisions can only be appended to the log, not
498
 
removed.  A branch with this setting enabled can only pull from another
499
 
branch if the other branch's log is a longer version of its own.  This is
500
 
normally set by ``bzr init --append-revisions-only``. If you set it
501
 
manually, use either 'True' or 'False' (case-sensitive) to maintain
502
 
compatibility with previous bzr versions (older than 2.2).
 
390
removed.  A branch with this setting enabled can only pull from
 
391
another branch if the other branch's log is a longer version of its
 
392
own.  This is normally set by ``bzr init --append-revisions-only``.
503
393
 
504
394
parent_location
505
395
~~~~~~~~~~~~~~~
520
410
If present, defines the ``--strict`` option default value for checking
521
411
uncommitted changes before pushing.
522
412
 
523
 
dpush_strict
524
 
~~~~~~~~~~~~
525
 
 
526
 
If present, defines the ``--strict`` option default value for checking
527
 
uncommitted changes before pushing into a different VCS without any
528
 
custom bzr metadata.
529
 
 
530
413
bound_location
531
414
~~~~~~~~~~~~~~
532
415