/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: Daniel Watkins
  • Date: 2007-08-23 10:33:45 UTC
  • mto: (2762.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2763.
  • Revision ID: d.m.watkins@warwick.ac.uk-20070823103345-3fwlsg33a2i622b7
Cleaned up indentation in test.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
# TODO: Some way to get a list of external commands (defined by shell
18
18
# scripts) so that they can be included in the help listing as well.
30
30
    help_topics,
31
31
    osutils,
32
32
    plugin,
 
33
    symbol_versioning,
33
34
    )
34
35
 
35
36
 
45
46
        topics = indices.search(topic)
46
47
        shadowed_terms = []
47
48
        for index, topic in topics[1:]:
48
 
            shadowed_terms.append('%s%s' % (index.prefix,
49
 
                topic.get_help_topic()))
50
 
        source = topics[0][1]
51
 
        outfile.write(source.get_help_text(shadowed_terms))
 
49
            shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
 
50
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
52
51
    except errors.NoHelpTopic:
53
52
        if alias is None:
54
53
            raise
55
54
 
56
55
    if alias is not None:
57
 
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
58
 
            " ".join(alias)))
 
56
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic, " ".join(alias)))
59
57
 
60
58
 
61
59
def help_commands(outfile=None):
65
63
    outfile.write(_help_commands_to_text('commands'))
66
64
 
67
65
 
 
66
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
67
def command_usage(cmd):
 
68
    return cmd._usage()
 
69
 
 
70
 
68
71
def _help_commands_to_text(topic):
69
72
    """Generate the help text for the list of commands"""
70
73
    out = []
72
75
        hidden = True
73
76
    else:
74
77
        hidden = False
75
 
    names = list(_mod_commands.all_command_names())
 
78
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
79
    names.update(_mod_commands.plugin_command_names())
76
80
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
77
81
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
78
82
    max_name = max(len(n) for n, o in shown_commands)
79
83
    indent = ' ' * (max_name + 1)
80
 
    width = osutils.terminal_width()
81
 
    if width is None:
82
 
        width = osutils.default_terminal_width
83
 
    # we need one extra space for terminals that wrap on last char
84
 
    width = width - 1
 
84
    width = osutils.terminal_width() - 1
85
85
 
86
86
    for cmd_name, cmd_object in sorted(shown_commands):
87
87
        plugin_name = cmd_object.plugin_name()
96
96
        else:
97
97
            firstline = ''
98
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
99
 
        lines = textwrap.wrap(
100
 
            helpstring, subsequent_indent=indent,
101
 
            width=width,
102
 
            break_long_words=False)
 
99
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
100
                              width=width)
103
101
        for line in lines:
104
102
            out.append(line + '\n')
105
103
    return ''.join(out)
117
115
 
118
116
class HelpIndices(object):
119
117
    """Maintainer of help topics across multiple indices.
120
 
 
 
118
    
121
119
    It is currently separate to the HelpTopicRegistry because of its ordered
122
120
    nature, but possibly we should instead structure it as a search within the
123
121
    registry and add ordering and searching facilities to the registry. The
148
146
 
149
147
    def search(self, topic):
150
148
        """Search for topic across the help search path.
151
 
 
 
149
        
152
150
        :param topic: A string naming the help topic to search for.
153
151
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
154
152
        :return: A list of HelpTopics which matched 'topic'.