← 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-12-19 14:19:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2200.
  • Revision ID: john@arbash-meinel.com-20061219141931-jhjpdy5hzgnr2b44
Update documentation as per Martin's suggestion.

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 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
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
23
 
24
 
global_help = \
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.
30
 
 
31
 
Basic commands:
32
 
 
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.
51
 
"""
52
 
 
53
 
 
54
24
import sys
55
 
 
56
 
 
57
 
def help(topic=None, outfile = None):
58
 
    if outfile == None:
 
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:
59
36
        outfile = sys.stdout
60
 
    if topic == None:
61
 
        outfile.write(global_help)
62
 
    elif topic == 'commands':
63
 
        help_commands(outfile = outfile)
 
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)
64
44
    else:
65
 
        help_on_command(topic, outfile = outfile)
 
45
        help_on_command(topic, outfile=outfile)
66
46
 
67
47
 
68
48
def command_usage(cmd_object):
87
67
    return s
88
68
 
89
69
 
 
70
def print_command_plugin(cmd_object, outfile, format):
 
71
    """Print the plugin that provides a command object, if any.
 
72
 
 
73
    If the cmd_object is provided by a plugin, prints the plugin name to
 
74
    outfile using the provided format string.
 
75
    """
 
76
    plugin_name = cmd_object.plugin_name()
 
77
    if plugin_name is not None:
 
78
        out_str = '(From plugin "%s")' % plugin_name
 
79
        outfile.write(format % out_str)
 
80
 
 
81
 
90
82
def help_on_command(cmdname, outfile=None):
91
83
    from bzrlib.commands import get_cmd_object
92
84
 
93
85
    cmdname = str(cmdname)
94
86
 
95
 
    if outfile == None:
 
87
    if outfile is None:
96
88
        outfile = sys.stdout
97
89
 
98
90
    cmd_object = get_cmd_object(cmdname)
99
91
 
100
92
    doc = cmd_object.help()
101
 
    if doc == None:
 
93
    if doc is None:
102
94
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
103
95
 
104
 
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
96
    print >>outfile, 'usage:', command_usage(cmd_object)
105
97
 
106
98
    if cmd_object.aliases:
107
99
        print >>outfile, 'aliases:',
109
101
 
110
102
    print >>outfile
111
103
 
 
104
    print_command_plugin(cmd_object, outfile, '%s\n\n')
 
105
 
112
106
    outfile.write(doc)
113
107
    if doc[-1] != '\n':
114
108
        outfile.write('\n')
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:
 
109
    help_on_command_options(cmd_object, outfile)
 
110
 
 
111
 
 
112
def help_on_command_options(cmd, outfile=None):
 
113
    from bzrlib.option import Option, get_optparser
 
114
    if outfile is None:
126
115
        outfile = sys.stdout
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')
 
116
    options = cmd.options()
 
117
    outfile.write('\n')
 
118
    outfile.write(get_optparser(options).format_option_help())
136
119
 
137
120
 
138
121
def help_commands(outfile=None):
139
122
    """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"""
140
130
    from bzrlib.commands import (builtin_command_names,
141
131
                                 plugin_command_names,
142
132
                                 get_cmd_object)
143
 
 
144
 
    if outfile == None:
145
 
        outfile = sys.stdout
146
 
 
147
 
    names = set()                       # to eliminate duplicates
148
 
    names.update(builtin_command_names())
 
133
    out = []
 
134
    if topic == 'hidden-commands':
 
135
        hidden = True
 
136
    else:
 
137
        hidden = False
 
138
    names = set(builtin_command_names()) # to eliminate duplicates
149
139
    names.update(plugin_command_names())
150
 
    names = list(names)
151
 
    names.sort()
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)
 
140
    commands = ((n, get_cmd_object(n)) for n in names)
 
141
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
142
    max_name = max(len(n) for n, o in shown_commands)
 
143
    indent = ' ' * (max_name + 1)
 
144
    width = osutils.terminal_width() - 1
 
145
 
 
146
    for cmd_name, cmd_object in sorted(shown_commands):
 
147
        plugin_name = cmd_object.plugin_name()
 
148
        if plugin_name is None:
 
149
            plugin_name = ''
 
150
        else:
 
151
            plugin_name = ' [%s]' % plugin_name
 
152
 
158
153
        cmd_help = cmd_object.help()
159
154
        if cmd_help:
160
155
            firstline = cmd_help.split('\n', 1)[0]
161
 
            print >>outfile, '    ' + firstline
162
 
        
 
156
        else:
 
157
            firstline = ''
 
158
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
159
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
 
160
                              width=width)
 
161
        for line in lines:
 
162
            out.append(line + '\n')
 
163
    return ''.join(out)
 
164
 
 
165
 
 
166
help_topics.topic_registry.register("commands",
 
167
                                    _help_commands_to_text,
 
168
                                    "Basic help for all commands")
 
169
help_topics.topic_registry.register("hidden-commands", 
 
170
                                    _help_commands_to_text,
 
171
                                    "All hidden commands")