← 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

(gz) Fix test failure on alpha by correcting format string for
 gc_chk_sha1_record (Martin [gz])

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/en/configuration.txt
14
14
 
15
15
  "John Doe <jdoe@example.com>"
16
16
 
17
 
See also the ``email`` configuration option.
 
17
See also the ``email`` configuration value.
18
18
 
19
19
BZR_PROGRESS_BAR
20
20
~~~~~~~~~~~~~~~~
21
21
 
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.
 
22
Override the progress display.  Possible values are "none", "dots", "tty"
25
23
 
26
24
BZR_SIGQUIT_PDB
27
25
~~~~~~~~~~~~~~~
54
52
 
55
53
Path to the Bazaar executable to use when using the bzr+ssh protocol.
56
54
 
57
 
See also the ``bzr_remote_path`` configuration option.
 
55
See also the ``bzr_remote_path`` configuration value.
58
56
 
59
57
BZR_EDITOR
60
58
~~~~~~~~~~
258
256
variable name, an equals sign and a value.  For example::
259
257
 
260
258
    email            = John Doe <jdoe@isp.com>
261
 
    gpg_signing_key  = Amy Pond <amy@example.com>
 
259
    check_signatures = require
262
260
 
263
261
A variable can reference other variables **in the same configuration file** by
264
262
enclosing them in curly brackets::
311
309
    [DEFAULT]
312
310
    email             = John Doe <jdoe@isp.com>
313
311
    editor            = /usr/bin/vim
 
312
    check_signatures  = check-available
314
313
    create_signatures = when-required
315
314
 
316
315
 
328
327
 
