← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

merge merge tweaks from aaron, which includes latest .dev

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
 
17
24
global_help = \
18
25
"""Bazaar-NG -- a free distributed version-control tool
19
26
http://bazaar-ng.org/
20
27
 
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.
 
28
WARNING: This is an unstable development version.
 
29
         Please keep backups.
 
30
 
 
31
Basic commands:
 
32
 
 
33
  bzr init           makes this directory a versioned branch
 
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         save some or all changes
 
45
 
 
46
  bzr log            show history of changes
 
47
  bzr check          validate storage
 
48
 
 
49
  bzr help init      more help on e.g. init command
 
50
  bzr help commands  list all commands
56
51
"""
57
52
 
58
53
 
70
65
        help_on_command(topic, outfile = outfile)
71
66
 
72
67
 
73
 
def command_usage(cmdname, cmdclass):
 
68
def command_usage(cmd_object):
74
69
    """Return single-line grammar for command.
75
70
 
76
71
    Only describes arguments, not options.
77
72
    """
78
 
    s = cmdname + ' '
79
 
    for aname in cmdclass.takes_args:
 
73
    s = 'bzr ' + cmd_object.name() + ' '
 
74
    for aname in cmd_object.takes_args:
80
75
        aname = aname.upper()
81
76
        if aname[-1] in ['$', '+']:
82
77
            aname = aname[:-1] + '...'
92
87
    return s
93
88
 
94
89
 
95
 
def help_on_command(cmdname, outfile = None):
 
90
def help_on_command(cmdname, outfile=None):
 
91
    from bzrlib.commands import get_cmd_object
 
92
 
96
93
    cmdname = str(cmdname)
97
94
 
98
95
    if outfile == None:
99
96
        outfile = sys.stdout
100
97
 
101
 
    from inspect import getdoc
102
 
    import commands
103
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
 
98
    cmd_object = get_cmd_object(cmdname)
104
99
 
105
 
    doc = getdoc(cmdclass)
 
100
    doc = cmd_object.help()
106
101
    if doc == None:
107
102
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
108
103
 
109
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
110
 
 
111
 
    if cmdclass.aliases:
112
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
113
 
    
 
104
    print >>outfile, 'usage:', command_usage(cmd_object) 
 
105
 
 
106
    if cmd_object.aliases:
 
107
        print >>outfile, 'aliases:',
 
108
        print >>outfile, ', '.join(cmd_object.aliases)
 
109
 
 
110
    print >>outfile
 
111
 
114
112
    outfile.write(doc)
 
113
    if doc[-1] != '\n':
 
114
        outfile.write('\n')
115
115
    
116
 
    help_on_option(cmdclass.takes_options, outfile = None)
117
 
 
118
 
 
119
 
def help_on_option(options, outfile = None):
120
 
    import commands
 
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
121
    
122
122
    if not options:
123
123
        return
128
128
    outfile.write('\noptions:\n')
129
129
    for on in options:
130
130
        l = '    --' + on
131
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
 
131
        for shortname, longname in SHORT_OPTIONS.items():
132
132
            if longname == on:
133
133
                l += ', -' + shortname
134
134
                break
135
135
        outfile.write(l + '\n')
136
136
 
137
137
 
138
 
def help_commands(outfile = None):
 
138
def help_commands(outfile=None):
139
139
    """List all commands"""
140
 
    import inspect
141
 
    import commands
 
140
    from bzrlib.commands import (builtin_command_names,
 
141
                                 plugin_command_names,
 
142
                                 get_cmd_object)
142
143
 
143
144
    if outfile == None:
144
145
        outfile = sys.stdout
145
 
    
146
 
    accu = []
147
 
    for cmdname, cmdclass in commands.get_all_cmds():
148
 
        accu.append((cmdname, cmdclass))
149
 
    accu.sort()
150
 
    for cmdname, cmdclass in accu:
151
 
        if cmdclass.hidden:
 
146
 
 
147
    names = set()                       # to eliminate duplicates
 
148
    names.update(builtin_command_names())
 
149
    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:
152
156
            continue
153
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
154
 
        help = inspect.getdoc(cmdclass)
155
 
        if help:
156
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
157
 
 
158
 
            
159
 
 
 
157
        print >>outfile, command_usage(cmd_object)
 
158
        cmd_help = cmd_object.help()
 
159
        if cmd_help:
 
160
            firstline = cmd_help.split('\n', 1)[0]
 
161
            print >>outfile, '    ' + firstline
 
162