← 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: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

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
 
 * ``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
 
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
36
34
   ``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``.
37
41
 * ``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
 
42
   by the new-line character (\\n) and each entry is in format
39
43
   '<URL> <status>'. Currently, bzrlib uses only status 'fixed'. See
40
44
   `Bug Trackers`_ for more details about using this feature.
41
45
 
42
 
.. _Bug Trackers: ../bug_trackers.htm
 
46
.. _Bug Trackers: ../en/user-guide/index.html#bug-trackers