← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-08-16 00:09:54 UTC
  • mfrom: (3629.1.4 uncommit_ids)
  • Revision ID: pqm@pqm.ubuntu.com-20080816000954-t0401ff8s3ydnkr6
(jam) bzr uncommit now gives the revision id to restore the branch to
        the old tip.

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) 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.
22
22
# TODO: `help commands --all` should show hidden commands
23
23
 
24
24
import sys
 
25
import textwrap
25
26
 
26
27
from bzrlib import (
27
28
    commands as _mod_commands,
29
30
    help_topics,
30
31
    osutils,
31
32
    plugin,
32
 
    utextwrap,
 
33
    symbol_versioning,
33
34
    )
34
35
 
35
36
 
44
45
    try:
45
46
        topics = indices.search(topic)
46
47
        shadowed_terms = []
47
 
        for index, topic_obj in topics[1:]:
 
48
        for index, topic in topics[1:]:
48
49
            shadowed_terms.append('%s%s' % (index.prefix,
49
 
                topic_obj.get_help_topic()))
50
 
        source = topics[0][1]
51
 
        outfile.write(source.get_help_text(shadowed_terms))
 
50
                topic.get_help_topic()))
 
51
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
52
52
    except errors.NoHelpTopic:
53
53
        if alias is None:
54
54
            raise
72
72
        hidden = True
73
73
    else:
74
74
        hidden = False
75
 
    names = list(_mod_commands.all_command_names())
 
75
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
 
76
    names.update(_mod_commands.plugin_command_names())
76
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
77
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
78
79
    max_name = max(len(n) for n, o in shown_commands)
79
80
    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
 
81
    width = osutils.terminal_width() - 1
85
82
 
86
83
    for cmd_name, cmd_object in sorted(shown_commands):
87
84
        plugin_name = cmd_object.plugin_name()
96
93
        else:
97
94
            firstline = ''
98
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
99
 
        lines = utextwrap.wrap(
100
 
            helpstring, subsequent_indent=indent,
101
 
            width=width,
102
 
            break_long_words=False)
 
96
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
97
                              width=width)
103
98
        for line in lines:
104
99
            out.append(line + '\n')
105
100
    return ''.join(out)
117
112
 
118
113
class HelpIndices(object):
119
114
    """Maintainer of help topics across multiple indices.
120
 
 
 
115
    
121
116
    It is currently separate to the HelpTopicRegistry because of its ordered
122
117
    nature, but possibly we should instead structure it as a search within the
123
118
    registry and add ordering and searching facilities to the registry. The
135
130
            help_topics.HelpTopicIndex(),
136
131
            _mod_commands.HelpCommandIndex(),
137
132
            plugin.PluginsHelpIndex(),
138
 
            help_topics.ConfigOptionHelpIndex(),
139
133
            ]
140
134
 
141
135
    def _check_prefix_uniqueness(self):
149
143
 
150
144
    def search(self, topic):
151
145
        """Search for topic across the help search path.
152
 
 
 
146
        
153
147
        :param topic: A string naming the help topic to search for.
154
148
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
155
149
        :return: A list of HelpTopics which matched 'topic'.