← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/option.py

  • Committer: Jelmer Vernooij
  • Date: 2015-11-15 02:30:05 UTC
  • mto: This revision was merged to the branch mainline in revision 6609.
  • Revision ID: jelmer@jelmer.uk-20151115023005-fcfi763b5eu1ne2o
Fix auodoc_rstx when running with LANG=C.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/option.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
# TODO: For things like --diff-prefix, we want a way to customize the display
18
18
# of the option argument.
19
19
 
 
20
from __future__ import absolute_import
 
21
 
 
22
import optparse
20
23
import re
21
24
 
22
25
from bzrlib.lazy_import import lazy_import
23
26
lazy_import(globals(), """
24
 
import optparse
25
 
 
26
27
from bzrlib import (
27
28
    errors,
28
 
    log,
29
 
    registry,
30
29
    revisionspec,
31
 
    symbol_versioning,
 
30
    i18n,
32
31
    )
33
32
""")
34
 
from bzrlib.trace import warning
 
33
 
 
34
from bzrlib import (
 
35
    registry as _mod_registry,
 
36
    )
35
37
 
36
38
 
37
39
def _parse_revision_str(revstr):
41
43
    each revision specifier supplied.
42
44
 
43
45
    >>> _parse_revision_str('234')
44
 
    [<RevisionSpec_revno 234>]
 
46
    [<RevisionSpec_dwim 234>]
45
47
    >>> _parse_revision_str('234..567')
46
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 567>]
 
48
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 567>]
47
49
    >>> _parse_revision_str('..')
48
50
    [<RevisionSpec None>, <RevisionSpec None>]
49
51
    >>> _parse_revision_str('..234')
50
 
    [<RevisionSpec None>, <RevisionSpec_revno 234>]
 
52
    [<RevisionSpec None>, <RevisionSpec_dwim 234>]
51
53
    >>> _parse_revision_str('234..')
52
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>]
 
54
    [<RevisionSpec_dwim 234>, <RevisionSpec None>]
53
55
    >>> _parse_revision_str('234..456..789') # Maybe this should be an error
54
 
    [<RevisionSpec_revno 234>, <RevisionSpec_revno 456>, <RevisionSpec_revno 789>]
 
56
    [<RevisionSpec_dwim 234>, <RevisionSpec_dwim 456>, <RevisionSpec_dwim 789>]
55
57
    >>> _parse_revision_str('234....789') #Error ?
56
 
    [<RevisionSpec_revno 234>, <RevisionSpec None>, <RevisionSpec_revno 789>]
 
58
    [<RevisionSpec_dwim 234>, <RevisionSpec None>, <RevisionSpec_dwim 789>]
57
59
    >>> _parse_revision_str('revid:test@other.com-234234')
58
60
    [<RevisionSpec_revid revid:test@other.com-234234>]
59
61
    >>> _parse_revision_str('revid:test@other.com-234234..revid:test@other.com-234235')
60
62
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revid revid:test@other.com-234235>]
61
63
    >>> _parse_revision_str('revid:test@other.com-234234..23')
62
 
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_revno 23>]
 
64
    [<RevisionSpec_revid revid:test@other.com-234234>, <RevisionSpec_dwim 23>]
63
65
    >>> _parse_revision_str('date:2005-04-12')
64
66
    [<RevisionSpec_date date:2005-04-12>]
65
67
    >>> _parse_revision_str('date:2005-04-12 12:24:33')
69
71
    >>> _parse_revision_str('date:2005-04-12,12:24:33')
70
72
    [<RevisionSpec_date date:2005-04-12,12:24:33>]
71
73
    >>> _parse_revision_str('-5..23')
72
 
    [<RevisionSpec_revno -5>, <RevisionSpec_revno 23>]
 
74
    [<RevisionSpec_dwim -5>, <RevisionSpec_dwim 23>]
73
75
    >>> _parse_revision_str('-5')
74
 
    [<RevisionSpec_revno -5>]
 
76
    [<RevisionSpec_dwim -5>]
75
77
    >>> _parse_revision_str('123a')
76
 
    Traceback (most recent call last):
77
 
      ...
78
 
    NoSuchRevisionSpec: No namespace registered for string: '123a'
 
