← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.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: 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,
34
33
    )
35
34
 
36
35
 
45
44
    try:
46
45
        topics = indices.search(topic)
47
46
        shadowed_terms = []
48
 
        for index, topic in topics[1:]:
 
47
        for index, topic_obj in topics[1:]:
49
48
            shadowed_terms.append('%s%s' % (index.prefix,
50
 
                topic.get_help_topic()))
51
 
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
49
                topic_obj.get_help_topic()))
 
50
        source = topics[0][1]
 
51
        outfile.write(source.get_help_text(shadowed_terms))
52
52
    except errors.NoHelpTopic:
53
53
        if alias is None:
54
54
            raise
65
65
    outfile.write(_help_commands_to_text('commands'))
66
66
 
67
67
 
68
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
69
 
def command_usage(cmd):
70
 
    return cmd._usage()
71
 
 
72
 
 
73
68
def _help_commands_to_text(topic):
74
69
    """Generate the help text for the list of commands"""
75
70
    out = []
77
72
        hidden = True
78
73
    else:
79
74
        hidden = False
80
 
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
81
 
    names.update(_mod_commands.plugin_command_names())
 
75
    names = list(_mod_commands.all_command_names())
82
76
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
83
77
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
84
78
    max_name = max(len(n) for n, o in shown_commands)
85
79
    indent = ' ' * (max_name + 1)
86
 
    width = osutils.terminal_width() - 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
87
85
 
88
86
    for cmd_name, cmd_object in sorted(shown_commands):
89
87
        plugin_name = cmd_object.plugin_name()
98
96
        else:
99
97
            firstline = ''
100
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
101
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
102
 
                              width=width)
 
99
        lines = textwrap.wrap(
 
100
            helpstring, subsequent_indent=indent,
 
101
            width=width,
 
102
            break_long_words=False)
103
103
        for line in lines:
104
104
            out.append(line + '\n')
105
105
    return ''.join(out)
117
117
 
118
118
class HelpIndices(object):
119
119
    """Maintainer of help topics across multiple indices.
120
 
    
 
120
 
121
121
    It is currently separate to the HelpTopicRegistry because of its ordered
122
122
    nature, but possibly we should instead structure it as a search within the
123
123
    registry and add ordering and searching facilities to the registry. The
148
148
 
149
149
    def search(self, topic):
150
150
        """Search for topic across the help search path.
151
 
        
 
151
 
152
152
        :param topic: A string naming the help topic to search for.
153
153
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
154
154
        :return: A list of HelpTopics which matched 'topic'.