← 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: 2010-05-06 23:41:35 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506234135-yivbzczw1sejxnxc
Lock methods on ``Tree``, ``Branch`` and ``Repository`` are now
expected to return an object which can be used to unlock them. This reduces
duplicate code when using cleanups. The previous 'tokens's returned by
``Branch.lock_write`` and ``Repository.lock_write`` are now attributes
on the result of the lock_write. ``repository.RepositoryWriteLockResult``
and ``branch.BranchWriteLockResult`` document this. (Robert Collins)

``log._get_info_for_log_files`` now takes an add_cleanup callable.
(Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2010 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
Interesting commands:
33
 
 
34
 
  bzr help [COMMAND]
35
 
      Show help screen
36
 
  bzr version
37
 
      Show software version/licence/non-warranty.
38
 
  bzr init
39
 
      Start versioning the current directory
40
 
  bzr add FILE...
41
 
      Make files versioned.
42
 
  bzr log
43
 
      Show revision history.
44
 
  bzr rename FROM TO
45
 
      Rename one file.
46
 
  bzr move FROM... DESTDIR
47
 
      Move one or more files to a different directory.
48
 
  bzr diff [FILE...]
49
 
      Show changes from last revision to working copy.
50
 
  bzr commit -m 'MESSAGE'
51
 
      Store current state as new revision.
52
 
  bzr export [-r REVNO] DESTINATION
53
 
      Export the branch state at a previous version.
54
 
  bzr status
55
 
      Show summary of pending changes.
56
 
  bzr remove FILE...
57
 
      Make a file not versioned.
58
 
  bzr info
59
 
      Show statistics about this branch.
60
 
  bzr check
61
 
      Verify history is stored safely. 
62
 
  (for more type 'bzr help commands')
63
 
"""
64
 
 
65
 
 
66
 
def help(topic=None):
67
 
    if topic == None:
68
 
        print global_help
69
 
    elif topic == 'commands':
70
 
        help_commands()
71
 
    else:
72
 
        help_on_command(topic)
73
 
 
74
 
 
75
 
def help_on_command(cmdname):
76
 
    cmdname = str(cmdname)
77
 
 
78
 
    from inspect import getdoc
79
 
    import commands
80
 
    topic, cmdclass = commands.get_cmd_class(cmdname)
81
 
 
82
 
    doc = getdoc(cmdclass)
83
 
    if doc == None:
84
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
85
 
 
86
 
    if '\n' in doc:
87
 
        short, rest = doc.split('\n', 1)
88
 
    else:
89
 
        short = doc
90
 
        rest = ''
91
 
 
92
 
    print 'usage: bzr ' + topic,
93
 
    for aname in cmdclass.takes_args:
94
 
        aname = aname.upper()
95
 
        if aname[-1] in ['$', '+']:
96
 
            aname = aname[:-1] + '...'
97
 
        elif aname[-1] == '?':
98
 
            aname = '[' + aname[:-1] + ']'
99
 
        elif aname[-1] == '*':
100
 
            aname = '[' + aname[:-1] + '...]'
101
 
        print aname,
102
 
    print 
103
 
    print short
104
 
 
105
 
    if cmdclass.aliases:
106
 
        print 'aliases: ' + ', '.join(cmdclass.aliases)
107
 
    
108
 
    if rest:
109
 
        print rest
110
 
 
111
 
    help_on_option(cmdclass.takes_options)
112
 
 
113
 
 
114
 
def help_on_option(options):
115
 
    import commands
116
 
    
117
 
    if not options:
118
 
        return
119
 
    
120
 
    print
121
 
    print 'options:'
122
 
    for on in options:
123
 
        l = '    --' + on
124
 
        for shortname, longname in commands.SHORT_OPTIONS.items():
125
 
            if longname == on:
126
 
                l += ', -' + shortname
127
 
                break
128
 
        print l
129
 
 
130
 
 
131
 
def help_commands():
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
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
import sys
 
25
import textwrap
 
26
 
 
27
from bzrlib import (
 
28
    commands as _mod_commands,
 
29
    errors,
 
30
    help_topics,
 
31
    osutils,
 
32
    plugin,
 
33
    )
 
34
 
 
35
 
 
36
def help(topic=None, outfile=None):
 
37
    """Write the help for the specific topic to outfile"""
 
38
    if outfile is None:
 
39
        outfile = sys.stdout
 
40
 
 
41
    indices = HelpIndices()
 
42
 
 
43
    alias = _mod_commands.get_alias(topic)
 
44
    try:
 
45
        topics = indices.search(topic)
 
46
        shadowed_terms = []
 
47
        for index, topic in topics[1:]:
 
48
            shadowed_terms.append('%s%s' % (index.prefix,
 
49
                topic.get_help_topic()))
 
50
        source = topics[0][1]
 
51
        outfile.write(source.get_help_text(shadowed_terms))
 
52
    except errors.NoHelpTopic:
 
53
        if alias is None:
 
54
            raise
 
55
 
 
56
    if alias is not None:
 
57
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
58
            " ".join(alias)))
 
59
 
 
60
 
 
61
def help_commands(outfile=None):
132
62
    """List all commands"""
133
 
    import inspect
134
 
    import commands
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:
142
 
            continue
143
 
        print cmdname
144
 
        help = inspect.getdoc(cmdclass)
145
 
        if help:
146
 
            print "    " + help.split('\n', 1)[0]
147
 
            
148
 
 
 
63
    if outfile is None:
 
64
        outfile = sys.stdout
 
65
    outfile.write(_help_commands_to_text('commands'))
 
66
 
 
67
 
 
68
def _help_commands_to_text(topic):
 
69
    """Generate the help text for the list of commands"""
 
70
    out = []
 
71
    if topic == 'hidden-commands':
 
72
        hidden = True
 
73
    else:
 
74
        hidden = False
 
75
    names = list(_mod_commands.all_command_names())
 
76
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
77
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
78
    max_name = max(len(n) for n, o in shown_commands)
 
79
    indent = ' ' * (max_name + 1)
 
80
    width = osutils.terminal_width()
 
81
    if width is None:
 
82
        width = osutils.default_terminal_width
 
83
    # we need one extra space for terminals that wrap on last char
 
84
    width = width - 1
 
85
 
 
86
    for cmd_name, cmd_object in sorted(shown_commands):
 
87
        plugin_name = cmd_object.plugin_name()
 
88
        if plugin_name is None:
 
89
            plugin_name = ''
 
90
        else:
 
91
            plugin_name = ' [%s]' % plugin_name
 
92
 
 
93
        cmd_help = cmd_object.help()
 
94
        if cmd_help:
 
95
            firstline = cmd_help.split('\n', 1)[0]
 
96
        else:
 
97
            firstline = ''
 
98
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
99
        lines = textwrap.wrap(
 
100
            helpstring, subsequent_indent=indent,
 
101
            width=width,
 
102
            break_long_words=False)
 
103
        for line in lines:
 
104
            out.append(line + '\n')
 
105
    return ''.join(out)
 
106
 
 
107
 
 
108
help_topics.topic_registry.register("commands",
 
109
                                    _help_commands_to_text,
 
110
                                    "Basic help for all commands",
 
111
                                    help_topics.SECT_HIDDEN)
 
112
help_topics.topic_registry.register("hidden-commands",
 
113
                                    _help_commands_to_text,
 
114
                                    "All hidden commands",
 
115
                                    help_topics.SECT_HIDDEN)
 
116
 
 
117
 
 
118
class HelpIndices(object):
 
119
    """Maintainer of help topics across multiple indices.
 
120
 
 
121
    It is currently separate to the HelpTopicRegistry because of its ordered
 
122
    nature, but possibly we should instead structure it as a search within the
 
123
    registry and add ordering and searching facilities to the registry. The
 
124
    registry would probably need to be restructured to support that cleanly
 
125
    which is why this has been implemented in parallel even though it does as a
 
126
    result permit searching for help in indices which are not discoverable via
 
127
    'help topics'.
 
128
 
 
129
    Each index has a unique prefix string, such as "commands", and contains
 
130
    help topics which can be listed or searched.
 
131
    """
 
132
 
 
133
    def __init__(self):
 
134
        self.search_path = [
 
135
            help_topics.HelpTopicIndex(),
 
136
            _mod_commands.HelpCommandIndex(),
 
137
            plugin.PluginsHelpIndex(),
 
138
            ]
 
139
 
 
140
    def _check_prefix_uniqueness(self):
 
141
        """Ensure that the index collection is able to differentiate safely."""
 
142
        prefixes = {}
 
143
        for index in self.search_path:
 
144
            prefixes.setdefault(index.prefix, []).append(index)
 
145
        for prefix, indices in prefixes.items():
 
146
            if len(indices) > 1:
 
147
                raise errors.DuplicateHelpPrefix(prefix)
 
148
 
 
149
    def search(self, topic):
 
150
        """Search for topic across the help search path.
 
151
 
 
152
        :param topic: A string naming the help topic to search for.
 
153
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
154
        :return: A list of HelpTopics which matched 'topic'.
 
155
        """
 
156
        self._check_prefix_uniqueness()
 
157
        result = []
 
158
        for index in self.search_path:
 
159
            result.extend([(index, _topic) for _topic in index.get_topics(topic)])
 
160
        if not result:
 
161
            raise errors.NoHelpTopic(topic)
 
162
        else:
 
163
            return result