78
    [<RevisionSpec_dwim 123a>]
79
79
    >>> _parse_revision_str('abc')
80
 
    Traceback (most recent call last):
81
 
      ...
82
 
    NoSuchRevisionSpec: No namespace registered for string: 'abc'
 
80
    [<RevisionSpec_dwim abc>]
83
81
    >>> _parse_revision_str('branch:../branch2')
84
82
    [<RevisionSpec_branch branch:../branch2>]
85
83
    >>> _parse_revision_str('branch:../../branch2')
86
84
    [<RevisionSpec_branch branch:../../branch2>]
87
85
    >>> _parse_revision_str('branch:../../branch2..23')
88
 
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_revno 23>]
 
86
    [<RevisionSpec_branch branch:../../branch2>, <RevisionSpec_dwim 23>]
 
87
    >>> _parse_revision_str('branch:..\\\\branch2')
 
88
    [<RevisionSpec_branch branch:..\\branch2>]
 
89
    >>> _parse_revision_str('branch:..\\\\..\\\\branch2..23')
 
90
    [<RevisionSpec_branch branch:..\\..\\branch2>, <RevisionSpec_dwim 23>]
89
91
    """
90
92
    # TODO: Maybe move this into revisionspec.py
91
93
    revs = []
92
 
    # split on the first .. that is not followed by a / ?
93
 
    sep = re.compile("\\.\\.(?!/)")
 
94
    # split on .. that is not followed by a / or \
 
95
    sep = re.compile(r'\.\.(?![\\/])')
94
96
    for x in sep.split(revstr):
95
97
        revs.append(revisionspec.RevisionSpec.from_string(x or None))
96
98
    return revs
97
99
 
98
100
 
 
101
def _parse_change_str(revstr):
 
102
    """Parse the revision string and return a tuple with left-most
 
103
    parent of the revision.
 
104
 
 
105
    >>> _parse_change_str('123')
 
106
    (<RevisionSpec_before before:123>, <RevisionSpec_dwim 123>)
 
107
    >>> _parse_change_str('123..124')
 
108
    Traceback (most recent call last):
 
109
      ...
 
110
    RangeInChangeOption: Option --change does not accept revision ranges
 
111
    """
 
112
    revs = _parse_revision_str(revstr)
 
113
    if len(revs) > 1:
 
114
        raise errors.RangeInChangeOption()
 
115
    return (revisionspec.RevisionSpec.from_string('before:' + revstr),
 
116
            revs[0])
 
117
 
 
118
 
99
119
def _parse_merge_type(typestring):
100
120
    return get_merge_type(typestring)
101
121
 
115
135
 
116
136
class Option(object):
117
137
    """Description of a command line option
118
 
    
 
138
 
119
139
    :ivar _short_name: If this option has a single-letter name, this is it.
120
140
    Otherwise None.
121
141
    """
122
142
 
123
 
    # TODO: Some way to show in help a description of the option argument
 
143
    # The dictionary of standard options. These are always legal.
 
144
    STD_OPTIONS = {}
124
145
 
 
146
    # The dictionary of commonly used options. these are only legal
 
147
    # if a command explicitly references them by name in the list
 
148
    # of supported options.
125
149
    OPTIONS = {}
126
150
 
127
151
    def __init__(self, name, help='', type=None, argname=None,
128
 
                 short_name=None):
 
152
                 short_name=None, param_name=None, custom_callback=None,
 
153
                 hidden=False):
129
154
        """Make a new command option.
130
155
 
131
 
        name -- regular name of the command, used in the double-dash
132
 
            form and also as the parameter to the command's run() 
133
 
            method.
134
 
 
135
 
        help -- help message displayed in command help
136
 
 
137
 
        type -- function called to parse the option argument, or 
 
156
        :param name: regular name of the command, used in the double-dash
 
157
            form and also as the parameter to the command's run()
 
158
            method (unless param_name is specified).
 
159
 
 
160
        :param help: help message displayed in command help
 
161
 
 
162
        :param type: function called to parse the option argument, or
138
163
            None (default) if this option doesn't take an argument.
139
164
 
140
 
        argname -- name of option argument, if any
 
