← 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-04-26 05:20:17 UTC
  • Revision ID: mbp@sourcefrog.net-20050426052016-8445d0f4fec584d0
- move all TODO items into ./TODO

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
3
 
# This program is free software; you can redistribute it and/or modify
4
 
# it under the terms of the GNU General Public License as published by
5
 
# the Free Software Foundation; either version 2 of the License, or
6
 
# (at your option) any later version.
7
 
 
8
 
# This program is distributed in the hope that it will be useful,
9
 
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
 
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
 
# GNU General Public License for more details.
12
 
 
13
 
# You should have received a copy of the GNU General Public License
14
 
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
global_help = \
18
 
"""Bazaar-NG -- a free distributed version-control tool
19
 
http://bazaar-ng.org/
20
 
 
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.
56
 
"""
57
 
 
58
 
 
59
 
import sys
60
 
 
61
 
 
62
 
def help(topic=None, outfile = None):
63
 
    if outfile == None:
64
 
        outfile = sys.stdout
65
 
    if topic == None:
66
 
        outfile.write(global_help)
67
 
    elif topic == 'commands':
68
 
        help_commands(outfile = outfile)
69
 
    else:
70
 
        help_on_command(topic, outfile = outfile)
71
 
 
72
 
 
73
 
def command_usage(cmdname, cmdclass):
74
 
    """Return single-line grammar for command.
75
 
 
76
 
    Only describes arguments, not options.
77
 
    """
78
 
    s = cmdname + ' '
79
 
    for aname in cmdclass.takes_args:
80
 
        aname = aname.upper()
81
 
        if aname[-1] in ['$', '+']:
82
 
            aname = aname[:-1] + '...'
83
 
        elif aname[-1] == '?':
84
 
            aname = '[' + aname[:-1] + ']'
85
 
        elif aname[-1] == '*':
86
 
            aname = '[' + aname[:-1] + '...]'
87
 
        s += aname + ' '
88
 
            
89
 
    assert s[-1] == ' '
90
 
    s = s[:-1]
91
 
    
92
 
    return s
93
 
 
94
 
 
95
 
def help_on_command(cmdname, outfile = None):
96
 
    cmdname = str(cmdname)
97
 
 
98
 
    if outfile == None:
99
 
        outfile = sys.stdout
100
 
 
101
 
    from inspect import getdoc
102
 
    import commands
103
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
104
 
 
105
 
    doc = getdoc(cmdclass)
106
 
    if doc == None:
107
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
108
 
 
109
 
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
110
 
 
111
 
    if cmdclass.aliases:
112
 
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
113
 
    
114
 
    outfile.write(doc)
115
 
    if doc[-1] != '\n':
116
 
        outfile.write('\n')
117
 
    
118
 
    help_on_option(cmdclass.takes_options, outfile = None)
119
 
 
120
 
 
121
 
def help_on_option(options, outfile = None):
122
 
    import commands
123
 
    
124
 
    if not options:
125
 
        return
126
 
    
127
 
    if outfile == None:
128
 
        outfile = sys.stdout
129
 
 
130
 
    outfile.write('\noptions:\n')
131
 
    for on in options:
132
 
        l = '    --' + on
133
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
134
 
            if longname == on:
135
 
                l += ', -' + shortname
136
 
                break
137
 
        outfile.write(l + '\n')
138
 
 
139
 
 
140
 
def help_commands(outfile = None):
141
 
    """List all commands"""
142
 
    import inspect
143
 
    import commands
144
 
 
145
 
    if outfile == None:
146
 
        outfile = sys.stdout
147
 
    
148
 
    accu = []
149
 
    for cmdname, cmdclass in commands.get_all_cmds():
150
 
        accu.append((cmdname, cmdclass))
151
 
    accu.sort()
152
 
    for cmdname, cmdclass in accu:
153
 
        if cmdclass.hidden:
154
 
            continue
155
 
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
156
 
        help = inspect.getdoc(cmdclass)
157
 
        if help:
158
 
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
159
 
 
160
 
            
161