← 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: John Arbash Meinel
  • Date: 2009-03-06 20:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4088.
  • Revision ID: john@arbash-meinel.com-20090306204240-mzjavv31z3gu1x7i
Fix a small bug in setup.py when an extension fails to build

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
 
 
120
66
 
121
67
BZRPATH
122
68
~~~~~~~
272
218
variable policies which don't apply.
273
219
 
274
220
For more information on the possible uses of the authentication configuration
275
 
file see :doc:`authentication-help`.
 
221
file see `Authentication Settings`_.
276
222
 
277
223
 
278
224
Common variable options
428
374
A publically-accessible version of this branch (implying that this version is
429
375
not publically-accessible).  Used (and set) by ``bzr send``.
430
376
 
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
 
 
443
377
 
444
378
Branch type specific options
445
379
----------------------------
470
404
If present, the location of the default branch for push.  This option
471
405
is normally set by ``push --remember``.
472
406
 
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
 
 
486
407
bound_location
487
408
~~~~~~~~~~~~~~
488
409
 
494
415
 
495
416
If set to "True", the branch should act as a checkout, and push each commit to
496
417
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