← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/developers/revision-properties.txt

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-03 22:30:56 UTC
  • mfrom: (3644.2.13 index_builder_cleanup)
  • Revision ID: pqm@pqm.ubuntu.com-20080903223056-b108iytb38xkznci
(jam) Streamline BTreeBuilder.add_node et al to make btree creation
        faster.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/revision-properties.txt
28
28
At the moment, three standardized revision properties are recognized and used
29
29
by bzrlib:
30
30
 
31
 
 * ``authors`` - Authors of the change. This value is a "\\n" separated set
32
 
   of values in the same format as the committer-id. This property can be
33
 
   set by passing a list to the keyword argument ``authors`` of the function
 
31
 * ``author`` - Author of the change. This value is in the same format as
 
32
   the committer-id. This property can be set by passing keyword argument
 
33
   ``author`` to function ``MutableTree.commit``.
 
34
 * ``branch-nick`` - Nickname of the branch. It's either the directory name
 
35
   or manually set by ``bzr nick``. The value is set automatically in
34
36
   ``MutableTree.commit``.
35
 
 * ``author`` - Single author of the change. This property is deprecated in
36
 
   favour of ``authors``. It should no longer be set by any code, but will
37
 
   still be read. It is ignored if ``authors`` is set in the same revision.
38
 
 * ``branch-nick`` - Nickname of the branch. This can be specified by the user,
39
 
   but it defaults to the colocated branch name or the branch's directory name.
40
 
   The value is set automatically in ``MutableTree.commit``.
41
37
 * ``bugs`` - A list of bug URLs and their statuses. The list is separated
42
 
   by the new-line character (\\n) and each entry is in format
 
38
   by the new-line character (\n) and each entry is in format
43
39
   '<URL> <status>'. Currently, bzrlib uses only status 'fixed'. See
44
40
   `Bug Trackers`_ for more details about using this feature.
45
41
 
46
 
.. _Bug Trackers: ../en/user-guide/index.html#bug-trackers
 
42
.. _Bug Trackers: ../bug_trackers.htm