/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

merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help.py
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.
40
40
        outfile = sys.stdout
41
41
 
42
42
    indices = HelpIndices()
43
 
    topics = indices.search(topic)
44
 
    shadowed_terms = []
45
 
    for index, topic in topics[1:]:
46
 
        shadowed_terms.append('%s%s' % (index.prefix, topic.get_help_topic()))
47
 
    outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
43
 
 
44
    alias = _mod_commands.get_alias(topic)
 
45
    try:
 
46
        topics = indices.search(topic)
 
47
        shadowed_terms = []
 
48
        for index, topic in topics[1:]:
 
49
            shadowed_terms.append('%s%s' % (index.prefix,
 
50
                topic.get_help_topic()))
 
51
        source = topics[0][1]
 
52
        outfile.write(source.get_help_text(shadowed_terms))
 
53
    except errors.NoHelpTopic:
 
54
        if alias is None:
 
55
            raise
 
56
 
 
57
    if alias is not None:
 
58
        outfile.write("'bzr %s' is an alias for 'bzr %s'.\n" % (topic,
 
59
            " ".join(alias)))
48
60
 
49
61
 
50
62
def help_commands(outfile=None):
54
66
    outfile.write(_help_commands_to_text('commands'))
55
67
 
56
68
 
57
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
58
 
def command_usage(cmd):
59
 
    return cmd._usage()
60
 
 
61
 
 
62
69
def _help_commands_to_text(topic):
63
70
    """Generate the help text for the list of commands"""
64
71
    out = []
106
113
 
107
114
class HelpIndices(object):
108
115
    """Maintainer of help topics across multiple indices.
109
 
    
 
116
 
110
117
    It is currently separate to the HelpTopicRegistry because of its ordered
111
118
    nature, but possibly we should instead structure it as a search within the
112
119
    registry and add ordering and searching facilities to the registry. The
137
144
 
138
145
    def search(self, topic):
139
146
        """Search for topic across the help search path.
140
 
        
 
147
 
141
148
        :param topic: A string naming the help topic to search for.
142
149
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
143
150
        :return: A list of HelpTopics which matched 'topic'.