← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-17 13:53:36 UTC
  • mfrom: (1939 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1940.
  • Revision ID: john@arbash-meinel.com-20060817135336-100de82962355d3b
[merge] bzr.dev 1939

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) 2004, 2005, 2006 by 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
20
20
# executable files with reasonable names.
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
 
23
import textwrap
 
24
 
 
25
global_help = \
 
26
"""Bazaar -- a free distributed version-control tool
 
27
http://bazaar-vcs.org/
 
28
 
 
29
Basic commands:
 
30
 
 
31
  bzr init           makes this directory a versioned branch
 
32
  bzr branch         make a copy of another branch
 
33
 
 
34
  bzr add            make files or directories versioned
 
35
  bzr ignore         ignore a file or pattern
 
36
  bzr mv             move or rename a versioned file
 
37
 
 
38
  bzr status         summarize changes in working copy
 
39
  bzr diff           show detailed diffs
 
40
 
 
41
  bzr merge          pull in changes from another branch
 
42
  bzr commit         save some or all changes
 
43
 
 
44
  bzr log            show history of changes
 
45
  bzr check          validate storage
 
46
 
 
47
  bzr help init      more help on e.g. init command
 
48
  bzr help commands  list all commands
 
49
"""
 
50
 
23
51
 
24
52
import sys
25
 
import textwrap
26
 
 
27
 
from bzrlib import (
28
 
    help_topics,
29
 
    osutils,
30
 
    )
31
 
 
32
 
 
33
 
def help(topic=None, outfile=None):
34
 
    """Write the help for the specific topic to outfile"""
35
 
    if outfile is None:
 
53
 
 
54
 
 
55
def help(topic=None, outfile = None):
 
56
    if outfile == None:
36
57
        outfile = sys.stdout
37
 
 
38
 
    if topic is None:
39
 
        topic = 'basic'
40
 
 
41
 
    if topic in help_topics.topic_registry:
42
 
        txt = help_topics.topic_registry.get_detail(topic)
43
 
        outfile.write(txt)
 
58
    if topic == None:
 
59
        outfile.write(global_help)
 
60
    elif topic == 'commands':
 
61
        help_commands(outfile = outfile)
44
62
    else:
45
 
        help_on_command(topic, outfile=outfile)
 
63
        help_on_command(topic, outfile = outfile)
46
64
 
47
65
 
48
66
def command_usage(cmd_object):
84
102
 
85
103
    cmdname = str(cmdname)
86
104
 
87
 
    if outfile is None:
 
105
    if outfile == None:
88
106
        outfile = sys.stdout
89
107
 
90
108
    cmd_object = get_cmd_object(cmdname)
91
109
 
92
110
    doc = cmd_object.help()
93
 
    if doc is None:
 
111
    if doc == None:
94
112
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
95
113
 
96
 
    print >>outfile, 'usage:', command_usage(cmd_object)
 
114
    print >>outfile, 'usage:', command_usage(cmd_object) 
97
115
 
98
116
    if cmd_object.aliases:
99
117
        print >>outfile, 'aliases:',
120
138
 
121
139
def help_commands(outfile=None):
122
140
    """List all commands"""
123
 
    if outfile is None:
124
 
        outfile = sys.stdout
125
 
    outfile.write(_help_commands_to_text('commands'))
126
 
 
127
 
 
128
 
def _help_commands_to_text(topic):
129
 
    """Generate the help text for the list of commands"""
130
141
    from bzrlib.commands import (builtin_command_names,
131
142
                                 plugin_command_names,
132
143
                                 get_cmd_object)
133
 
    out = []
134
 
 
135
 
    names = set(builtin_command_names()) # to eliminate duplicates
 
144
 
 
145
    if outfile == None:
 
146
        outfile = sys.stdout
 
147
 
 
148
    names = set()                       # to eliminate duplicates
 
149
    names.update(builtin_command_names())
136
150
    names.update(plugin_command_names())
137
 
    commands = ((n, get_cmd_object(n)) for n in names)
138
 
    shown_commands = [(n, o) for n, o in commands if not o.hidden]
139
 
    max_name = max(len(n) for n, o in shown_commands)
140
 
    indent = ' ' * (max_name + 1)
141
 
    width = osutils.terminal_width() - 1
142
 
 
143
 
    for cmd_name, cmd_object in sorted(shown_commands):
 
151
    names = list(names)
 
152
    names.sort()
 
153
 
 
154
    for cmd_name in names:
 
155
        cmd_object = get_cmd_object(cmd_name)
 
156
        if cmd_object.hidden:
 
157
            continue
 
158
        print >>outfile, command_usage(cmd_object)
 
159
 
144
160
        plugin_name = cmd_object.plugin_name()
145
 
        if plugin_name is None:
146
 
            plugin_name = ''
147
 
        else:
148
 
            plugin_name = ' [%s]' % plugin_name
 
161
        print_command_plugin(cmd_object, outfile, '        %s\n')
149
162
 
150
163
        cmd_help = cmd_object.help()
151
164
        if cmd_help:
152
165
            firstline = cmd_help.split('\n', 1)[0]
153
 
        else:
154
 
            firstline = ''
155
 
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
156
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
157
 
                              width=width)
158
 
        for line in lines:
159
 
            out.append(line + '\n')
160
 
    return ''.join(out)
161
 
 
162
 
 
163
 
help_topics.topic_registry.register("commands",
164
 
                                    _help_commands_to_text,
165
 
                                    "Basic help for all commands")
 
166
            print >>outfile, '        ' + firstline
 
167