← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

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

  • Committer: Gordon Tyler
  • Date: 2010-02-02 06:30:43 UTC
  • mto: (5037.3.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5046.
  • Revision ID: gordon@doxxx.net-20100202063043-3ygr1114d25m3f7m
Added cmdline.split function, which replaces commands.shlex_split_unicode.

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
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
~~~~~~~
218
272
variable policies which don't apply.
219
273
 
220
274
For more information on the possible uses of the authentication configuration
221
 
file see `Authentication Settings`_.
 
275
file see :doc:`authentication-help`.
222
276
 
223
277
 
224
278
Common variable options
374
428
A publically-accessible version of this branch (implying that this version is
375
429
not publically-accessible).  Used (and set) by ``bzr send``.
376
430
 
 
431
suppress_warnings
 
432
~~~~~~~~~~~~~~~~~
 
433
 
 
434
A list of strings, each string represent a warning that can be emitted by
 
435
bzr. Mentioning a warning in this list tells bzr to not emit it.
 
436
 
 
437
Valid values:
 
438
 
 
439
* ``format_deprecation``:
 
440
    whether the format deprecation warning is shown on repositories that are
 
441
    using deprecated formats.
 
442
 
377
443
 
378
444
Branch type specific options
379
445
----------------------------
404
470
If present, the location of the default branch for push.  This option
405
471
is normally set by ``push --remember``.
406
472
 
 
473
push_strict
 
474
~~~~~~~~~~~
 
475
 
 
476
If present, defines the ``--strict`` option default value for checking
 
477
uncommitted changes before pushing.
 
478
 
 
479
dpush_strict
 
480
~~~~~~~~~~~~
 
481
 
 
482
If present, defines the ``--strict`` option default value for checking
 
483
uncommitted changes before pushing into a different VCS without any
 
484
custom bzr metadata.
 
485
 
407
486
bound_location
408
487
~~~~~~~~~~~~~~
409
488
 
415
494
 
416
495
If set to "True", the branch should act as a checkout, and push each commit to
417
496
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
497
 
 
498
send_strict
 
499
~~~~~~~~~~~
 
500
 
 
501
If present, defines the ``--strict`` option default value for checking
 
502
uncommitted changes before sending a merge directive.
 
503