/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: John Arbash Meinel
  • Date: 2011-08-18 13:27:18 UTC
  • mto: (6015.9.14 2.4)
  • mto: This revision was merged to the branch mainline in revision 6090.
  • Revision ID: john@arbash-meinel.com-20110818132718-b4rrujubsaa3evuz
Add a __repr__ to _LazyListJoin to make it easier to debug.

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
BZR_PROGRESS_BAR
20
20
~~~~~~~~~~~~~~~~
21
21
 
22
 
Override the progress display.  Possible values are "none", "dots", "tty"
 
22
Override the progress display.  Possible values are "none" or "text".  If
 
23
the value is "none" then no progress bar is displayed.  The value "text" draws
 
24
the ordinary command line progress bar.
23
25
 
24
26
BZR_SIGQUIT_PDB
25
27
~~~~~~~~~~~~~~~
59
61
 
60
62
Path to the editor Bazaar should use for commit messages, etc.
61
63
 
 
64
BZR_LOG
 
65
~~~~~~~
 
66
 
 
67
Location of the Bazaar log file. You can check the current location by
 
68
running ``bzr version``.
 
69
 
 
70
The log file contains debug information that is useful for diagnosing or
 
71
reporting problems with Bazaar.
 
72
 
 
73
Setting this to ``NUL`` on Windows or ``/dev/null`` on other platforms
 
74
will disable logging.
 
75
 
 
76
 
62
77
BZR_PLUGIN_PATH
63
78
~~~~~~~~~~~~~~~
64
79
 
77
92
 
78
93
As for the ``PATH`` variables, if multiple directories are
79
94
specified in ``BZR_PLUGIN_PATH`` they should be separated by the
80
 