165
        :param argname: name of option argument, if any
 
166
 
 
167
        :param short_name: short option code for use with a single -, e.g.
 
168
            short_name="v" to enable parsing of -v.
 
169
 
 
170
        :param param_name: name of the parameter which will be passed to
 
171
            the command's run() method.
 
172
 
 
173
        :param custom_callback: a callback routine to be called after normal
 
174
            processing. The signature of the callback routine is
 
175
            (option, name, new_value, parser).
 
176
        :param hidden: If True, the option should be hidden in help and
 
177
            documentation.
141
178
        """
142
179
        self.name = name
143
180
        self.help = help
144
181
        self.type = type
145
182
        self._short_name = short_name
146
183
        if type is None:
147
 
            assert argname is None
 
184
            if argname:
 
185
                raise ValueError('argname not valid for booleans')
148
186
        elif argname is None:
149
187
            argname = 'ARG'
150
188
        self.argname = argname
 
189
        if param_name is None:
 
190
            self._param_name = self.name.replace('-', '_')
 
191
        else:
 
192
            self._param_name = param_name
 
193
        self.custom_callback = custom_callback
 
194
        self.hidden = hidden
151
195
 
152
196
    def short_name(self):
153
197
        if self._short_name:
154
198
            return self._short_name
155
 
        else:
156
 
            # remove this when SHORT_OPTIONS is removed
157
 
            # XXX: This is accessing a DeprecatedDict, so we call the super 
158
 
            # method to avoid warnings
159
 
            for (k, v) in dict.iteritems(Option.SHORT_OPTIONS):
160
 
                if v == self:
161
 
                    return k
162
199
 
163
200
    def set_short_name(self, short_name):
164
201
        self._short_name = short_name
174
211
        option_strings = ['--%s' % self.name]
175
212
        if short_name is not None:
176
213
            option_strings.append('-%s' % short_name)
 
214
        if self.hidden:
 
215
            help = optparse.SUPPRESS_HELP
 
216
        else:
 
217
            help = self.help
177
218
        optargfn = self.type
178
219
        if optargfn is None:
179
 
            parser.add_option(action='store_true', dest=self.name, 
180
 
                              help=self.help,
181
 
                              default=OptionParser.DEFAULT_VALUE,
 
220
            parser.add_option(action='callback',
 
221
                              callback=self._optparse_bool_callback,
 
222
                              callback_args=(True,),
 
223
                              help=help,
182
224
                              *option_strings)
183
225
            negation_strings = ['--%s' % self.get_negation_name()]
184
 
            parser.add_option(action='store_false', dest=self.name, 
 
226
            parser.add_option(action='callback',
 
227
                              callback=self._optparse_bool_callback,
 
228
                              callback_args=(False,),
185
229
                              help=optparse.SUPPRESS_HELP, *negation_strings)
186
230
        else:
187
 
            parser.add_option(action='callback', 
188
 
                              callback=self._optparse_callback, 
 
231
            parser.add_option(action='callback',
 
232
                              callback=self._optparse_callback,
189
233
                              type='string', metavar=self.argname.upper(),
190
 
                              help=self.help,
191
 
                              default=OptionParser.DEFAULT_VALUE, 
 
234
                              help=help,
 
235
                              default=OptionParser.DEFAULT_VALUE,
192
236
                              *option_strings)
193
237
 
 
238
    def _optparse_bool_callback(self, option, opt_str, value, parser, bool_v):
 
239
        setattr(parser.values, self._param_name, bool_v)
 
240
        if self.custom_callback is not None:
 
241
            self.custom_callback(option, self._param_name, bool_v, parser)
 
242
 
194
243
    def _optparse_callback(self, option, opt, value, parser):
195
 
        setattr(parser.values, self.name, self.type(value))
 
244
        v = self.type(value)
 
245
        setattr(parser.values, self._param_name, v)
 
246
        if self.custom_callback is not None:
 
247
            self.custom_callback(option, self.name, v, parser)
196
248
 
197
249
    def iter_switches(self):
198
250
        """Iterate through the list of switches provided by the option
199
 
        
 
251
 
200
252
        :return: an iterator of (name, short_name, argname, help)
