← 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-09-20 17:01:14 UTC
  • mto: This revision was merged to the branch mainline in revision 2050.
  • Revision ID: john@arbash-meinel.com-20060920170114-20251f6bb2e7b7f7
Change default timeouts, and report differently the first failure

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
# TODO: Some way to get a list of external commands (defined by shell
 
18
# scripts) so that they can be included in the help listing as well.
 
19
# It should be enough to just list the plugin directory and look for
 
20
# executable files with reasonable names.
 
21
 
 
22
# TODO: `help commands --all` should show hidden commands
 
23
import textwrap
 
24
 
17
25
global_help = \
18
 
"""Bazaar-NG -- a free distributed version-control tool
19
 
http://bazaar-ng.org/
20
 
 
21
 
WARNING: This is an unstable development version.
22
 
         Please keep backups.
 
26
"""Bazaar -- a free distributed version-control tool
 
27
http://bazaar-vcs.org/
23
28
 
24
29
Basic commands:
25
30
 
26
 
  bzr init      makes this branch versioned
27
 
  bzr branch    make a copy of another branch
28
 
 
29
 
  bzr add       make files or directories versioned
30
 
  bzr ignore    ignore a file or pattern
31
 
  bzr mv        move or rename a versioned file
32
 
 
33
 
  bzr status    summarize changes in working copy
34
 
  bzr diff      show detailed diffs
35
 
 
36
 
  bzr merge     pull in changes from another branch
37
 
  bzr commit    
38
 
 
39
 
  bzr log       show history of changes
40
 
  bzr check     validate storage
41
 
 
42
 
Use e.g. 'bzr help init' for more details, or 'bzr help commands' for
43
 
all commands.
 
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
44
49
"""
45
50
 
46
51
 
48
53
 
49
54
 
50
55
def help(topic=None, outfile = None):
51
 
    if outfile == None:
 
56
    if outfile is None:
52
57
        outfile = sys.stdout
53
 
    if topic == None:
 
58
    if topic is None:
54
59
        outfile.write(global_help)
55
60
    elif topic == 'commands':
56
61
        help_commands(outfile = outfile)
58
63
        help_on_command(topic, outfile = outfile)
59
64
 
60
65
 
61
 
def command_usage(cmdname, cmdclass):
 
66
def command_usage(cmd_object):
62
67
    """Return single-line grammar for command.
63
68
 
64
69
    Only describes arguments, not options.
65
70
    """
66
 
    s = cmdname + ' '
67
 
    for aname in cmdclass.takes_args:
 
71
    s = 'bzr ' + cmd_object.name() + ' '
 
72
    for aname in cmd_object.takes_args:
68
73
        aname = aname.upper()
69
74
        if aname[-1] in ['$', '+']:
70
75
            aname = aname[:-1] + '...'
80
85
    return s
81
86
 
82
87
 
83
 
def help_on_command(cmdname, outfile = None):
 
88
def print_command_plugin(cmd_object, outfile, format):
 
89
    """Print the plugin that provides a command object, if any.
 
90
 
 
91
    If the cmd_object is provided by a plugin, prints the plugin name to
 
92
    outfile using the provided format string.
 
93
    """
 
94
    plugin_name = cmd_object.plugin_name()
 
95
    if plugin_name is not None:
 
96
        out_str = '(From plugin "%s")' % plugin_name
 
97
        outfile.write(format % out_str)
 
98
 
 
99
 
 
100
def help_on_command(cmdname, outfile=None):
 
101
    from bzrlib.commands import get_cmd_object
 
102
 
84
103
    cmdname = str(cmdname)
85
104
 
86
 
    if outfile == None:
 
105
    if outfile is None:
87
106
        outfile = sys.stdout
88
107
 
89
 
    from inspect import getdoc
90
 
    import commands
91
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
 
108
    cmd_object = get_cmd_object(cmdname)
92
109
 
93
 
    doc = getdoc(cmdclass)
94
 
    if doc == None:
 
110
    doc = cmd_object.help()
 
111
    if doc is None:
95
112
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
96
113
 
97
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
98
 
 
99
 
    if cmdclass.aliases:
100
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
101
 
    
 
114
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
115
 
 
116
    if cmd_object.aliases:
 
117
        print >>outfile, 'aliases:',
 
118
        print >>outfile, ', '.join(cmd_object.aliases)
 
119
 
 
120
    print >>outfile
 
121
 
 
122
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
123
 
102
124
    outfile.write(doc)
103
125
    if doc[-1] != '\n':
104
126
        outfile.write('\n')
105
 
    
106
 
    help_on_option(cmdclass.takes_options, outfile = None)
107
 
 
108
 
 
109
 
def help_on_option(options, outfile = None):
110
 
    import commands
111
 
    
112
 
    if not options:
113
 
        return
114
 
    
115
 
    if outfile == None:
 
127
    help_on_command_options(cmd_object, outfile)
 
128
 
 
129
 
 
130
def help_on_command_options(cmd, outfile=None):
 
131
    from bzrlib.option import Option, get_optparser
 
132
    if outfile is None:
116
133
        outfile = sys.stdout
117
 
 
118
 
    outfile.write('\noptions:\n')
119
 
    for on in options:
120
 
        l = '    --' + on
121
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
122
 
            if longname == on:
123
 
                l += ', -' + shortname
124
 
                break
125
 
        outfile.write(l + '\n')
126
 
 
127
 
 
128
 
def help_commands(outfile = None):
 
134
    options = cmd.options()
 
135
    outfile.write('\n')
 
136
    outfile.write(get_optparser(options).format_option_help())
 
137
 
 
138
 
 
139
def help_commands(outfile=None):
129
140
    """List all commands"""
130
 
    import inspect
131
 
    import commands
 
141
    from bzrlib.commands import (builtin_command_names,
 
142
                                 plugin_command_names,
 
143
                                 get_cmd_object)
132
144
 
133
 
    if outfile == None:
 
145
    if outfile is None:
134
146
        outfile = sys.stdout
135
 
    
136
 
    accu = []
137
 
    for cmdname, cmdclass in commands.get_all_cmds():
138
 
        accu.append((cmdname, cmdclass))
139
 
    accu.sort()
140
 
    for cmdname, cmdclass in accu:
141
 
        if cmdclass.hidden:
 
147
 
 
148
    names = set()                       # to eliminate duplicates
 
149
    names.update(builtin_command_names())
 
150
    names.update(plugin_command_names())
 
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:
142
157
            continue
143
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
144
 
        help = inspect.getdoc(cmdclass)
145
 
        if help:
146
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
147
 
 
148
 
            
149
 
 
 
158
        print >>outfile, command_usage(cmd_object)
 
159
 
 
160
        plugin_name = cmd_object.plugin_name()
 
161
        print_command_plugin(cmd_object, outfile, '        %s\n')
 
162
 
 
163
        cmd_help = cmd_object.help()
 
164
        if cmd_help:
 
165
            firstline = cmd_help.split('\n', 1)[0]
 
166
            print >>outfile, '        ' + firstline
 
167