← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

Prepare for 0.6rc1

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
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
26
"""Bazaar-NG -- a free distributed version-control tool
19
27
http://bazaar-ng.org/
20
28
 
21
 
**WARNING: THIS IS AN UNSTABLE DEVELOPMENT VERSION**
22
 
 
23
 
* Metadata format is not stable yet -- you may need to
24
 
  discard history in the future.
25
 
 
26
 
* Many commands unimplemented or partially implemented.
27
 
 
28
 
* Space-inefficient storage.
29
 
 
30
 
* No merge operators yet.
31
 
 
32
 
 
33
 
To make a branch, use 'bzr init' in an existing directory, then 'bzr
34
 
add' to make files versioned.  'bzr add .' will recursively add all
35
 
non-ignored files.
36
 
 
37
 
'bzr status' describes files that are unknown, ignored, or modified.
38
 
'bzr diff' shows the text changes to the tree or named files.
39
 
'bzr commit -m <MESSAGE>' commits all changes in that branch.
40
 
 
41
 
'bzr move' and 'bzr rename' allow you to rename files or directories.
42
 
'bzr remove' makes a file unversioned but keeps the working copy;
43
 
to delete that too simply delete the file.
44
 
 
45
 
'bzr log' shows a history of changes, and
46
 
'bzr info' gives summary statistical information.
47
 
'bzr check' validates all files are stored safely.
48
 
 
49
 
Files can be ignored by giving a path or a glob in .bzrignore at the
50
 
top of the tree.  Use 'bzr ignored' to see what files are ignored and
51
 
why, and 'bzr unknowns' to see files that are neither versioned or
52
 
ignored.
53
 
 
54
 
For more help on any command, type 'bzr help COMMAND', or 'bzr help
55
 
commands' for a list.
 
29
WARNING: This is an unstable development version.
 
30
         Please keep backups.
 
31
 
 
32
Basic commands:
 
33
 
 
34
  bzr init           makes this directory a versioned branch
 
35
  bzr branch         make a copy of another branch
 
36
 
 
37
  bzr add            make files or directories versioned
 
38
  bzr ignore         ignore a file or pattern
 
39
  bzr mv             move or rename a versioned file
 
40
 
 
41
  bzr status         summarize changes in working copy
 
42
  bzr diff           show detailed diffs
 
43
 
 
44
  bzr merge          pull in changes from another branch
 
45
  bzr commit         save some or all changes
 
46
 
 
47
  bzr log            show history of changes
 
48
  bzr check          validate storage
 
49
 
 
50
  bzr help init      more help on e.g. init command
 
51
  bzr help commands  list all commands
56
52
"""
57
53
 
58
54
 
59
 
 
60
 
def help(topic=None):
 
55
import sys
 
56
 
 
57
 
 
58
def help(topic=None, outfile = None):
 
59
    if outfile == None:
 
60
        outfile = sys.stdout
61
61
    if topic == None:
62
 
        print global_help
 
62
        outfile.write(global_help)
63
63
    elif topic == 'commands':
64
 
        help_commands()
65
 
    else:
66
 
        help_on_command(topic)
67
 
 
68
 
 
69
 
def help_on_command(cmdname):
70
 
    cmdname = str(cmdname)
71
 
 
72
 
    from inspect import getdoc
73
 
    import commands
74
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
75
 
 
76
 
    doc = getdoc(cmdclass)
77
 
    if doc == None:
78
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
79
 
 
80
 
    if '\n' in doc:
81
 
        short, rest = doc.split('\n', 1)
82
 
    else:
83
 
        short = doc
84
 
        rest = ''
85
 
 
86
 
    print 'usage: bzr ' + topic,
87
 
    for aname in cmdclass.takes_args:
 
64
        help_commands(outfile = outfile)
 
65
    else:
 
66
        help_on_command(topic, outfile = outfile)
 
67
 
 
68
 
 
69
def command_usage(cmd_object):
 
70
    """Return single-line grammar for command.
 
71
 
 
72
    Only describes arguments, not options.
 
73
    """
 