201
253
        """
202
254
        argname =  self.argname
204
256
            argname = argname.upper()
205
257
        yield self.name, self.short_name(), argname, self.help
206
258
 
 
259
    def is_hidden(self, name):
 
260
        return self.hidden
 
261
 
 
262
 
 
263
class ListOption(Option):
 
264
    """Option used to provide a list of values.
 
265
 
 
266
    On the command line, arguments are specified by a repeated use of the
 
267
    option. '-' is a special argument that resets the list. For example,
 
268
      --foo=a --foo=b
 
269
    sets the value of the 'foo' option to ['a', 'b'], and
 
270
      --foo=a --foo=b --foo=- --foo=c
 
271
    sets the value of the 'foo' option to ['c'].
 
272
    """
 
273
 
 
274
    def add_option(self, parser, short_name):
 
275
        """Add this option to an Optparse parser."""
 
276
        option_strings = ['--%s' % self.name]
 
277
        if short_name is not None:
 
278
            option_strings.append('-%s' % short_name)
 
279
        parser.add_option(action='callback',
 
280
                          callback=self._optparse_callback,
 
281
                          type='string', metavar=self.argname.upper(),
 
282
                          help=self.help, dest=self._param_name, default=[],
 
283
                          *option_strings)
 
284
 
 
285
    def _optparse_callback(self, option, opt, value, parser):
 
286
        values = getattr(parser.values, self._param_name)
 
287
        if value == '-':
 
288
            del values[:]
 
289
        else:
 
290
            values.append(self.type(value))
 
291
        if self.custom_callback is not None:
 
292
            self.custom_callback(option, self._param_name, values, parser)
 
293
 
207
294
 
208
295
class RegistryOption(Option):
209
296
    """Option based on a registry
226
313
        else:
227
314
            return self.converter(value)
228
315
 
229
 
    def __init__(self, name, help, registry, converter=None,
230
 
        value_switches=False, title=None):
 
316
    def __init__(self, name, help, registry=None, converter=None,
 
317
        value_switches=False, title=None, enum_switch=True,
 
318
        lazy_registry=None, short_name=None, short_value_switches=None):
231
319
        """
232
320
        Constructor.
233
321
 
239
327
        :param value_switches: If true, each possible value is assigned its
240
328
            own switch.  For example, instead of '--format knit',
241
329
            '--knit' can be used interchangeably.
 
330
        :param enum_switch: If true, a switch is provided with the option name,
 
331
            which takes a value.
 
332
        :param lazy_registry: A tuple of (module name, attribute name) for a
 
333
            registry to be lazily loaded.
 
334
        :param short_name: The short name for the enum switch, if any
 
335
        :param short_value_switches: A dict mapping values to short names
242
336
        """
243
 
        Option.__init__(self, name, help, type=self.convert)
244
 
        self.registry = registry
 
337
        Option.__init__(self, name, help, type=self.convert,
 
338
                        short_name=short_name)
 
339
        self._registry = registry
 
340
        if registry is None:
 
341
            if lazy_registry is None:
 
342
                raise AssertionError(
 
343
                    'One of registry or lazy_registry must be given.')
 
344
            self._lazy_registry = _mod_registry._LazyObjectGetter(
 
345
                *lazy_registry)
 
346
        if registry is not None and lazy_registry is not None:
 
347
            raise AssertionError(
 
348
                'registry and lazy_registry are mutually exclusive')
245
349
        self.name = name
246
350
        self.converter = converter
247
351
        self.value_switches = value_switches
 
352
        self.enum_switch = enum_switch
 
353
        self.short_value_switches = short_value_switches
248
354
        self.title = title
249
355
        if self.title is None:
250
356
            self.title = name
251
357
 
 
358
    @property
 
359
    def registry(self):
 
360
        if self._registry is None:
 
361
            self._registry = self._lazy_registry.get_obj()
 
362
        return self._registry
 
363
 
 
364
    @staticmethod
 
365
    def from_kwargs(name_, help=None, title=None, value_switches=False,
 
366
                    enum_switch=True, **kwargs):
 
367
        """Convenience method to generate string-map registry options
 
368
 
 
369
        name, help, value_switches and enum_switch are passed to the
 
370
        RegistryOption constructor.  Any other keyword arguments are treated
 
371
        as values for the option, and their value is treated as the help.
 
372
        """
 
