~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/en/configuration.txt

  • Committer: Samuel Bronson
  • Date: 2012-08-30 20:36:18 UTC
  • mto: (6015.57.3 2.4)
  • mto: This revision was merged to the branch mainline in revision 6558.
  • Revision ID: naesten@gmail.com-20120830203618-y2dzw91nqpvpgxvx
Update INSTALL for switch to Python 2.6 and up.

Show diffs side-by-side

added added

removed removed

Lines of Context:
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
~~~~~~~~~~~~~~~~
54
54
 
55
55
Path to the Bazaar executable to use when using the bzr+ssh protocol.
56
56
 
57
 
See also the ``bzr_remote_path`` configuration option.
 
57
See also the ``bzr_remote_path`` configuration value.
58
58
 
59
59
BZR_EDITOR
60
60
~~~~~~~~~~
221
221
~~~~~~~~~~~~~~
222
222
 
223
223
An ini file has three types of contructs: section headers, section
224
 
options and comments.
 
224
variables and comments.
225
225
 
226
226
Comments
227
227
^^^^^^^^
240
240
 
241
241
The only valid section headers for bazaar.conf currently are [DEFAULT] and
242
242
[ALIASES].  Section headers are case sensitive. The default section provides for
243
 
setting options which can be overridden with the branch config file.
 
243
setting variables which can be overridden with the branch config file.
244
244
 
245
 
For ``locations.conf``, the options from the section with the
 
245
For ``locations.conf``, the variables from the section with the
246
246
longest matching section header are used to the exclusion of other
247
247
potentially valid section headers. A section header uses the path for
248
248
the branch as the section header. Some examples include::
251
251
    [/home/jdoe/branches/]
252
252
 
253
253
 
254
 
Section options
255
 
^^^^^^^^^^^^^^^
 
254
Section variables
 
255
^^^^^^^^^^^^^^^^^
256
256
 
257
 
A section option resides within a section. A section option contains an
258
 
option name, an equals sign and a value.  For example::
 
257
A section variable resides within a section. A section variable contains a
 
258
variable name, an equals sign and a value.  For example::
259
259
 
260
260
    email            = John Doe <jdoe@isp.com>
261
 
    gpg_signing_key  = Amy Pond <amy@example.com>
 
261
    check_signatures = require
262
262
 
263
 
A option can reference other options by enclosing them in curly brackets::
 
263
A variable can reference other variables **in the same configuration file** by
 
264
enclosing them in curly brackets::
264
265
 
265
266
    my_branch_name = feature_x
266
267
    my_server      = bzr+ssh://example.com
267
268
    push_location   = {my_server}/project/{my_branch_name}
268
269
 
269
 
Option policies
270
 
^^^^^^^^^^^^^^^
271
 
 
272
 
Options defined in a section affect the named directory or URL plus
273
 
any locations they contain.  Policies can be used to change how an
274
 
option value is interpreted for contained locations.  Currently
 
270
 
 
271
Variable policies
 
272
^^^^^^^^^^^^^^^^^
 
273
 
 
274
Variables defined in a section affect the named directory or URL plus
 
275
any locations they contain.  Policies can be used to change how a
 
276
variable value is interpreted for contained locations.  Currently
275
277
there are three policies available:
276
278
 
277
279
 none:
284
286
   for contained locations, any additional path components are
285
287
   appended to the value.
286
288
 
287
 
Policies are specified by keys with names of the form "<option_name>:policy".
 
289
Policies are specified by keys with names of the form "$var:policy".
288
290
For example, to define the push location for a tree of branches, the
289
291
following could be used::
290
292
 
295
297
With this configuration, the push location for ``/top/location/branch1``
296
298
would be ``sftp://example.com/location/branch1``.
297
299
 
298
 
Section local options
299
 
^^^^^^^^^^^^^^^^^^^^^
300
 
 
301
 
Some options are defined automatically inside a given section and can be
302
 
refered to in this section only. 
303
 
 
304
 
For example, the ``appendpath`` policy can be used like this::
305
 
 
306
 
  [/home/vila/src/bzr/bugs]
307
 
  mypush = lp:~vila/bzr
