/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 breezy/help.py

  • Committer: Gustav Hartvigsson
  • Date: 2021-01-09 21:36:27 UTC
  • Revision ID: gustav.hartvigsson@gmail.com-20210109213627-h1xwcutzy9m7a99b
Added 'Case Preserving Working Tree Use Cases' from Canonical Wiki

* Addod a page from the Canonical Bazaar wiki
  with information on the scmeatics of case
  perserving filesystems an a case insensitive
  filesystem works.
  
  * Needs re-work, but this will do as it is the
    same inforamoton as what was on the linked
    page in the currint documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/help.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2011 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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
# TODO: Some way to get a list of external commands (defined by shell
18
18
# scripts) so that they can be included in the help listing as well.
21
21
 
22
22
# TODO: `help commands --all` should show hidden commands
23
23
 
24
 
global_help = \
25
 
"""Bazaar-NG -- a free distributed version-control tool
26
 
http://bazaar-ng.org/
27
 
 
28
 
WARNING: This is an unstable development version.
29
 
         Please keep backups.
30
 
 
31
 
Basic commands:
32
 
 
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
51
 
"""
52
 
 
53
 
 
54
 
import sys
55
 
 
56
 
 
57
 
def help(topic=None, outfile = None):
58
 
    if outfile == None:
59
 
        outfile = sys.stdout
60
 
    if topic == None:
61
 
        outfile.write(global_help)
62
 
    elif topic == 'commands':
63
 
        help_commands(outfile = outfile)
64
 
    else:
65
 
        help_on_command(topic, outfile = outfile)
66
 
 
67
 
 
68
 
def command_usage(cmd_object):
69
 
    """Return single-line grammar for command.
70
 
 
71
 
    Only describes arguments, not options.
72
 
    """
73
 
    s = 'bzr ' + cmd_object.name() + ' '
74
 
    for aname in cmd_object.takes_args:
75
 
        aname = aname.upper()
76
 
        if aname[-1] in ['$', '+']:
77
 
            aname = aname[:-1] + '...'
78
 
        elif aname[-1] == '?':
79
 
            aname = '[' + aname[:-1] + ']'
80
 
        elif aname[-1] == '*':
81
 
            aname = '[' + aname[:-1] + '...]'
82
 
        s += aname + ' '
83
 
            
84
 
    assert s[-1] == ' '
85
 
    s = s[:-1]
86
 
    
87
 
    return s
88
 
 
89
 
 
90
 
def help_on_command(cmdname, outfile=None):
91
 
    from bzrlib.commands import get_cmd_object
92
 
 
93
 
    cmdname = str(cmdname)
94
 
 
95
 
    if outfile == None:
96
 
        outfile = sys.stdout
97
 
 
98
 
    cmd_object = get_cmd_object(cmdname)
99
 
 
100
 
    doc = cmd_object.help()
101
 
    if doc == None:
102
 
        raise NotImplementedError("sorry, no detailed help yet for %r" % cmdname)
103
 
 
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
 
 
112
 
    outfile.write(doc)
113
 
    if doc[-1] != '\n':
114
 
        outfile.write('\n')
115
 
    
116
 
    help_on_options(cmd_object.takes_options, outfile=None)
117
 
 
118
 
 
119
 
def help_on_options(options, outfile=None):
120
 
    from bzrlib.commands import SHORT_OPTIONS
121
 
    
122
 
    if not options:
123
 
        return
124
 
    
125
 
    if outfile == None:
126
 
        outfile = sys.stdout
127
 
 
128
 
    outfile.write('\noptions:\n')
129
 
    for on in options:
130
 
        l = '    --' + on
131
 
        for shortname, longname in SHORT_OPTIONS.items():
132
 
            if longname == on:
133
 
                l += ', -' + shortname
134
 
                break
135
 
        outfile.write(l + '\n')
 
24
from . import (
 
25
    commands as _mod_commands,
 
26
    errors,
 
27
    help_topics,
 
28
    osutils,
 
29
    plugin,
 
30
    ui,
 
31
    utextwrap,
 
32
    )
 
33
 
 
34
 
 
35
class NoHelpTopic(errors.BzrError):
 
36
 
 
37
    _fmt = ("No help could be found for '%(topic)s'. "
 
38
            "Please use 'brz help topics' to obtain a list of topics.")
 
39
 
 
40
    def __init__(self, topic):
 
41
        self.topic = topic
 
42
 
 
43
 
 
44
def help(topic=None, outfile=None):
 
45
    """Write the help for the specific topic to outfile"""
 
46
    if outfile is None:
 
47
        outfile = ui.ui_factory.make_output_stream()
 
48
 
 
49
    indices = HelpIndices()
 
50
 
 
51
    alias = _mod_commands.get_alias(topic)
 
52
    try:
 
53
        topics = indices.search(topic)
 
54
        shadowed_terms = []
 
55
        for index, topic_obj in topics[1:]:
 
56
            shadowed_terms.append('%s%s' % (index.prefix,
 
57
                                            topic_obj.get_help_topic()))
 
58
        source = topics[0][1]
 
59
        outfile.write(source.get_help_text(shadowed_terms))
 
60
    except NoHelpTopic:
 
61
        if alias is None:
 
