/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2011 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
# TODO: Some way to get a list of external commands (defined by shell
20
18
# scripts) so that they can be included in the help listing as well.
21
19
# It should be enough to just list the plugin directory and look for
23
21
 
24
22
# TODO: `help commands --all` should show hidden commands
25
23
 
26
 
from . import (
 
24
import sys
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
27
28
    commands as _mod_commands,
28
29
    errors,
29
30
    help_topics,
30
31
    osutils,
31
32
    plugin,
32
 
    ui,
33
 
    utextwrap,
34
33
    )
35
34
 
36
35
 
37
 
class NoHelpTopic(errors.BzrError):
38
 
 
39
 
    _fmt = ("No help could be found for '%(topic)s'. "
40
 
            "Please use 'brz help topics' to obtain a list of topics.")
41
 
 
42
 
    def __init__(self, topic):
43
 
        self.topic = topic
44
 
 
45
 
 
46
36
def help(topic=None, outfile=None):
47
37
    """Write the help for the specific topic to outfile"""
48
38
    if outfile is None:
49
 
        outfile = ui.ui_factory.make_output_stream()
 
39
        outfile = sys.stdout
50
40
 
51
41
    indices = HelpIndices()
52
42
 
56
46
        shadowed_terms = []
57
47
        for index, topic_obj in topics[1:]:
58
48
            shadowed_terms.append('%s%s' % (index.prefix,
59
 
                                            topic_obj.get_help_topic()))
 
49
                topic_obj.get_help_topic()))
60
50
        source = topics[0][1]
61
51
        outfile.write(source.get_help_text(shadowed_terms))
62
 
    except NoHelpTopic:
 
52
    except errors.NoHelpTopic:
63
53
        if alias is None:
64
54
            raise
65
55
 
66
56
    if alias is not None:
67
 
        outfile.write("'brz %s' is an alias for 'brz %s'.\n" % (topic,
68
 
                                                                " ".join(alias)))
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
58
            " ".join(alias)))
69
59
 
70
60
 
71
61
def help_commands(outfile=None):
72
62
    """List all commands"""
73
63
    if outfile is None:
74
 
        outfile = ui.ui_factory.make_output_stream()
 
64
        outfile = sys.stdout
75
65
    outfile.write(_help_commands_to_text('commands'))
76
66
 
77
67
 
106
96
        else:
107
97
            firstline = ''
108
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
109
 
        lines = utextwrap.wrap(
 
99
        lines = textwrap.wrap(
110
100
            helpstring, subsequent_indent=indent,
111
101
            width=width,
112
102
            break_long_words=False)
145
135
            help_topics.HelpTopicIndex(),
146
136
            _mod_commands.HelpCommandIndex(),
147
137
            plugin.PluginsHelpIndex(),
148
 
            help_topics.ConfigOptionHelpIndex(),
149
138
            ]
150
139
 
151
140
    def _check_prefix_uniqueness(self):
152
141
        """Ensure that the index collection is able to differentiate safely."""
153
 
        prefixes = set()
 
142
        prefixes = {}
154
143
        for index in self.search_path:
155
 
            prefix = index.prefix
156
 
            if prefix in prefixes:
 
144
            prefixes.setdefault(index.prefix, []).append(index)
 
145
        for prefix, indices in prefixes.items():
 
146
            if len(indices) > 1:
157
147
                raise errors.DuplicateHelpPrefix(prefix)
158
 
            prefixes.add(prefix)
159
148
 
160
149
    def search(self, topic):
161
150
        """Search for topic across the help search path.
167
156
        self._check_prefix_uniqueness()
168
157
        result = []
169
158
        for index in self.search_path:
170
 
            result.extend([(index, _topic)
171
 
                           for _topic in index.get_topics(topic)])
 
159
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
172
160
        if not result:
173
 
            raise NoHelpTopic(topic)
 
161
            raise errors.NoHelpTopic(topic)
174
162
        else:
175
163
            return result