← 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-08-17 02:06:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050817020618-c7ae430253df8532
- rearrangement of modules, contributed by Gustavo Niemeyer


1) Moved plugins directory to bzrlib/, so that there's a standard
  plugin directory which is not only installed with bzr itself
  but is also available when using bzr from the development tree.
  BZR_PLUGIN_PATH and DEFAULT_PLUGIN_PATH are then added to the
  standard plugins directory.

2) Moved the needed third-party tools to an internal directory under
  bzrlib/util.  This makes sure that needed tools are available in
  the bzr installation, including the correct/expected version, and
  eases the process of packaging and redistribution of bzr
  ('setup.py bdist*' creates a working distribution).

3) Fixed setup.py including the needed package entries.

I hope you find them useful.

Show diffs side-by-side

added added

removed removed

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