74
    s = 'bzr ' + cmd_object.name() + ' '
 
75
    for aname in cmd_object.takes_args:
88
76
        aname = aname.upper()
89
77
        if aname[-1] in ['$', '+']:
90
78
            aname = aname[:-1] + '...'
92
80
            aname = '[' + aname[:-1] + ']'
93
81
        elif aname[-1] == '*':
94
82
            aname = '[' + aname[:-1] + '...]'
95
 
        print aname,
96
 
    print 
97
 
    print short
98
 
 
99
 
    if cmdclass.aliases:
100
 
        print 'aliases: ' + ', '.join(cmdclass.aliases)
101
 
    
102
 
    if rest:
103
 
        print rest
104
 
 
105
 
    help_on_option(cmdclass.takes_options)
106
 
 
107
 
 
108
 
def help_on_option(options):
109
 
    import commands
110
 
    
 
83
        s += aname + ' '
 
84
            
 
85
    assert s[-1] == ' '
 
86
    s = s[:-1]
 
87
    
 
88
    return s
 
89
 
 
90
 
 
91
def help_on_command(cmdname, outfile=None):
 
92
    from bzrlib.commands import get_cmd_object
 
93
 
 
94
    cmdname = str(cmdname)
 
95
 
 
96
    if outfile == None:
 
97
        outfile = sys.stdout
 
98
 
 
99
    cmd_object = get_cmd_object(cmdname)
 
100
 
 
101
    doc = cmd_object.help()
 
102
    if doc == None:
 
103
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
 
104
 
 
105
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
106
 
 
107
    if cmd_object.aliases:
 
108
        print >>outfile, 'aliases:',
 
109
        print >>outfile, ', '.join(cmd_object.aliases)
 
110
 
 
111
    print >>outfile
 
112
 
 
113
    outfile.write(doc)
 
114
    if doc[-1] != '\n':
 
115
        outfile.write('\n')
 
116
    help_on_command_options(cmd_object, outfile=None)
 
117
 
 
118
 
 
119
def help_on_command_options(cmd, outfile=None):
 
120
    from bzrlib.option import Option
 
121
    options = cmd.options()
111
122
    if not options:
112
123
        return
113
 
    
114
 
    print
115
 
    print 'options:'
116
 
    for on in options:
117
 
        l = '    --' + on
118
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
119
 
            if longname == on:
120
 
                l += ', -' + shortname
121
 
                break
122
 
        print l
123
 
 
124
 
 
125
 
def help_commands():
 
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 += ', -' + shortname
 
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')
 
140
 
 
141
 
 
142
def help_commands(outfile=None):
126
143
    """List all commands"""
127
 
    import inspect
128
 
    import commands
129
 
    
130
 
    accu = []
131
 
    for cmdname, cmdclass in commands.get_all_cmds():
132
 
        accu.append((cmdname, cmdclass))
133
 
    accu.sort()
134
 
    for cmdname, cmdclass in accu:
135
 
        if cmdclass.hidden:
 
144
    from bzrlib.commands import (builtin_command_names,
 
145
                                 plugin_command_names,
 
146
                                 get_cmd_object)
 
147
 
 
148
    if outfile == None:
 
149
        outfile = sys.stdout
 
150
 
 
151
    names = set()                       # to eliminate duplicates
 
152
    names.update(builtin_command_names())
 
153
    names.update(plugin_command_names())
 
154
    names = list(names)
 
155
    names.sort()
 
156
 
 
157
    for cmd_name in names:
 
158
        cmd_object = get_cmd_object(cmd_name)
 
159
        if cmd_object.hidden:
136
160
            continue
137
 
        print cmdname
138
 
        help = inspect.getdoc(cmdclass)
139
 
        if help:
140
 
            print "    " + help.split('\n', 1)[0]
141
 
            
142
 
 
 
161
        print >>outfile, command_usage(cmd_object)
 
162
        cmd_help = cmd_object.help()
 
163
        if cmd_help:
 
164
            firstline = cmd_help.split('\n', 1)[0]
 
165
            print >>outfile, '    ' + firstline
 
166