← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/cmd_version_info.py

  • Committer: Robert Collins
  • Date: 2009-07-07 04:32:13 UTC
  • mto: This revision was merged to the branch mainline in revision 4524.
  • Revision ID: robertc@robertcollins.net-20090707043213-4hjjhgr40iq7gk2d
More informative assertions in xml serialisation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""Commands for generating snapshot information about a bzr tree."""
18
18
 
21
21
from bzrlib import (
22
22
    branch,
23
23
    errors,
 
24
    workingtree,
24
25
    version_info_formats,
25
 
    workingtree,
26
26
    )
27
27
""")
28
28
from bzrlib.commands import Command
29
 
from bzrlib.option import Option
 
29
from bzrlib.option import Option, RegistryOption
30
30
 
31
31
 
32
32
def _parse_version_info_format(format):
45
45
 
46
46
 
47
47
class cmd_version_info(Command):
48
 
    """Show version information about this tree."""
49
 
 
50
 
    takes_options = [Option('format', type=_parse_version_info_format,
51
 
                            help='Select the output format.'),
 
48
    """Show version information about this tree.
 
49
 
 
50
    You can use this command to add information about version into
 
51
    source code of an application. The output can be in one of the
 
52
    supported formats or in a custom format based on a template.
 
53
 
 
54
    For example::
 
55
 
 
56
      bzr version-info --custom \\
 
57
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
 
58
 
 
59
    will produce a C header file with formatted string containing the
 
60
    current revision number. Other supported variables in templates are:
 
61
 
 
62
      * {date} - date of the last revision
 
63
      * {build_date} - current date
 
64
      * {revno} - revision number
 
65
      * {revision_id} - revision id
 
66
      * {branch_nick} - branch nickname
 
67
      * {clean} - 0 if the source tree contains uncommitted changes,
 
68
                  otherwise 1
 
69
    """
 
70
 
 
71
    takes_options = [RegistryOption('format',
 
72
                            'Select the output format.',
 
73
                            value_switches=True,
 
74
                            lazy_registry=('bzrlib.version_info_formats',
 
75
                                           'format_registry')),
52
76
                     Option('all', help='Include all possible information.'),
53
77
                     Option('check-clean', help='Check if tree is clean.'),
54
78
                     Option('include-history',
55
79
                            help='Include the revision-history.'),
56
80
                     Option('include-file-revisions',
57
 
                            help='Include the last revision for each file.')
 
81
                            help='Include the last revision for each file.'),
 
82
                     Option('template', type=str, help='Template for the output.'),
58
83
                     ]
59
84
    takes_args = ['location?']
60
85
 
62
87
 
63
88
    def run(self, location=None, format=None,
64
89
            all=False, check_clean=False, include_history=False,
65
 
            include_file_revisions=False):
 
90
            include_file_revisions=False, template=None):
66
91
 
67
92
        if location is None:
68
93
            location = '.'
69
94
 
70
95
        if format is None:
71
 
            format = version_info_formats.get_builder(None)
 
96
            format = version_info_formats.format_registry.get()
72
97
 
73
98
        wt = None
74
99
        try:
78
103
        else:
79
104
            b = wt.branch
80
105
 
81
 
        if all:
 
106
        if all or template:
82
107
            include_history = True
83
108
            check_clean = True
84
109
            include_file_revisions=True
86
111
        builder = format(b, working_tree=wt,
87
112
                check_for_clean=check_clean,
88
113
                include_revision_history=include_history,
89
 
                include_file_revisions=include_file_revisions)
 
114
                include_file_revisions=include_file_revisions,
 
115
                template=template)
90
116
        builder.generate(self.outf)