← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Robert Collins
  • Date: 2005-08-25 02:43:15 UTC
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825024315-01e64162aa925ac3
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry

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
 
 
24
17
global_help = \
25
18
"""Bazaar-NG -- a free distributed version-control tool
26
19
http://bazaar-ng.org/
30
23
 
31
24
Basic commands:
32
25
 
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
 
26
  bzr init      makes this branch versioned
 
27
  bzr branch    make a copy of another branch
 
28
 
 
29
  bzr add       make files or directories versioned
 
30
  bzr ignore    ignore a file or pattern
 
31
  bzr mv        move or rename a versioned file
 
32
 
 
33
  bzr status    summarize changes in working copy
 
34
  bzr diff      show detailed diffs
 
35
 
 
36
  bzr merge     pull in changes from another branch
 
37
  bzr commit    
 
38
 
 
39
  bzr log       show history of changes
 
40
  bzr check     validate storage
 
41
 
 
42
Use e.g. 'bzr help init' for more details, or
 
43
'bzr help commands' for all commands.
51
44
"""
52
45
 
53
46
 
65
58
        help_on_command(topic, outfile = outfile)
66
59
 
67
60
 
68
 
def command_usage(cmd_object):
 
61
def command_usage(cmdname, cmdclass):
69
62
    """Return single-line grammar for command.
70
63
 
71
64
    Only describes arguments, not options.
72
65
    """
73
 
    s = 'bzr ' + cmd_object.name() + ' '
74
 
    for aname in cmd_object.takes_args:
 
66
    s = cmdname + ' '
 
67
    for aname in cmdclass.takes_args:
75
68
        aname = aname.upper()
76
69
        if aname[-1] in ['$', '+']:
77
70
            aname = aname[:-1] + '...'
87
80
    return s
88
81
 
89
82
 
90
 
def help_on_command(cmdname, outfile=None):
91
 
    from bzrlib.commands import get_cmd_object
92
 
 
 
83
def help_on_command(cmdname, outfile = None):
93
84
    cmdname = str(cmdname)
94
85
 
95
86
    if outfile == None:
96
87
        outfile = sys.stdout
97
88
 
98
 
    cmd_object = get_cmd_object(cmdname)
 
89
    from inspect import getdoc
 
90
    import commands
 
91
    topic, cmdclass = commands.get_cmd_class(cmdname)
99
92
 
100
 
    doc = cmd_object.help()
 
93
    doc = getdoc(cmdclass)
101
94
    if doc == None:
102
95
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
103
96
 
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
 
 
 
97
    outfile.write('usage: ' + command_usage(topic, cmdclass) + '\n')
 
98
 
 
99
    if cmdclass.aliases:
 
100
        outfile.write('aliases: ' + ', '.join(cmdclass.aliases) + '\n')
 
101
    
112
102
    outfile.write(doc)
113
103
    if doc[-1] != '\n':
114
104
        outfile.write('\n')
115
 
    help_on_command_options(cmd_object, outfile=None)
116
 
 
117
 
 
118
 
def help_on_command_options(cmd, outfile=None):
119
 
    from bzrlib.option import Option
120
 
    options = cmd.options()
 
105
    
 
106
    help_on_option(cmdclass.takes_options, outfile = None)
 
107
 
 
108
 
 
109
def help_on_option(options, outfile = None):
 
110
    import commands
 
111
    
121
112
    if not options:
122
113
        return
 
114
    
123
115
    if outfile == None:
124
116
        outfile = sys.stdout
 
117
 
125
118
    outfile.write('\noptions:\n')
126
 
    for option_name, option in sorted(options.items()):
127
 
        l = '    --' + option_name
128
 
        if option.type is not None:
129
 
            l += ' ' + option.argname.upper()
130
 
        short_name = option.short_name()
131
 
        if short_name:
132
 
            assert len(short_name) == 1
133
 
            l += ', -' + shortname
134
 
        l += (30 - len(l)) * ' ' + option.help
135
 
        # TODO: split help over multiple lines with correct indenting and 
136
 
        # wrapping
 
119
    for on in options:
 
120
        l = '    --' + on
 
121
        for shortname, longname in commands.SHORT_OPTIONS.items():
 
122
            if longname == on:
 
123
                l += ', -' + shortname
 
124
                break
137
125
        outfile.write(l + '\n')
138
126
 
139
127
 
140
 
def help_commands(outfile=None):
 
128
def help_commands(outfile = None):
141
129
    """List all commands"""
142
 
    from bzrlib.commands import (builtin_command_names,
143
 
                                 plugin_command_names,
144
 
                                 get_cmd_object)
 
130
    import inspect
 
131
    import commands
145
132
 
146
133
    if outfile == None:
147
134
        outfile = sys.stdout
148
 
 
149
 
    names = set()                       # to eliminate duplicates
150
 
    names.update(builtin_command_names())
151
 
    names.update(plugin_command_names())
152
 
    names = list(names)
153
 
    names.sort()
154
 
 
155
 
    for cmd_name in names:
156
 
        cmd_object = get_cmd_object(cmd_name)
157
 
        if cmd_object.hidden:
 
135
    
 
136
    accu = []
 
137
    for cmdname, cmdclass in commands.get_all_cmds():
 
138
        accu.append((cmdname, cmdclass))
 
139
    accu.sort()
 
140
    for cmdname, cmdclass in accu:
 
141
        if cmdclass.hidden:
158
142
            continue
159
 
        print >>outfile, command_usage(cmd_object)
160
 
        cmd_help = cmd_object.help()
161
 
        if cmd_help:
162
 
            firstline = cmd_help.split('\n', 1)[0]
163
 
            print >>outfile, '    ' + firstline
164
 
        
 
143
        outfile.write(command_usage(cmdname, cmdclass) + '\n')
 
144
        help = inspect.getdoc(cmdclass)
 
145
        if help:
 
146
            outfile.write("    " + help.split('\n', 1)[0] + '\n')
 
147
 
 
148
            
 
149