← 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: Andrew Bennetts
  • Date: 2010-07-29 11:17:57 UTC
  • mfrom: (5050.3.17 2.2)
  • mto: This revision was merged to the branch mainline in revision 5365.
  • Revision ID: andrew.bennetts@canonical.com-20100729111757-018h3pcefo7z0dnq
Merge lp:bzr/2.2 into lp:bzr.

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>
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}
 
259
    check_signatures = require
269
260
 
270
261
 
271
262
Variable policies
311
302
    [DEFAULT]
312
303
    email             = John Doe <jdoe@isp.com>
313
304
    editor            = /usr/bin/vim
 
305
    check_signatures  = check-available
314
306
    create_signatures = when-required
315
307
 
316
308
 
328
320
 
329
321
    [http://hypothetical.site.com/branches/devel-branch]
330
322
    create_signatures = always
 
323
    check_signatures  = always
 
324
 
 
325
    [http://bazaar-vcs.org/bzr/*]
 
326
    check_signatures  = require
331
327
 
332
328
The authentication configuration file, authentication.conf
333
329
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355
351
 
356
352
    debug_flags = hpss
357
353
 
358
 
or::
359
 
 
360
 
    debug_flags = hpss,evil
361
 
 
362
354
email
363
355
~~~~~
364
356
 
385
377
check_signatures
386
378
~~~~~~~~~~~~~~~~
387
379
 
388
 
Reserved for future use.  These options will allow a policy for branches to
389
 
require signatures.
 
380
Defines the behavior for signatures.
390
381
 
391
382
require
392
383
    The gnupg signature for revisions must be present and must be valid.
402
393
create_signatures
403
394
~~~~~~~~~~~~~~~~~
404
395
 
405
 
Defines the behaviour of signing revisions on commits.  By default bzr will not
406
 
sign new commits.
 
396
Defines the behaviour of signing revisions.
407
397
 
408
398
always
409
 
    Sign every new revision that is committed.  If the signing fails then the
410
 
    commit will not be made.
 
399
    Sign every new revision that is committed.
411
400
 
412
401
when-required
413
 
    Reserved for future use.
 
402
    (default) Sign newly committed revisions only when the branch requires
 
403
    signed revisions.
414
404
 
415
405
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``.
 
406
    Refuse to sign newly committed revisions, even if the branch
 
407
    requires signatures.
435
408
 
436
409
recurse
437
410
~~~~~~~
454
427
 
455
428
    gpg_signing_command = /usr/bin/gnpg
456
429
 
457
 
The specified command must accept the options "--clearsign" and "-u <email>".
458
 
 
459
430
bzr_remote_path
460
431
~~~~~~~~~~~~~~~
461
432
 
482
453
These settings are only needed if the SMTP server requires authentication
483
454
to send mail.
484
455
 
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
456
mail_client
494
457
~~~~~~~~~~~
495
458
 
516
479
:mapi: Use your preferred e-mail client on Windows.
517
480
:xdg-email: Use xdg-email to run your preferred mail program
518
481
 
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
482
submit_branch
527
483
~~~~~~~~~~~~~
528
484
 
548
504
    whether the format deprecation warning is shown on repositories that are
549
505
    using deprecated formats.
550
506
 
551
 
default_format
552
 
~~~~~~~~~~~~~~
553
 
 
554
 
A format name for the default format used when creating branches.  See ``bzr
555
 
help formats`` for possible values.
556
 
 
557
507
 
558
508
Unicode options
559
509
---------------
587
537
parent_location
588
538
~~~~~~~~~~~~~~~
589
539
 
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
 
540
If present, the location of the default branch for pull or merge.
 
541
This option is normally set by ``pull --remember`` or ``merge
592
542
--remember``.
593
543
 
594
544
push_location
595
545
~~~~~~~~~~~~~
596
546
 
597
547
If present, the location of the default branch for push.  This option
598
 
is normally set by the first ``push`` or ``push --remember``.
 
548
is normally set by ``push --remember``.
599
549
 
600
550
push_strict
601
551
~~~~~~~~~~~
628
578
If present, defines the ``--strict`` option default value for checking
629
579
uncommitted changes before sending a merge directive.
630
580
 
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
 
 
640
 
External Merge Tools
641
 
--------------------
642
 
 
643
 
bzr.mergetool.<name>
644
 
~~~~~~~~~~~~~~~~~~~~
645
 
 
646
 
Defines an external merge tool called <name> with the given command-line.
647
 
Arguments containing spaces should be quoted using single or double quotes. The
648
 
executable may omit its path if it can be found on the PATH.
649
 
 
650
 
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::
661
 
 
662
 
  bzr.mergetool.kdiff3 = kdiff3 {base} {this} {other} -o {result}
663
 
 
664
 
bzr.default_mergetool
665
 
~~~~~~~~~~~~~~~~~~~~~
666
 
 
667
 
Specifies which external merge tool (as defined above) should be selected by
668
 
default in tools such as ``bzr qconflicts``.
669
 
 
670
 
For example::
671
 
 
672
 
  bzr.default_mergetool = kdiff3