← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Martin Pool
  • Date: 2005-09-13 05:22:41 UTC
  • Revision ID: mbp@sourcefrog.net-20050913052241-52dbd8e8ced620f6
- better BZR_DEBUG trace output

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd
2
 
#
 
1
# Copyright (C) 2004, 2005 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
20
20
# executable files with reasonable names.
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
 
import textwrap
24
 
from bzrlib import osutils 
25
23
 
26
24
global_help = \
27
 
"""Bazaar -- a free distributed version-control tool
28
 
http://bazaar-vcs.org/
 
25
"""Bazaar-NG -- a free distributed version-control tool
 
26
http://bazaar-ng.org/
 
27
 
 
28
WARNING: This is an unstable development version.
 
29
         Please keep backups.
29
30
 
30
31
Basic commands:
31
32
 
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
 
33
  bzr init      makes this branch versioned
 
34
  bzr branch    make a copy of another branch
 
35
 
 
36
  bzr add       make files or directories versioned
 
37
  bzr ignore    ignore a file or pattern
 
38
  bzr mv        move or rename a versioned file
 
39
 
 
40
  bzr status    summarize changes in working copy
 
41
  bzr diff      show detailed diffs
 
42
 
 
43
  bzr merge     pull in changes from another branch
 
44
  bzr commit    
 
45
 
 
46
  bzr log       show history of changes
 
47
  bzr check     validate storage
 
48
 
 
49
Use e.g. 'bzr help init' for more details, or
 
50
'bzr help commands' for all commands.
50
51
"""
51
52
 
52
53
 
54
55
 
55
56
 
56
57
def help(topic=None, outfile = None):
57
 
    if outfile is None:
 
58
    if outfile == None:
58
59
        outfile = sys.stdout
59
 
    if topic is None:
 
60
    if topic == None:
60
61
        outfile.write(global_help)
61
62
    elif topic == 'commands':
62
63
        help_commands(outfile = outfile)
86
87
    return s
87
88
 
88
89
 
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
90
def help_on_command(cmdname, outfile=None):
102
91
    from bzrlib.commands import get_cmd_object
103
92
 
104
93
    cmdname = str(cmdname)
105
94
 
106
 
    if outfile is None:
 
95
    if outfile == None:
107
96
        outfile = sys.stdout
108
97
 
109
98
    cmd_object = get_cmd_object(cmdname)
110
99
 
111
100
    doc = cmd_object.help()
112
 
    if doc is None:
 
101
    if doc == None:
113
102
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
114
103
 
115
104
    print >>outfile, 'usage:', command_usage(cmd_object) 
120
109
 
121
110
    print >>outfile
122
111
 
123
 
    print_command_plugin(cmd_object, outfile, '%s\n\n')
124
 
 
125
112
    outfile.write(doc)
126
113
    if doc[-1] != '\n':
127
114
        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:
 
115
    
 
116
    help_on_options(cmd_object.takes_options, outfile=None)
 
117
 
 
118
 
 
119
def help_on_options(options, outfile=None):
 
120
    from bzrlib.commands import SHORT_OPTIONS
 
121
    
 
122
    if not options:
 
123
        return
 
124
    
 
125
    if outfile == None:
134
126
        outfile = sys.stdout
135
 
    options = cmd.options()
136
 
    outfile.write('\n')
137
 
    outfile.write(get_optparser(options).format_option_help())
 
127
 
 
128
    outfile.write('\noptions:\n')
 
129
    for on in options:
 
130
        l = '    --' + on
 
131
        for shortname, longname in SHORT_OPTIONS.items():
 
132
            if longname == on:
 
133
                l += ', -' + shortname
 
134
                break
 
135
        outfile.write(l + '\n')
138
136
 
139
137
 
140
138
def help_commands(outfile=None):
142
140
    from bzrlib.commands import (builtin_command_names,
143
141
                                 plugin_command_names,
144
142
                                 get_cmd_object)
145
 
    if outfile is None:
 
143
 
 
144
    if outfile == None:
146
145
        outfile = sys.stdout
147
 
    names = set(builtin_command_names()) # to eliminate duplicates
 
146
 
 
147
    names = set()                       # to eliminate duplicates
 
148
    names.update(builtin_command_names())
148
149
    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
 
150
    names = list(names)
 
151
    names.sort()
160
152
 
 
153
    for cmd_name in names:
 
154
        cmd_object = get_cmd_object(cmd_name)
 
155
        if cmd_object.hidden:
 
156
            continue
 
157
        print >>outfile, command_usage(cmd_object)
161
158
        cmd_help = cmd_object.help()
162
159
        if cmd_help:
163
160
            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')
 
161
            print >>outfile, '    ' + firstline
 
162