/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 breezy/help_topics/en/configuration.txt

  • Committer: Jelmer Vernooij
  • Date: 2020-08-22 22:46:24 UTC
  • mfrom: (7490.40.105 work)
  • mto: This revision was merged to the branch mainline in revision 7521.
  • Revision ID: jelmer@jelmer.uk-20200822224624-om4a4idsr7cn8jew
merge lp:brz/3.1.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/help_topics/en/configuration.txt
65
65
~~~~~~~
66
66
 
67
67
Location of the Breezy log file. You can check the current location by
68
 
running ``bzr version``.
 
68
running ``brz version``.
69
69
 
70
70
The log file contains debug information that is useful for diagnosing or
71
71
reporting problems with Breezy.
87
87
* the site specific plugin directory if applicable (containing
88
88
  the ``site`` plugins).
89
89
 
90
 
If ``BZR_PLUGIN_PATH`` is set in any fashion, it will change the
 
90
If ``BRZ_PLUGIN_PATH`` is set in any fashion, it will change the
91
91
the way the plugin are searched. 
92
92
 
93
93
As for the ``PATH`` variables, if multiple directories are
94
 
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
 
94
specified in ``BRZ_PLUGIN_PATH`` they should be separated by the
95
95
platform specific appropriate character (':' on Unix,
96
96
';' on windows)
97
97
 
98
 
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
 
98
By default if ``BRZ_PLUGIN_PATH`` is set, it replaces searching
99
99
in ``user``.  However it will continue to search in ``core`` and
100
100
``site`` unless they are explicitly removed.
101
101
 
118
118
 
119
119
Overriding the default user plugin directory::
120
120
 
121
 
  BZR_PLUGIN_PATH='/path/to/my/other/plugins'
 
121
  BRZ_PLUGIN_PATH='/path/to/my/other/plugins'
122
122
 
123
123
Disabling the site directory while retaining the user directory::
124
124
 
125
 
  BZR_PLUGIN_PATH='-site:+user'
 
125
  BRZ_PLUGIN_PATH='-site:+user'
126
126
 
127
127
Disabling all plugins (better achieved with --no-plugins)::
128
128
 
129
 
  BZR_PLUGIN_PATH='-user:-core:-site'
 
129
  BRZ_PLUGIN_PATH='-user:-core:-site'
130
130
 
131
131
Overriding the default site plugin directory::
132
132
 
133
 
  BZR_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
 
133
  BRZ_PLUGIN_PATH='/path/to/my/site/plugins:-site':+user
134
134
 
135
135
BRZ_DISABLE_PLUGINS
136
136
~~~~~~~~~~~~~~~~~~~
138
138
Under special circumstances (mostly when trying to diagnose a
139
139
bug), it's better to disable a plugin (or several) rather than
140
140
uninstalling them completely. Such plugins can be specified in
141
 
the ``BZR_DISABLE_PLUGINS`` environment variable.
 
141
the ``BRZ_DISABLE_PLUGINS`` environment variable.
142
142
 
143
 
In that case, ``bzr`` will stop loading the specified plugins and
 
143
In that case, ``brz`` will stop loading the specified plugins and
144
144
will raise an import error if they are explicitly imported (by
145
145
another plugin that depends on them for example).
146
146
 
147
147
Disabling ``myplugin`` and ``yourplugin`` is achieved by::
148
148
 
149
 
  BZR_DISABLE_PLUGINS='myplugin:yourplugin'
 
149
  BRZ_DISABLE_PLUGINS='myplugin:yourplugin'
150
150
 
151
151
BRZ_PLUGINS_AT
152
152
~~~~~~~~~~~~~~
156
156
plugin. Since python requires that the directory containing the
157
157
code is named like the plugin itself this make it impossible to
158
158
use arbitrary directory names (using a two-level directory scheme
159
 
is inconvenient). ``BZR_PLUGINS_AT`` allows such directories even
160
 
