← 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: Canonical.com Patch Queue Manager
  • Date: 2008-04-07 07:52:50 UTC
  • mfrom: (3340.1.1 208418-1.4)
  • Revision ID: pqm@pqm.ubuntu.com-20080407075250-phs53xnslo8boaeo
Return the correct knit serialisation method in _StreamAccess.
        (Andrew Bennetts, Martin Pool, Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/cmd_version_info.py
21
21
from bzrlib import (
22
22
    branch,
23
23
    errors,
24
 
    version_info_formats,
25
24
    workingtree,
26
25
    )
27
26
""")
 
27
from bzrlib import (
 
28
    version_info_formats,
 
29
    )
28
30
from bzrlib.commands import Command
29
 
from bzrlib.option import Option
 
31
from bzrlib.option import Option, RegistryOption
30
32
 
31
33
 
32
34
def _parse_version_info_format(format):
45
47
 
46
48
 
47
49
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'),
52
 
                     Option('all', help='include all possible information'),
53
 
                     Option('check-clean', help='check if tree is clean'),
 
50
    """Show version information about this tree.
 
51
 
 
52
    You can use this command to add information about version into
 
53
    source code of an application. The output can be in one of the
 
54
    supported formats or in a custom format based on a template.
 
55
 
 
56
    For example::
 
57
 
 
58
      bzr version-info --custom \\
 
59
        --template="#define VERSION_INFO \\"Project 1.2.3 (r{revno})\\"\\n"
 
60
 
 
61
    will produce a C header file with formatted string containing the
 
62
    current revision number. Other supported variables in templates are:
 
63
 
 
64
      * {date} - date of the last revision
 
65
      * {build_date} - current date
 
66
      * {revno} - revision number
 
67
      * {revision_id} - revision id
 
68
      * {branch_nick} - branch nickname
 
69
      * {clean} - 0 if the source tree contains uncommitted changes,
 
70
                  otherwise 1
 
71
    """
 
72
 
 
73
    takes_options = [RegistryOption('format',
 
74
                            'Select the output format.',
 
75
                            version_info_formats.format_registry,
 
76
                            value_switches=True),
 
77
                     Option('all', help='Include all possible information.'),
 
78
                     Option('check-clean', help='Check if tree is clean.'),
54
79
                     Option('include-history',
55
 
                            help='Include the revision-history'),
 
80
                            help='Include the revision-history.'),
56
81
                     Option('include-file-revisions',
57
 
                            help='Include the last revision for each file')
 
82
                            help='Include the last revision for each file.'),
 
83
                     Option('template', type=str, help='Template for the output.'),
58
84
                     ]
59
85
    takes_args = ['location?']
60
86
 
62
88
 
63
89
    def run(self, location=None, format=None,
64
90
            all=False, check_clean=False, include_history=False,
65
 
            include_file_revisions=False):
 
91
            include_file_revisions=False, template=None):
66
92
 
67
93
        if location is None:
68
94
            location = '.'
69
95
 
70
96
        if format is None:
71
 
            format = version_info_formats.get_builder(None)
 
97
            format = version_info_formats.format_registry.get()
72
98
 
73
99
        wt = None
74
100
        try:
78
104
        else:
79
105
            b = wt.branch
80
106
 
81
 
        if all:
 
107
        if all or template:
82
108
            include_history = True
83
109
            check_clean = True
84
110
            include_file_revisions=True
86
112
        builder = format(b, working_tree=wt,
87
113
                check_for_clean=check_clean,
88
114
                include_revision_history=include_history,
89
 
                include_file_revisions=include_file_revisions)
 
115
                include_file_revisions=include_file_revisions,
 
116
                template=template)
90
117
        builder.generate(self.outf)