/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: John Arbash Meinel
  • Date: 2006-10-16 01:50:48 UTC
  • mfrom: (2078 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2080.
  • Revision ID: john@arbash-meinel.com-20061016015048-0f22df07e38093da
[merge] bzr.dev 2078

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
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
from bzrlib import osutils 
 
25
 
 
26
global_help = \
 
27
"""Bazaar -- a free distributed version-control tool
 
28
http://bazaar-vcs.org/
 
29
 
 
30
Basic commands:
 
31
 
 
32
  bzr init           makes this directory a versioned branch
 
33
  bzr branch         make a copy of another branch
 
34
 
 
35
  bzr add            make files or directories versioned
 
36
  bzr ignore         ignore a file or pattern
 
37
  bzr mv             move or rename a versioned file
 
38
 
 
39
  bzr status         summarize changes in working copy
 
40
  bzr diff           show detailed diffs
 
41
 
 
42
  bzr merge          pull in changes from another branch
 
43
  bzr commit         save some or all changes
 
44
 
 
45
  bzr log            show history of changes
 
46
  bzr check          validate storage
 
47
 
 
48
  bzr help init      more help on e.g. init command
 
49
  bzr help commands  list all commands
 
50
"""
 
51
 
 
52
 
 
53
import sys
 
54
 
 
55
 
 
56
def help(topic=None, outfile = None):
 
57
    if outfile is None:
 
58
        outfile = sys.stdout
 
59
    if topic is None:
 
60
        outfile.write(global_help)
 
61
    elif topic == 'commands':
 
62
        help_commands(outfile = outfile)
 
63
    else:
 
64
        help_on_command(topic, outfile = outfile)
 
65
 
 
66
 
 
67
def command_usage(cmd_object):
 
68
    """Return single-line grammar for command.
 
69
 
 
70
    Only describes arguments, not options.
 
71
    """
 
72
    s = 'bzr ' + cmd_object.name() + ' '
 
73
    for aname in cmd_object.takes_args:
 
74
        aname = aname.upper()
 
75
        if aname[-1] in ['$', '+']:
 
76
            aname = aname[:-1] + '...'
 
77
        elif aname[-1] == '?':
 
78
            aname = '[' + aname[:-1] + ']'
 
79
        elif aname[-1] == '*':
 
80
            aname = '[' + aname[:-1] + '...]'
 
81
        s += aname + ' '
 
82
            
 
83
    assert s[-1] == ' '
 
84
    s = s[:-1]
 
85
    
 
86
    return s
 
87
 
 
88
 
 
89
def print_command_plugin(cmd_object, outfile, format):
 
90
    """Print the plugin that provides a command object, if any.
 
91
 
 
92
    If the cmd_object is provided by a plugin, prints the plugin name to
 
93
    outfile using the provided format string.
 
94
    """
 
95
    plugin_name = cmd_object.plugin_name()
 
96
    if plugin_name is not None:
 
97
        out_str = '(From plugin "%s")' % plugin_name
 
98
        outfile.write(format % out_str)
 
99
 
 
100
 
 
101
def help_on_command(cmdname, outfile=None):
 
102
    from bzrlib.commands import get_cmd_object
 
103
 
 
104
    cmdname = str(cmdname)
 
105
 
 
106
    if outfile is None:
 
107
        outfile = sys.stdout
 
108
 
 
109
    cmd_object = get_cmd_object(cmdname)
 
110
 
 
111
    doc = cmd_object.help()
 
112
    if doc is None:
 
113
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
114
 
 
115
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
116
 
 
117
    if cmd_object.aliases:
 
118
        print >>outfile, 'aliases:',
 
119
        print >>outfile, ', '.join(cmd_object.aliases)
 
120
 
 
121
    print >>outfile
 
122
 
 
123
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
124
 
 
125
    outfile.write(doc)
 
126
    if doc[-1] != '\n':
 
127
        outfile.write('\n')
 
128
    help_on_command_options(cmd_object, outfile)
 
129
 
 
130
 
 
131
def help_on_command_options(cmd, outfile=None):
 
132
    from bzrlib.option import Option, get_optparser
 
133
    if outfile is None:
 
134
        outfile = sys.stdout
 
135
    options = cmd.options()
 
136
    outfile.write('\n')
 
137
    outfile.write(get_optparser(options).format_option_help())
 
138
 
 
139
 
 
140
def help_commands(outfile=None):
 
141
    """List all commands"""
 
142
    from bzrlib.commands import (builtin_command_names,
 
143
                                 plugin_command_names,
 
144
                                 get_cmd_object)
 
145
    if outfile is None:
 
146
        outfile = sys.stdout
 
147
    names = set(builtin_command_names()) # to eliminate duplicates
 
148
    names.update(plugin_command_names())
 
149
    commands = ((n, get_cmd_object(n)) for n in names)
 
150
    shown_commands = [(n, o) for n, o in commands if not o.hidden]
 
151
    max_name = max(len(n) for n, o in shown_commands)
 
152
    indent = ' ' * (max_name + 1)
 
153
    width = osutils.terminal_width() - 1
 
154
    for cmd_name, cmd_object in sorted(shown_commands):
 
155
        plugin_name = cmd_object.plugin_name()
 
156
        if plugin_name is None:
 
157
            plugin_name = ''
 
158
        else:
 
159
            plugin_name = ' [%s]' % plugin_name
 
160
 
 
161
        cmd_help = cmd_object.help()
 
162
        if cmd_help:
 
163
            firstline = cmd_help.split('\n', 1)[0]
 
164
        else:
 
165
            firstline = ''
 
166
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
167
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
168
                              width=width)
 
169
        for line in lines:
 
170
            outfile.write(line + '\n')