308
 
  mypush:policy=appendpath
309
 
 
310
 
Using ``relpath`` to achieve the same result is done like this::
311
 
 
312
 
  [/home/vila/src/bzr/bugs]
313
 
  mypush = lp:~vila/bzr/{relpath}
314
 
 
315
 
In both cases, when used in a directory like
316
 
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
317
 
 
318
 
   $ bzr config mypush
319
 
   lp:~vila/bzr/832013-expand-in-stack
320
 
 
321
 
Another such option is ``basename`` which can be used like this::
322
 
 
323
 
  [/home/vila/src/bzr]
324
 
  mypush = lp:~vila/bzr/{basename}
325
 
 
326
 
When used in a directory like
327
 
``/home/vila/src/bzr/bugs/832013-expand-in-stack`` we'll get::
328
 
 
329
 
   $ bzr config mypush
330
 
   lp:~vila/bzr/832013-expand-in-stack
331
 
 
332
 
Note that ``basename`` here refers to the base name of ``relpath`` which
333
 
itself is defined as the relative path between the section name and the
334
 
location it matches.
335
 
 
336
 
When an option is local to a Section, it cannot be referred to from option
337
 
values in any other section from the same ``Store`` nor from any other
338
 
``Store``.
339
 
 
340
300
 
341
301
The main configuration file, bazaar.conf
342
302
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
351
311
    [DEFAULT]
352
312
    email             = John Doe <jdoe@isp.com>
353
313
    editor            = /usr/bin/vim
 
314
    check_signatures  = check-available
354
315
    create_signatures = when-required
355
316
 
356
317
 
368
329
 
369
330
    [http://hypothetical.site.com/branches/devel-branch]
370
331
    create_signatures = always
 
332
    check_signatures  = always
 
333
 
 
334
    [http://example.com/bzr/*]
 
335
    check_signatures  = require
371
336
 
372
337
The authentication configuration file, authentication.conf
373
338
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
377
342
of bzr that requires authentication (smtp for example).
378
343
 
379
344
The syntax of the file obeys the same rules as the others except for the
380
 
option policies which don't apply.
 
345
variable policies which don't apply.
381
346
 
382
347
For more information on the possible uses of the authentication configuration
383
348
file see :doc:`authentication-help`.
384
349
 
385
350
 
386
 
Common options
387
 
--------------
 
351
Common variable options
 
352
-----------------------
388
353
 
389
354
debug_flags
390
355
~~~~~~~~~~~
395
360
 
396
361
    debug_flags = hpss
397
362
 
398
 
or::
399
 
 
400
 
    debug_flags = hpss,evil
401
 
 
402
363
email
403
364
~~~~~
404
365
 
466
427
OS buffers to physical disk.  This is somewhat slower, but means data
467
428
should not be lost if the machine crashes.  See also repository.fdatasync.
468
429
 
469
 
gpg_signing_key
470
 
~~~~~~~~~~~~~~~
471
 
 
472
 
The GnuPG user identity to use when signing commits.  Can be an e-mail
473
 
address, key fingerprint or full key ID.  When unset or when set to
474
 
"default" Bazaar will use the user e-mail set with ``whoami``.
475
 
 
476
430
recurse
477
431
~~~~~~~
478
432
 
494
448
 
495
449
    gpg_signing_command = /usr/bin/gnpg
496
450
 
497
 
The specified command must accept the options "--clearsign" and "-u <email>".
498
 
 
499
451
bzr_remote_path
500
452
~~~~~~~~~~~~~~~
501
453
 
668
620
If present, defines the ``--strict`` option default value for checking
669
621
uncommitted changes before sending a merge directive.
670
622
 
671
 
add.maximum_file_size
672
 
~~~~~~~~~~~~~~~~~~~~~
673
 
 
674
 
Defines the maximum file size the command line "add" operation will allow
675
 
in recursive mode, with files larger than this value being skipped. You may 
676
 
specify this value as an integer (in which case it is interpreted as bytes), 
677
 
or you may specify the value using SI units, i.e. 10KB, 20MB, 1G. A value of 0 
678
 
will disable skipping.
679
623
 
680
624
External Merge Tools
681
625
--------------------