373
        reg = _mod_registry.Registry()
 
374
        for name, switch_help in sorted(kwargs.items()):
 
375
            name = name.replace('_', '-')
 
376
            reg.register(name, name, help=switch_help)
 
377
            if not value_switches:
 
378
                help = help + '  "' + name + '": ' + switch_help
 
379
                if not help.endswith("."):
 
380
                    help = help + "."
 
381
        return RegistryOption(name_, help, reg, title=title,
 
382
            value_switches=value_switches, enum_switch=enum_switch)
 
383
 
252
384
    def add_option(self, parser, short_name):
253
385
        """Add this option to an Optparse parser"""
254
386
        if self.value_switches:
255
387
            parser = parser.add_option_group(self.title)
256
 
        Option.add_option(self, parser, short_name)
 
388
        if self.enum_switch:
 
389
            Option.add_option(self, parser, short_name)
257
390
        if self.value_switches:
258
391
            for key in self.registry.keys():
259
392
                option_strings = ['--%s' % key]
 
393
                if self.is_hidden(key):
 
394
                    help = optparse.SUPPRESS_HELP
 
395
                else:
 
396
                    help = self.registry.get_help(key)
 
397
                if (self.short_value_switches and
 
398
                    key in self.short_value_switches):
 
399
                    option_strings.append('-%s' %
 
400
                                          self.short_value_switches[key])
260
401
                parser.add_option(action='callback',
261
402
                              callback=self._optparse_value_callback(key),
262
 
                                  help=self.registry.get_help(key),
 
403
                                  help=help,
263
404
                                  *option_strings)
264
405
 
265
406
    def _optparse_value_callback(self, cb_value):
266
407
        def cb(option, opt, value, parser):
267
 
            setattr(parser.values, self.name, self.type(cb_value))
 
408
            v = self.type(cb_value)
 
409
            setattr(parser.values, self._param_name, v)
 
410
            if self.custom_callback is not None:
 
411
                self.custom_callback(option, self._param_name, v, parser)
268
412
        return cb
269
413
 
270
414
    def iter_switches(self):
278
422
            for key in sorted(self.registry.keys()):
279
423
                yield key, None, None, self.registry.get_help(key)
280
424
 
 
425
    def is_hidden(self, name):
 
426
        if name == self.name:
 
427
            return Option.is_hidden(self, name)
 
428
        return getattr(self.registry.get_info(name), 'hidden', False)
 
429
 
281
430
 
282
431
class OptionParser(optparse.OptionParser):
283
432
    """OptionParser that raises exceptions instead of exiting"""
284
433
 
285
434
    DEFAULT_VALUE = object()
286
435
 
 
436
    def __init__(self):
 
437
        optparse.OptionParser.__init__(self)
 
438
        self.formatter = GettextIndentedHelpFormatter()
 
439
 
287
440
    def error(self, message):
288
441
        raise errors.BzrCommandError(message)
289
442
 
290
443
 
 
444
class GettextIndentedHelpFormatter(optparse.IndentedHelpFormatter):
 
445
    """Adds gettext() call to format_option()"""
 
446
    def __init__(self):
 
447
        optparse.IndentedHelpFormatter.__init__(self)
 
448
 
 
449
    def format_option(self, option):
 
450
        """code taken from Python's optparse.py"""
 
451
        if option.help:
 
452
            option.help = i18n.gettext(option.help)
 
453
        return optparse.IndentedHelpFormatter.format_option(self, option)
 
454
 
 
455
 
291
456
def get_optparser(options):
292
457
    """Generate an optparse parser for bzrlib-style options"""
293
458
 
298
463
    return parser
299
464
 
300
465
 
 
466
def custom_help(name, help):
 
467
    """Clone a common option overriding the help."""
 
468
    import copy
 
469
    o = copy.copy(Option.OPTIONS[name])
 
470
    o.help = help
 
471
    return o
 
472
 
 
473
 
 
474
def _standard_option(name, **kwargs):
 
475
    """Register a standard option."""
 
476
    # All standard options are implicitly 'global' ones
 
