← 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: Martin Pool
  • Date: 2005-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/developers/revision-properties.txt
1
 
Revision Properties
2
 
===================
3
 
 
4
 
Bazaar repositories support setting of a key/value pairs for each revision.
5
 
Applications can use these properties to store additional information
6
 
about the revision.
7
 
 
8
 
Usage
9
 
-----
10
 
 
11
 
In general, revision properties are set by passing keyword argument
12
 
``revprops`` to method ``MutableTree.commit``. For example::
13
 
 
14
 
 properties = {}
15
 
 properties['my-property'] = 'test'
16
 
 tree.commit(message, revprops=properties)
17
 
 
18
 
Properties can be retrieved via the attribute ``properties`` of
19
 
instances of the class ``Revision``::
20
 
 
21
 
 if 'my-property' in revision.properties:
22
 
     my_property = revision.properties['my-property']
23
 
     ...
24
 
 
25
 
Well-known properties
26
 
---------------------
27
 
 
28
 
At the moment, three standardized revision properties are recognized and used
29
 
by bzrlib:
30
 
 
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
36
 
   ``MutableTree.commit``.
37
 
 * ``bugs`` - A list of bug URLs and their statuses. The list is separated
38
 
   by the new-line character (\n) and each entry is in format
39
 
   '<URL> <status>'. Currently, bzrlib uses only status 'fixed'. See
40
 
   `Bug Trackers`_ for more details about using this feature.
41
 
 
42
 
.. _Bug Trackers: ../bug_trackers.htm