62
            raise
 
63
 
 
64
    if alias is not None:
 
65
        outfile.write("'brz %s' is an alias for 'brz %s'.\n" % (topic,
 
66
                                                                " ".join(alias)))
136
67
 
137
68
 
138
69
def help_commands(outfile=None):
139
70
    """List all commands"""
140
 
    from bzrlib.commands import (builtin_command_names,
141
 
                                 plugin_command_names,
142
 
                                 get_cmd_object)
143
 
 
144
 
    if outfile == None:
145
 
        outfile = sys.stdout
146
 
 
147
 
    names = set()                       # to eliminate duplicates
148
 
    names.update(builtin_command_names())
149
 
    names.update(plugin_command_names())
150
 
    names = list(names)
151
 
    names.sort()
152
 
 
153
 
    for cmd_name in names:
154
 
        cmd_object = get_cmd_object(cmd_name)
155
 
        if cmd_object.hidden:
156
 
            continue
157
 
        print >>outfile, command_usage(cmd_object)
 
71
    if outfile is None:
 
72
        outfile = ui.ui_factory.make_output_stream()
 
73
    outfile.write(_help_commands_to_text('commands'))
 
74
 
 
75
 
 
76
def _help_commands_to_text(topic):
 
77
    """Generate the help text for the list of commands"""
 
78
    out = []
 
79
    if topic == 'hidden-commands':
 
80
        hidden = True
 
81
    else:
 
82
        hidden = False
 
83
    names = list(_mod_commands.all_command_names())
 
84
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
 
85
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
 
86
    max_name = max(len(n) for n, o in shown_commands)
 
87
    indent = ' ' * (max_name + 1)
 
88
    width = osutils.terminal_width()
 
89
    if width is None:
 
90
        width = osutils.default_terminal_width
 
91
    # we need one extra space for terminals that wrap on last char
 
92
    width = width - 1
 
93
 
 
94
    for cmd_name, cmd_object in sorted(shown_commands):
 
95
        plugin_name = cmd_object.plugin_name()
 
96
        if plugin_name is None:
 
97
            plugin_name = ''
 
98
        else:
 
99
            plugin_name = ' [%s]' % plugin_name
 
100
 
158
101
        cmd_help = cmd_object.help()
159
102
        if cmd_help:
160
103
            firstline = cmd_help.split('\n', 1)[0]
161
 
            print >>outfile, '    ' + firstline
162
 
        
 
104
        else:
 
105
            firstline = ''
 
106
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
 
107
        lines = utextwrap.wrap(
 
108
            helpstring, subsequent_indent=indent,
 
109
            width=width,
 
110
            break_long_words=False)
 
111
        for line in lines:
 
112
            out.append(line + '\n')
 
113
    return ''.join(out)
 
114
 
 
115
 
 
116
help_topics.topic_registry.register("commands",
 
117
                                    _help_commands_to_text,
 
118
                                    "Basic help for all commands",
 
119
                                    help_topics.SECT_HIDDEN)
 
120
help_topics.topic_registry.register("hidden-commands",
 
121
                                    _help_commands_to_text,
 
122
                                    "All hidden commands",
 
123
                                    help_topics.SECT_HIDDEN)
 
124
 
 
125
 
 
126
class HelpIndices(object):
 
127
    """Maintainer of help topics across multiple indices.
 
128
 
 
129
    It is currently separate to the HelpTopicRegistry because of its ordered
 
130
    nature, but possibly we should instead structure it as a search within the
 
131
    registry and add ordering and searching facilities to the registry. The
 
132
    registry would probably need to be restructured to support that cleanly
 
133
    which is why this has been implemented in parallel even though it does as a
 
134
    result permit searching for help in indices which are not discoverable via
 
135
    'help topics'.
 
136
 
 
137
    Each index has a unique prefix string, such as "commands", and contains
 
138
    help topics which can be listed or searched.
 
139
    """
 
140
 
 
141
    def __init__(self):
 
142
        self.search_path = [
 
143
            help_topics.HelpTopicIndex(),
 
144
            _mod_commands.HelpCommandIndex(),
 
145
            plugin.PluginsHelpIndex(),
 
146
            help_topics.ConfigOptionHelpIndex(),
 
147
            ]
 
148
 
 
149
    def _check_prefix_uniqueness(self):
 
150
        """Ensure that the index collection is able to differentiate safely."""
 
151
        prefixes = set()
 
152
        for index in self.search_path:
 
153
            prefix = index.prefix
 
154
            if prefix in prefixes:
 
155
                raise errors.DuplicateHelpPrefix(prefix)
 
156
            prefixes.add(prefix)
 
157
 
 
158
    def search(self, topic):
 
159
        """Search for topic across the help search path.
 
160
 
 
161
        :param topic: A string naming the help topic to search for.
 
162
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
 
163
        :return: A list of HelpTopics which matched 'topic'.
 
164
        """
 
165
        self._check_prefix_uniqueness()
 
166
        result = []
 
167
        for index in self.search_path:
 
168
            result.extend([(index, _topic)
 
169
                           for _topic in index.get_topics(topic)])
 
170
        if not result:
 
171
            raise NoHelpTopic(topic)
 
172
        else:
 
173
            return result