329
328
    [http://hypothetical.site.com/branches/devel-branch]
330
329
    create_signatures = always
 
330
    check_signatures  = always
 
331
 
 
332
    [http://example.com/bzr/*]
 
333
    check_signatures  = require
331
334
 
332
335
The authentication configuration file, authentication.conf
333
336
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355
358
 
356
359
    debug_flags = hpss
357
360
 
358
 
or::
359
 
 
360
 
    debug_flags = hpss,evil
361
 
 
362
361
email
363
362
~~~~~
364
363
 
385
384
check_signatures
386
385
~~~~~~~~~~~~~~~~
387
386
 
388
 
Reserved for future use.  These options will allow a policy for branches to
389
 
require signatures.
 
387
Defines the behavior for signatures.
390
388
 
391
389
require
392
390
    The gnupg signature for revisions must be present and must be valid.
402
400
create_signatures
403
401
~~~~~~~~~~~~~~~~~
404
402
 
405
 
Defines the behaviour of signing revisions on commits.  By default bzr will not
406
 
sign new commits.
 
403
Defines the behaviour of signing revisions.
407
404
 
408
405
always
409
 
    Sign every new revision that is committed.  If the signing fails then the
410
 
    commit will not be made.
 
406
    Sign every new revision that is committed.
411
407
 
412
408
when-required
413
 
    Reserved for future use.
 
409
    (default) Sign newly committed revisions only when the branch requires
 
410
    signed revisions.
414
411
 
415
412
never
416
 
    Reserved for future use.
417
 
 
418
 
In future it is planned that ``when-required`` will sign newly
419
 
committed revisions only when the branch requires them.  ``never`` will refuse
420
 
to sign newly committed revisions, even if the branch requires signatures.
421
 
 
422
 
dirstate.fdatasync
423
 
~~~~~~~~~~~~~~~~~~
424
 
 
425
 
If true (default), working tree metadata changes are flushed through the
426
 
OS buffers to physical disk.  This is somewhat slower, but means data
427
 
should not be lost if the machine crashes.  See also repository.fdatasync.
428
 
 
429
 
gpg_signing_key
430
 
~~~~~~~~~~~~~~~
431
 
 
432
 
The GnuPG user identity to use when signing commits.  Can be an e-mail
433
 
address, key fingerprint or full key ID.  When unset or when set to
434
 
"default" Bazaar will use the user e-mail set with ``whoami``.
 
413
    Refuse to sign newly committed revisions, even if the branch
 
414
    requires signatures.
435
415
 
436
416
recurse
437
417
~~~~~~~
454
434
 
455
435
    gpg_signing_command = /usr/bin/gnpg
456
436
 
457
 
The specified command must accept the options "--clearsign" and "-u <email>".
458
 
 
459
437
bzr_remote_path
460
438
~~~~~~~~~~~~~~~
461
439
 
482
460
These settings are only needed if the SMTP server requires authentication
483
461
to send mail.
484
462
 
485
 
locks.steal_dead
486
 
~~~~~~~~~~~~~~~~
487
 
 
488
 
If set to true, bzr will automatically break locks held by processes from
489
 
the same machine and user that are no longer alive.  Otherwise, it will
490
 
print a message and you can break the lock manually, if you are satisfied
491
 
the object is no longer in use.
492
 
 
493
463
mail_client
494
464
~~~~~~~~~~~
495
465
 
516
486
:mapi: Use your preferred e-mail client on Windows.
517
487
:xdg-email: Use xdg-email to run your preferred mail program
518
488
 
519
 
repository.fdatasync
520
 
~~~~~~~~~~~~~~~~~~~~
521
 
 
522
 
If true (default), repository changes are flushed through the OS buffers
523
 
to physical disk.  This is somewhat slower, but means data should not be
524
 
lost if the machine crashes.  See also dirstate.fdatasync.
525
 
 
526
489
submit_branch
527
490
~~~~~~~~~~~~~
528
491
 
587
550
parent_location
588
551
~~~~~~~~~~~~~~~
589
552
 
590
 
If present, the location of the default branch for pull or merge.  This option
591
 
is normally set when creating a branch, the first ``pull`` or by ``pull
 
553
If present, the location of the default branch for pull or merge.
 
554
This option is normally set by ``pull --remember`` or ``merge
592
555
--remember``.
593
556
 
594
557
push_location
595
558
~~~~~~~~~~~~~
596
559
 
597
560
If present, the location of the default branch for push.  This option
598
 
is normally set by the first ``push`` or ``push --remember``.
 
561
is normally set by ``push --remember``.
599
562
 
600
563
push_strict
601
564
~~~~~~~~~~~
628
591
If present, defines the ``--strict`` option default value for checking
629
592
uncommitted changes before sending a merge directive.
630
593
 
631
 
add.maximum_file_size
632
 
~~~~~~~~~~~~~~~~~~~~~
633
 
 
634
 
Defines the maximum file size the command line "add" operation will allow
635
 
in recursive mode, with files larger than this value being skipped. You may 
636
 
specify this value as an integer (in which case it is interpreted as bytes), 
637
 
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0 
638
 
will disable skipping.
639
594
 
640
595
External Merge Tools
641
596
--------------------
648
603
executable may omit its path if it can be found on the PATH.
649
604
 
650
605
The following markers can be used in the command-line to substitute filenames
651
 
involved in the merge conflict::
652
 
 
653
 
  {base}      file.BASE
654
 
  {this}      file.THIS
655
 
  {other}     file.OTHER
656
 
  {result}    output file
657
 
  {this_temp} temp copy of file.THIS, used to overwrite output file if merge
658
 
              succeeds.
659
 
 
660
 
For example::
 
606
involved in the merge conflict:
 
607
 
 
608
{base}      file.BASE
 
609
{this}      file.THIS
 
610
{other}     file.OTHER
 
611
{result}    output file
 
612
{this_temp} temp copy of file.THIS, used to overwrite output file if merge
 
613
            succeeds.
 
614
 
 
615
For example:
661
616
 
662
617
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
663
618
 
664
619
bzr.default_mergetool
665
 
~~~~~~~~~~~~~~~~~~~~~
 
620
~~~~~~~~~~~~~~~~~
666
621
 
667
622
Specifies which external merge tool (as defined above) should be selected by
668
623
default in tools such as ``bzr qconflicts``.
669
624
 
670
 
For example::
 
625
For example:
671
626
 
672
627
  bzr.default_mergetool = kdiff3