477
    Option.STD_OPTIONS[name] = Option(name, **kwargs)
 
478
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
 
479
 
 
480
def _standard_list_option(name, **kwargs):
 
481
    """Register a standard option."""
 
482
    # All standard options are implicitly 'global' ones
 
483
    Option.STD_OPTIONS[name] = ListOption(name, **kwargs)
 
484
    Option.OPTIONS[name] = Option.STD_OPTIONS[name]
 
485
 
 
486
 
301
487
def _global_option(name, **kwargs):
302
 
    """Register o as a global option."""
 
488
    """Register a global option."""
303
489
    Option.OPTIONS[name] = Option(name, **kwargs)
304
490
 
305
491
 
306
 
def _global_registry_option(name, help, registry, **kwargs):
 
492
def _global_registry_option(name, help, registry=None, **kwargs):
307
493
    Option.OPTIONS[name] = RegistryOption(name, help, registry, **kwargs)
308
494
 
309
495
 
310
 
class MergeTypeRegistry(registry.Registry):
311
 
 
312
 
    pass
313
 
 
314
 
 
315
 
_merge_type_registry = MergeTypeRegistry()
316
 
_merge_type_registry.register_lazy('merge3', 'bzrlib.merge', 'Merge3Merger',
317
 
                                   "Native diff3-style merge")
318
 
_merge_type_registry.register_lazy('diff3', 'bzrlib.merge', 'Diff3Merger',
319
 
                                   "Merge using external diff3")
320
 
_merge_type_registry.register_lazy('weave', 'bzrlib.merge', 'WeaveMerger',
321
 
                                   "Weave-based merge")
322
 
 
323
 
_global_option('all')
324
 
_global_option('overwrite', help='Ignore differences between branches and '
325
 
               'overwrite unconditionally')
326
 
_global_option('basis', type=str)
327
 
_global_option('bound')
328
 
_global_option('diff-options', type=str)
329
 
_global_option('help',
330
 
               help='show help message',
331
 
               short_name='h')
 
496
# This is the verbosity level detected during command line parsing.
 
497
# Note that the final value is dependent on the order in which the
 
498
# various flags (verbose, quiet, no-verbose, no-quiet) are given.
 
499
# The final value will be one of the following:
 
500
#
 
501
# * -ve for quiet
 
502
# * 0 for normal
 
503
# * +ve for verbose
 
504
_verbosity_level = 0
 
505
 
 
506
 
 
507
def _verbosity_level_callback(option, opt_str, value, parser):
 
508
    global _verbosity_level
 
509
    if not value:
 
510
        # Either --no-verbose or --no-quiet was specified
 
511
        _verbosity_level = 0
 
512
    elif opt_str == "verbose":
 
513
        if _verbosity_level > 0:
 
514
            _verbosity_level += 1
 
515
        else:
 
516
            _verbosity_level = 1
 
517
    else:
 
518
        if _verbosity_level < 0:
 
519
            _verbosity_level -= 1
 
520
        else:
 
521
            _verbosity_level = -1
 
522
 
 
523
 
 
524
# Declare the standard options
 
525
_standard_option('help', short_name='h',
 
526
                 help='Show help message.')
 
527
_standard_option('quiet', short_name='q',
 
528
                 help="Only display errors and warnings.",
 
529
                 custom_callback=_verbosity_level_callback)
 
530
_standard_option('usage',
 
531
                 help='Show usage message and options.')
 
532
_standard_option('verbose', short_name='v',
 
533
                 help='Display more information.',
 
534
                 custom_callback=_verbosity_level_callback)
 
535
 
 
536
# Declare commonly used options
 
537
_global_option('change',
 
538
               type=_parse_change_str,
 
539
               short_name='c',
 
540
               param_name='revision',
 
541
               help='Select changes introduced by the specified revision. See also "help revisionspec".')
 
542
_global_option('directory', short_name='d', type=unicode,
 
543
               help='Branch to operate on, instead of working directory.')
332
544
_global_option('file', type=unicode, short_name='F')
333
 
_global_option('force')
334
 
_global_option('format', type=unicode)
335
 
_global_option('forward')
 
