← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: John Arbash Meinel
  • Date: 2007-04-26 22:56:01 UTC
  • mto: This revision was merged to the branch mainline in revision 2471.
  • Revision ID: john@arbash-meinel.com-20070426225601-ae4qfcb8bzcfomny
Clean up the (failing) test so that the last thing
to fail is what I'm fixing.

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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
 
 
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)))
 
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))
60
48
 
61
49
 
62
50
def help_commands(outfile=None):
66
54
    outfile.write(_help_commands_to_text('commands'))
67
55
 
68
56
 
 
57
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
 
58
def command_usage(cmd):
 
59
    return cmd._usage()
 
60
 
 
61
 
69
62
def _help_commands_to_text(topic):
70
63
    """Generate the help text for the list of commands"""
71
64
    out = []
103
96
 
104
97
help_topics.topic_registry.register("commands",
105
98
                                    _help_commands_to_text,
106
 
                                    "Basic help for all commands",
107
 
                                    help_topics.SECT_HIDDEN)
 
99
                                    "Basic help for all commands")
108
100
help_topics.topic_registry.register("hidden-commands",
109
101
                                    _help_commands_to_text,
110
 
                                    "All hidden commands",
111
 
                                    help_topics.SECT_HIDDEN)
 
102
                                    "All hidden commands")
112
103
 
113
104
 
114
105
class HelpIndices(object):
115
106
    """Maintainer of help topics across multiple indices.
116
 
 
 
107
    
117
108
    It is currently separate to the HelpTopicRegistry because of its ordered
118
109
    nature, but possibly we should instead structure it as a search within the
119
110
    registry and add ordering and searching facilities to the registry. The
144
135
 
145
136
    def search(self, topic):
146
137
        """Search for topic across the help search path.
147
 
 
 
138
        
148
139
        :param topic: A string naming the help topic to search for.
149
140
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
150
141
        :return: A list of HelpTopics which matched 'topic'.