platform specific appropriate character (':' on Unix/Linux/etc,
 
95
platform specific appropriate character (':' on Unix,
81
96
';' on windows)
82
97
 
83
98
By default if ``BZR_PLUGIN_PATH`` is set, it replaces searching
166
181
The path where Bazaar should look for shell plugin external commands.
167
182
 
168
183
 
 
184
http_proxy, https_proxy
 
185
~~~~~~~~~~~~~~~~~~~~~~~
 
186
 
 
187
Specifies the network proxy for outgoing connections, for example::
 
188
 
 
189
  http_proxy=http://proxy.example.com:3128/ 
 
190
  https_proxy=http://proxy.example.com:3128/
 
191
 
 
192
 
169
193
Configuration files
170
194
-------------------
171
195
 
172
196
Location
173
197
~~~~~~~~
174
198
 
175
 
Configuration files are located in ``$HOME/.bazaar`` on Linux/Unix and
 
199
Configuration files are located in ``$HOME/.bazaar`` on Unix and
176
200
``C:\Documents and Settings\<username>\Application Data\Bazaar\2.0`` on
177
201
Windows. (You can check the location for your system by using
178
202
``bzr version``.)
236
260
    email            = John Doe <jdoe@isp.com>
237
261
    check_signatures = require
238
262
 
 
263
A variable can reference other variables **in the same configuration file** by
 
264
enclosing them in curly brackets::
 
265
 
 
266
    my_branch_name = feature_x
 
267
    my_server      = bzr+ssh://example.com
 
268
    push_location   = {my_server}/project/{my_branch_name}
 
269
 
239
270
 
240
271
Variable policies
241
272
^^^^^^^^^^^^^^^^^
300
331
    create_signatures = always
301
332
    check_signatures  = always
302
333
 
303
 
    [http://bazaar-vcs.org/bzr/*]
 
334
    [http://example.com/bzr/*]
304
335
    check_signatures  = require
305
336
 
306
337
The authentication configuration file, authentication.conf
355
386
check_signatures
356
387
~~~~~~~~~~~~~~~~
357
388
 
358
 
Defines the behavior for signatures.
 
389
Reserved for future use.  These options will allow a policy for branches to
 
390
require signatures.
359
391
 
360
392
require
361
393
    The gnupg signature for revisions must be present and must be valid.
371
403
create_signatures
372
404
~~~~~~~~~~~~~~~~~
373
405
 
374
 
Defines the behaviour of signing revisions.
 
406
Defines the behaviour of signing revisions on commits.  By default bzr will not
 
407
sign new commits.
375
408
 
376
409
always
377
 
    Sign every new revision that is committed.
 
410
    Sign every new revision that is committed.  If the signing fails then the
 
411
    commit will not be made.
378
412
 
379
413
when-required
380
 
    (default) Sign newly committed revisions only when the branch requires
381
 
    signed revisions.
 
414
    Reserved for future use.
382
415
 
383
416
never
384
 
    Refuse to sign newly committed revisions, even if the branch
385
 
    requires signatures.
 
417
    Reserved for future use.
 
418
 
 
419
In future it is planned that ``when-required`` will sign newly
 
420
committed revisions only when the branch requires them.  ``never`` will refuse
 
421
to sign newly committed revisions, even if the branch requires signatures.
 
422
 
 
423
dirstate.fdatasync
 
424
~~~~~~~~~~~~~~~~~~
 
425
 
 
426
If true (default), working tree metadata changes are flushed through the
 
427
OS buffers to physical disk.  This is somewhat slower, but means data
 
428
should not be lost if the machine crashes.  See also repository.fdatasync.
386
429
 
387
430
recurse
388
431
~~~~~~~
431
474
These settings are only needed if the SMTP server requires authentication
432
475
to send mail.
433
476
 
 
477
locks.steal_dead
 
478
~~~~~~~~~~~~~~~~
 
479
 
 
480
If set to true, bzr will automatically break locks held by processes from
 
481
the same machine and user that are no longer alive.  Otherwise, it will
 
482
print a message and you can break the lock manually, if you are satisfied
 
483
the object is no longer in use.
 
484
 
434
485
mail_client
435
486
~~~~~~~~~~~
436
487
 
457
508
:mapi: Use your preferred e-mail client on Windows.
458
509
:xdg-email: Use xdg-email to run your preferred mail program
459
510
 
 
511
repository.fdatasync
 
512
~~~~~~~~~~~~~~~~~~~~
 
513
 
 
514
If true (default), repository changes are flushed through the OS buffers
 
515
to physical disk.  This is somewhat slower, but means data should not be
 
516
lost if the machine crashes.  See also dirstate.fdatasync.
 
517
 
460
518
submit_branch
461
519
~~~~~~~~~~~~~
462
520
 
482
540
    whether the format deprecation warning is shown on repositories that are
483
541
    using deprecated formats.
484
542
 
 
543
default_format
 
544
~~~~~~~~~~~~~~
 
545
 
 
546
A format name for the default format used when creating branches.  See ``bzr
 
547
help formats`` for possible values.
 
548
 
 
549
 
 
550
Unicode options
 
551
---------------
 
552
 
 
553
output_encoding
 
554
~~~~~~~~~~~~~~~
 
555
 
 
556
A Python unicode encoding name for text output from bzr, such as log
 
557
information.  Values include: utf8, cp850, ascii, iso-8859-1.  The default
 
558
is the terminal encoding prefered by the operating system.
 
559
 
485
560
 
486
561
Branch type specific options
487
562
----------------------------
504
579
parent_location
505
580
~~~~~~~~~~~~~~~
506
581
 
507
 
If present, the location of the default branch for pull or merge.
508
 
This option is normally set by ``pull --remember`` or ``merge
 
582
If present, the location of the default branch for pull or merge.  This option
 
583
is normally set when creating a branch, the first ``pull`` or by ``pull
509
584
--remember``.
510
585
 
511
586
push_location
512
587
~~~~~~~~~~~~~
513
588
 
514
589
If present, the location of the default branch for push.  This option
515
 
is normally set by ``push --remember``.
 
590
is normally set by the first ``push`` or ``push --remember``.
516
591
 
517
592
push_strict
518
593
~~~~~~~~~~~
545
620
If present, defines the ``--strict`` option default value for checking
546
621
uncommitted changes before sending a merge directive.
547
622
 
 
623
 
 
624
External Merge Tools
 
625
--------------------
 
626
 
 
627
bzr.mergetool.<name>
 
628
~~~~~~~~~~~~~~~~~~~~
 
629
 
 
630
Defines an external merge tool called <name> with the given command-line.
 
631
Arguments containing spaces should be quoted using single or double quotes. The
 
632
executable may omit its path if it can be found on the PATH.
 
633
 
 
634
The following markers can be used in the command-line to substitute filenames
 
635
involved in the merge conflict::
 
636
 
 
637
  {base}      file.BASE
 
638
  {this}      file.THIS
 
639
  {other}     file.OTHER
 
640
  {result}    output file
 
641
  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
 
642
              succeeds.
 
643
 
 
644
For example::
 
645
 
 
646
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
 
647
 
 
648
bzr.default_mergetool
 
649
~~~~~~~~~~~~~~~~~~~~~
 
650
 
 
651
Specifies which external merge tool (as defined above) should be selected by
 
652
default in tools such as ``bzr qconflicts``.
 
653
 
 
654
For example::
 
655
 
 
656
  bzr.default_mergetool = kdiff3