← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

Merge bzr.dev and tree-file-ids-as-tuples.

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-2011 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
 
 
17
from __future__ import absolute_import
16
18
 
17
19
# TODO: Some way to get a list of external commands (defined by shell
18
20
# scripts) so that they can be included in the help listing as well.
22
24
# TODO: `help commands --all` should show hidden commands
23
25
 
24
26
import sys
25
 
import textwrap
26
27
 
27
28
from bzrlib import (
28
29
    commands as _mod_commands,
30
31
    help_topics,
31
32
    osutils,
32
33
    plugin,
33
 
    symbol_versioning,
 
34
    utextwrap,
34
35
    )
35
36
 
36
37
 
45
46
    try:
46
47
        topics = indices.search(topic)
47
48
        shadowed_terms = []
48
 
        for index, topic in topics[1:]:
 
49
        for index, topic_obj in topics[1:]:
49
50
            shadowed_terms.append('%s%s' % (index.prefix,
50
 
                topic.get_help_topic()))
51
 
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
51
                topic_obj.get_help_topic()))
 
52
        source = topics[0][1]
 
53
        outfile.write(source.get_help_text(shadowed_terms))
52
54
    except errors.NoHelpTopic:
53
55
        if alias is None:
54
56
            raise
65
67
    outfile.write(_help_commands_to_text('commands'))
66
68
 
67
69
 
68
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
69
 
def command_usage(cmd):
70
 
    return cmd._usage()
71
 
 
72
 
 
73
70
def _help_commands_to_text(topic):
74
71
    """Generate the help text for the list of commands"""
75
72
    out = []
77
74
        hidden = True
78
75
    else:
79
76
        hidden = False
80
 
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
81
 
    names.update(_mod_commands.plugin_command_names())
 
77
    names = list(_mod_commands.all_command_names())
82
78
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
83
79
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
84
80
    max_name = max(len(n) for n, o in shown_commands)
85
81
    indent = ' ' * (max_name + 1)
86
 
    width = osutils.terminal_width() - 1
 
82
    width = osutils.terminal_width()
 
83
    if width is None:
 
84
        width = osutils.default_terminal_width
 
85
    # we need one extra space for terminals that wrap on last char
 
86
    width = width - 1
87
87
 
88
88
    for cmd_name, cmd_object in sorted(shown_commands):
89
89
        plugin_name = cmd_object.plugin_name()
98
98
        else:
99
99
            firstline = ''
100
100
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
101
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
102
 
                              width=width)
 
101
        lines = utextwrap.wrap(
 
102
            helpstring, subsequent_indent=indent,
 
103
            width=width,
 
104
            break_long_words=False)
103
105
        for line in lines:
104
106
            out.append(line + '\n')
105
107
    return ''.join(out)
117
119
 
118
120
class HelpIndices(object):
119
121
    """Maintainer of help topics across multiple indices.
120
 
    
 
122
 
121
123
    It is currently separate to the HelpTopicRegistry because of its ordered
122
124
    nature, but possibly we should instead structure it as a search within the
123
125
    registry and add ordering and searching facilities to the registry. The
135
137
            help_topics.HelpTopicIndex(),
136
138
            _mod_commands.HelpCommandIndex(),
137
139
            plugin.PluginsHelpIndex(),
 
140
            help_topics.ConfigOptionHelpIndex(),
138
141
            ]
139
142
 
140
143
    def _check_prefix_uniqueness(self):
148
151
 
149
152
    def search(self, topic):
150
153
        """Search for topic across the help search path.
151
 
        
 
154
 
152
155
        :param topic: A string naming the help topic to search for.
153
156
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
154
157
        :return: A list of HelpTopics which matched 'topic'.