if they don't appear in ``BZR_PLUGIN_PATH`` .
 
159
is inconvenient). ``BRZ_PLUGINS_AT`` allows such directories even
 
160
if they don't appear in ``BRZ_PLUGIN_PATH`` .
161
161
 
162
162
Plugins specified in this environment variable takes precedence
163
 
over the ones in ``BZR_PLUGIN_PATH``.
 
163
over the ones in ``BRZ_PLUGIN_PATH``.
164
164
 
165
165
The variable specified a list of ``plugin_name@plugin path``,
166
166
``plugin_name`` being the name of the plugin as it appears in
173
173
~~~~~~~~
174
174
 
175
175
Using a specific version of ``myplugin``:
176
 
``BZR_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
 
176
``BRZ_PLUGINS_AT='myplugin@/home/me/bugfixes/123456-myplugin``
177
177
 
178
178
BRZPATH
179
179
~~~~~~~
199
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
200
200
``C:\Documents and Settings\<username>\Application Data\Breezy\2.0`` on
201
201
Windows. (You can check the location for your system by using
202
 
``bzr version``.)
 
202
``brz version``.)
203
203
 
204
204
There are three primary configuration files in this location:
205
205
 
315
315
In both cases, when used in a directory like
316
316
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
317
317
 
318
 
   $ bzr config mypush
 
318
   $ brz config mypush
319
319
   lp:~vila/bzr/832013-expand-in-stack
320
320
 
321
321
Another such option is ``basename`` which can be used like this::
326
326
When used in a directory like
327
327
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
328
328
 
329
 
   $ bzr config mypush
 
329
   $ brz config mypush
330
330
   lp:~vila/bzr/832013-expand-in-stack
331
331
 
332
332
Note that ``basename`` here refers to the base name of ``relpath`` which
342
342
 
343
343
When used with a colocated branch named ``832013-expand-in-stack``, we'll get::
344
344
 
345
 
  bzr config mypush
 
345
  brz config mypush
346
346
  lp:~vila/bzr/832013-expand-in-stack
347
347
 
348
348
When an option is local to a Section, it cannot be referred to from option
386
386
 
387
387
``authentication.conf`` allows one to specify credentials for
388
388
remote servers. This can be used for all the supported transports and any part
389
 
of bzr that requires authentication (smtp for example).
 
389
of brz that requires authentication (smtp for example).
390
390
 
391
391
The syntax of the file obeys the same rules as the others except for the
392
392
option policies which don't apply.
422
422
editor
423
423
~~~~~~
424
424
 
425
 
The path of the editor that you wish to use if *bzr commit* is run without
 
425
The path of the editor that you wish to use if *brz commit* is run without
426
426
a commit message. This setting is trumped by the environment variable
427
 
``BZR_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
 
427
``BRZ_EDITOR``, and overrides the ``VISUAL`` and ``EDITOR`` environment
428
428
variables.
429
429
 
430
430
log_format
454
454
create_signatures
455
455
~~~~~~~~~~~~~~~~~
456
456
 
457
 
Defines the behaviour of signing revisions on commits.  By default bzr will not
 
457
Defines the behaviour of signing revisions on commits.  By default brz will not
458
458
sign new commits.
459
459
 
460
460
always
514
514
~~~~~~~~~~~
515
515
 
516
516
(Default: "localhost"). SMTP server to use when Breezy needs to send
517
 
email, eg. with ``merge-directive --mail-to``, or the bzr-email plugin.
 
517
email, eg. with ``merge-directive --mail-to``, or the email plugin.
518
518
 
519
519
smtp_username, smtp_password
520
520
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
527
527
locks.steal_dead
528
528
~~~~~~~~~~~~~~~~
529
529
 
530
 
By default, bzr will automatically break locks held by processes from
 
530
By default, brz will automatically break locks held by processes from
531
531
the same machine and user that are no longer alive.  If disabled, it will
532
532
print a message and you can break the lock manually, if you are satisfied
533
533
the object is no longer in use.
536
536
~~~~~~~~~~~
537
537
 
