← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Aaron Bentley
  • Date: 2006-09-21 20:21:36 UTC
  • mto: (2027.1.2 revert-subpath-56549)
  • mto: This revision was merged to the branch mainline in revision 2031.
  • Revision ID: abentley@panoramicfeedback.com-20060921202136-e5a8deaadfa00021
Added test for preserving file mode

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
23
23
import textwrap
24
24
 
25
25
global_help = \
26
 
"""Bazaar-NG -- a free distributed version-control tool
27
 
http://bazaar-ng.org/
28
 
 
29
 
WARNING: This is an unstable development version.
30
 
         Please keep backups.
 
26
"""Bazaar -- a free distributed version-control tool
 
27
http://bazaar-vcs.org/
31
28
 
32
29
Basic commands:
33
30
 
56
53
 
57
54
 
58
55
def help(topic=None, outfile = None):
59
 
    if outfile == None:
 
56
    if outfile is None:
60
57
        outfile = sys.stdout
61
 
    if topic == None:
 
58
    if topic is None:
62
59
        outfile.write(global_help)
63
60
    elif topic == 'commands':
64
61
        help_commands(outfile = outfile)
88
85
    return s
89
86
 
90
87
 
 
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
 
91
100
def help_on_command(cmdname, outfile=None):
92
101
    from bzrlib.commands import get_cmd_object
93
102
 
94
103
    cmdname = str(cmdname)
95
104
 
96
 
    if outfile == None:
 
105
    if outfile is None:
97
106
        outfile = sys.stdout
98
107
 
99
108
    cmd_object = get_cmd_object(cmdname)
100
109
 
101
110
    doc = cmd_object.help()
102
 
    if doc == None:
 
111
    if doc is None:
103
112
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
104
113
 
105
114
    print >>outfile, 'usage:', command_usage(cmd_object) 
110
119
 
111
120
    print >>outfile
112
121
 
 
122
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
123
 
113
124
    outfile.write(doc)
114
125
    if doc[-1] != '\n':
115
126
        outfile.write('\n')
117
128
 
118
129
 
119
130
def help_on_command_options(cmd, outfile=None):
120
 
    from bzrlib.option import Option
 
131
    from bzrlib.option import Option, get_optparser
 
132
    if outfile is None:
 
133
        outfile = sys.stdout
121
134
    options = cmd.options()
122
 
    if not options:
123
 
        return
124
 
    if outfile == None:
125
 
        outfile = sys.stdout
126
 
    outfile.write('\noptions:\n')
127
 
    for option_name, option in sorted(options.items()):
128
 
        l = '    --' + option_name
129
 
        if option.type is not None:
130
 
            l += ' ' + option.argname.upper()
131
 
        short_name = option.short_name()
132
 
        if short_name:
133
 
            assert len(short_name) == 1
134
 
            l += ', -' + short_name
135
 
        l += (30 - len(l)) * ' ' + option.help
136
 
        # TODO: split help over multiple lines with correct indenting and 
137
 
        # wrapping
138
 
        wrapped = textwrap.fill(l, initial_indent='', subsequent_indent=30*' ')
139
 
        outfile.write(wrapped + '\n')
 
135
    outfile.write('\n')
 
136
    outfile.write(get_optparser(options).format_option_help())
140
137
 
141
138
 
142
139
def help_commands(outfile=None):
145
142
                                 plugin_command_names,
146
143
                                 get_cmd_object)
147
144
 
148
 
    if outfile == None:
 
145
    if outfile is None:
149
146
        outfile = sys.stdout
150
147
 
151
148
    names = set()                       # to eliminate duplicates
159
156
        if cmd_object.hidden:
160
157
            continue
161
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
 
162
163
        cmd_help = cmd_object.help()
163
164
        if cmd_help:
164
165
            firstline = cmd_help.split('\n', 1)[0]
165
 
            print >>outfile, '    ' + firstline
 
166
            print >>outfile, '        ' + firstline
166
167