545
_global_registry_option('log-format', "Use specified log format.",
 
546
                        lazy_registry=('bzrlib.log', 'log_formatter_registry'),
 
547
                        value_switches=True, title='Log format',
 
548
                        short_value_switches={'short': 'S'})
 
549
_global_registry_option('merge-type', 'Select a particular merge algorithm.',
 
550
                        lazy_registry=('bzrlib.merge', 'merge_type_registry'),
 
551
                        value_switches=True, title='Merge algorithm')
336
552
_global_option('message', type=unicode,
337
 
               short_name='m')
338
 
_global_option('no-recurse')
339
 
_global_option('profile',
340
 
               help='show performance profiling information')
 
553
               short_name='m',
 
554
               help='Message string.')
 
555
_global_option('null', short_name='0',
 
556
                 help='Use an ASCII NUL (\\0) separator rather than '
 
557
                      'a newline.')
 
558
_global_option('overwrite', help='Ignore differences between branches and '
 
559
               'overwrite unconditionally.')
 
560
_global_option('remember', help='Remember the specified location as a'
 
561
               ' default.')
 
562
_global_option('reprocess', help='Reprocess to reduce spurious conflicts.')
341
563
_global_option('revision',
342
564
               type=_parse_revision_str,
343
565
               short_name='r',
344
 
               help='See \'help revisionspec\' for details')
345
 
_global_option('show-ids', 
346
 
               help='show internal object ids')
347
 
_global_option('timezone', 
 
566
               help='See "help revisionspec" for details.')
 
567
_global_option('show-ids',
 
568
               help='Show internal object ids.')
 
569
_global_option('timezone',
348
570
               type=str,
349
 
               help='display timezone as local, original, or utc')
350
 
_global_option('unbound')
351
 
_global_option('verbose',
352
 
               help='display more information',
353
 
               short_name='v')
354
 
_global_option('version')
355
 
_global_option('email')
356
 
_global_option('update')
357
 
_global_registry_option('log-format', "Use this log format",
358
 
                        log.log_formatter_registry, value_switches=True,
359
 
                        title='Log format')
360
 
_global_option('long', help='Use detailed log format. Same as --log-format long',
361
 
               short_name='l')
362
 
_global_option('short', help='Use moderately short log format. Same as --log-format short')
363
 
_global_option('line', help='Use log format with one line per revision. Same as --log-format line')
364
 
_global_option('root', type=str)
365
 
_global_option('no-backup')
366
 
_global_registry_option('merge-type', 'Select a particular merge algorithm',
367
 
                        _merge_type_registry, value_switches=True,
368
 
                        title='Merge algorithm')
369
 
_global_option('pattern', type=str)
370
 
_global_option('quiet', short_name='q')
371
 
_global_option('remember', help='Remember the specified location as a'
372
 
               ' default.')
373
 
_global_option('reprocess', help='Reprocess to reduce spurious conflicts')
374
 
_global_option('kind', type=str)
375
 
_global_option('dry-run',
376
 
               help="show what would be done, but don't actually do anything")
377
 
_global_option('name-from-revision', help='The path name in the old tree.')
378
 
 
379
 
 
380
 
# prior to 0.14 these were always globally registered; the old dict is
381
 
# available for plugins that use it but it should not be used.
382
 
Option.SHORT_OPTIONS = symbol_versioning.DeprecatedDict(
383
 
    symbol_versioning.zero_fourteen,
384
 
    'SHORT_OPTIONS',
385
 
    {
386
 
        'F': Option.OPTIONS['file'],
387
 
        'h': Option.OPTIONS['help'],
388
 
        'm': Option.OPTIONS['message'],
389
 
        'r': Option.OPTIONS['revision'],
390
 
        'v': Option.OPTIONS['verbose'],
391
 
        'l': Option.OPTIONS['long'],
392
 
        'q': Option.OPTIONS['quiet'],
393
 
    },
394
 
    'Set the short option name when constructing the Option.',
395
 
    )
 
571
               help='Display timezone as local, original, or utc.')
 
572
 
 
573
diff_writer_registry = _mod_registry.Registry()
 
574
diff_writer_registry.register('plain', lambda x: x, 'Plaintext diff output.')
 
575
diff_writer_registry.default_key = 'plain'