538
538
A mail client to use for sending merge requests.
539
 
By default, bzr will try to use ``mapi`` on Windows.  On other platforms, it
 
539
By default, brz will try to use ``mapi`` on Windows.  On other platforms, it
540
540
will try ``xdg-email``. If either of these fails, it will fall back to
541
541
``editor``.
542
542
 
553
553
 
554
554
:default: See above.
555
555
:editor: Use your editor to compose the merge request.  This also uses
556
 
    your commit id, (see ``bzr whoami``), smtp_server and (optionally)
 
556
    your commit id, (see ``brz whoami``), smtp_server and (optionally)
557
557
    smtp_username and smtp_password.
558
558
:mapi: Use your preferred e-mail client on Windows.
559
559
:xdg-email: Use xdg-email to run your preferred mail program
569
569
~~~~~~~~~~~~~
570
570
 
571
571
The branch you intend to submit your current work to.  This is automatically
572
 
set by ``bzr send``, and is also used by the ``submit:`` revision spec.  This
 
572
set by ``brz send``, and is also used by the ``submit:`` revision spec.  This
573
573
should usually be set on a per-branch or per-location basis.
574
574
 
575
575
public_branch
576
576
~~~~~~~~~~~~~
577
577
 
578
578
A publically-accessible version of this branch (implying that this version is
579
 
not publically-accessible).  Used (and set) by ``bzr send``.
 
579
not publically-accessible).  Used (and set) by ``brz send``.
580
580
 
581
581
suppress_warnings
582
582
~~~~~~~~~~~~~~~~~
583
583
 
584
584
A list of strings, each string represent a warning that can be emitted by
585
 
bzr. Mentioning a warning in this list tells bzr to not emit it.
 
585
brz. Mentioning a warning in this list tells bzr to not emit it.
586
586
 
587
587
Valid values:
588
588
 
597
597
default_format
598
598
~~~~~~~~~~~~~~
599
599
 
600
 
A format name for the default format used when creating branches.  See ``bzr
 
600
A format name for the default format used when creating branches.  See ``brz
601
601
help formats`` for possible values.
602
602
 
603
603
 
626
626
If set to "True" then revisions can only be appended to the log, not
627
627
removed.  A branch with this setting enabled can only pull from another
628
628
branch if the other branch's log is a longer version of its own.  This is
629
 
normally set by ``bzr init --append-revisions-only``. If you set it
 
629
normally set by ``brz init --append-revisions-only``. If you set it
630
630
manually, use either 'True' or 'False' (case-sensitive) to maintain
631
 
compatibility with previous bzr versions (older than 2.2).
 
631
compatibility with previous brz versions (older than 2.2).
632
632
 
633
633
parent_location
634
634
~~~~~~~~~~~~~~~
705
705
following problem::
706
706
 
707
707
 
708
 
  $ bzr config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
709
 
  $ bzr config bzr.mergetool.kdiff3
710
 
  bzr: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
 
708
  $ brz config bzr.mergetool.kdiff3='kdiff3 {base} {this} {other} -o {result}'
 
709
  $ brz config bzr.mergetool.kdiff3
 
710
  brz: ERROR: Option base is not defined while expanding "kdiff3 {base} {this} {other} -o {result}".
711
711
 
712
712
To avoid this, ``config`` can be instructed not to try expanding variables::
713
713
 
714
 
  $ bzr config --all bzr.mergetool.kdiff3
 
714
  $ brz config --all bzr.mergetool.kdiff3
715
715
  branch:
716
716
    bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
717
717
 
720
720
~~~~~~~~~~~~~~~~~~~~~
721
721
 
722
722
Specifies which external merge tool (as defined above) should be selected by
723
 
default in tools such as ``bzr qconflicts``.
 
723
default in tools such as ``brz qconflicts``.
724
724
 
725
725
For example::
726
726