← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Patch Queue Manager
  • Date: 2012-03-14 14:39:16 UTC
  • mfrom: (6027.1.18 deprecations)
  • Revision ID: pqm@pqm.ubuntu.com-20120314143916-dggf9d1d26j3kizq
(vila) Remove some code deprecated in series older than 2.4 (inclusive)
 (Vincent Ladeuil)

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
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
 
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.
19
21
# It should be enough to just list the plugin directory and look for
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
    ui,
 
35
    utextwrap,
34
36
    )
35
37
 
36
38
 
37
39
def help(topic=None, outfile=None):
38
40
    """Write the help for the specific topic to outfile"""
39
41
    if outfile is None:
40
 
        outfile = sys.stdout
 
42
        outfile = ui.ui_factory.make_output_stream()
41
43
 
42
44
    indices = HelpIndices()
43
45
 
45
47
    try:
46
48
        topics = indices.search(topic)
47
49
        shadowed_terms = []
48
 
        for index, topic in topics[1:]:
 
50
        for index, topic_obj in topics[1:]:
49
51
            shadowed_terms.append('%s%s' % (index.prefix,
50
 
                topic.get_help_topic()))
 
52
                topic_obj.get_help_topic()))
51
53
        source = topics[0][1]
52
54
        outfile.write(source.get_help_text(shadowed_terms))
53
55
    except errors.NoHelpTopic:
62
64
def help_commands(outfile=None):
63
65
    """List all commands"""
64
66
    if outfile is None:
65
 
        outfile = sys.stdout
 
67
        outfile = ui.ui_factory.make_output_stream()
66
68
    outfile.write(_help_commands_to_text('commands'))
67
69
 
68
70
 
97
99
        else:
98
100
            firstline = ''
99
101
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
100
 
        lines = textwrap.wrap(
 
102
        lines = utextwrap.wrap(
101
103
            helpstring, subsequent_indent=indent,
102
104
            width=width,
103
105
            break_long_words=False)
136
138
            help_topics.HelpTopicIndex(),
137
139
            _mod_commands.HelpCommandIndex(),
138
140
            plugin.PluginsHelpIndex(),
 
141
            help_topics.ConfigOptionHelpIndex(),
139
142
            ]
140
143
 
141
144
    def _check_prefix_uniqueness(self):