← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Alexander Belchenko
  • Date: 2007-10-26 21:49:15 UTC
  • mto: (2947.4.2 0.92)
  • mto: This revision was merged to the branch mainline in revision 2971.
  • Revision ID: bialix@ukr.net-20071026214915-5eacqh9k2ps6jagj
windows python-based installer: shortcut for uninstall action

Show diffs side-by-side

added added

removed removed

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