← 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: James Westby
  • Date: 2008-02-25 23:41:06 UTC
  • mto: This revision was merged to the branch mainline in revision 3246.
  • Revision ID: jw+debian@jameswestby.net-20080225234106-9b4ql42w13ijewp3
Make version-info --custom imply --all.

When using a custom template you can use variables like {clean} which
are not enabled by default. This causes an ugly traceback.

This fixes the issue by implying --all when --custom (or more exactly
--template) is used, so that all variables are available in templates.

This was the easier fix than having the template code report that the
user should pass --check-clean to have {clean} available, but will
have a performance impact on all users of version-info --custom,
regardless of whether they use {clean}.

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
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.
 
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``.
38
34
 * ``branch-nick`` - Nickname of the branch. It's either the directory name
39
35
   or manually set by ``bzr nick``. The value is set automatically in
40
36
   ``MutableTree.commit``.
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