← 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: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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
 
31
 * ``authors`` - Authors of the change. This value is a "\n" separated set
32
32
   of values in the same format as the committer-id. This property can be
33
33
   set by passing a list to the keyword argument ``authors`` of the function
34
34
   ``MutableTree.commit``.
35
35
 * ``author`` - Single author of the change. This property is deprecated in
36
36
   favour of ``authors``. It should no longer be set by any code, but will
37
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``.
 
38
 * ``branch-nick`` - Nickname of the branch. It's either the directory name
 
39
   or manually set by ``bzr nick``. The value is set automatically in
 
40
   ``MutableTree.commit``.
41
41
 * ``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
 
42
   by the new-line character (\n) and each entry is in format
43
43
   '<URL> <status>'. Currently, bzrlib uses only status 'fixed'. See
44
44
   `Bug Trackers`_ for more details about using this feature.
45
45