/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/help.py

Fix formatting, remove catch-all for exceptions when opening local repositories.

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
 
 
60
 
def help(topic=None):
61
 
    if topic == None:
62
 
        print global_help
63
 
    elif topic == 'commands':
64
 
        help_commands()
65
 
    else:
66
 
        help_on_command(topic)
67
 
 
68
 
 
69
 
def command_usage(cmdname, cmdclass):
70
 
    """Return single-line grammar for command.
71
 
 
72
 
    Only describes arguments, not options.
73
 
    """
74
 
    s = cmdname + ' '
75
 
    for aname in cmdclass.takes_args:
76
 
        aname = aname.upper()
77
 
        if aname[-1] in ['$', '+']:
78
 
            aname = aname[:-1] + '...'
79
 
        elif aname[-1] == '?':
80
 
            aname = '[' + aname[:-1] + ']'
81
 
        elif aname[-1] == '*':
82
 
            aname = '[' + aname[:-1] + '...]'
83
 
        s += aname + ' '
84
 
            
85
 
    assert s[-1] == ' '
86
 
    s = s[:-1]
87
 
    
88
 
    return s
89
 
 
90
 
 
91
 
def help_on_command(cmdname):
92
 
    cmdname = str(cmdname)
93
 
 
94
 
    from inspect import getdoc
95
 
    import commands
96
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
97
 
 
98
 
    doc = getdoc(cmdclass)
99
 
    if doc == None:
100
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
101
 
 
102
 
    print 'usage:', command_usage(topic, cmdclass)
103
 
 
104
 
    if cmdclass.aliases:
105
 
        print 'aliases: ' + ', '.join(cmdclass.aliases)
106
 
    
107
 
    print doc
108
 
    
109
 
    help_on_option(cmdclass.takes_options)
110
 
 
111
 
 
112
 
def help_on_option(options):
113
 
    import commands
114
 
    
115
 
    if not options:
116
 
        return
117
 
    
118
 
    print
119
 
    print 'options:'
120
 
    for on in options:
121
 
        l = '    --' + on
122
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
123
 
            if longname == on:
124
 
                l += ', -' + shortname
125
 
                break
126
 
        print l
127
 
 
128
 
 
129
 
def help_commands():
130
 
    """List all commands"""
131
 
    import inspect
132
 
    import commands
133
 
    
134
 
    accu = []
135
 
    for cmdname, cmdclass in commands.get_all_cmds():
136
 
        accu.append((cmdname, cmdclass))
137
 
    accu.sort()
138
 
    for cmdname, cmdclass in accu:
139
 
        if cmdclass.hidden:
140
 
            continue
141
 
        print command_usage(cmdname, cmdclass)
142
 
        help = inspect.getdoc(cmdclass)
143
 
        if help:
144
 
            print "    " + help.split('\n', 1)[0]
145
 
            
146