← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help.py

  • Committer: Ian Clatworthy
  • Date: 2009-09-09 11:43:10 UTC
  • mto: (4634.37.2 prepare-2.0)
  • mto: This revision was merged to the branch mainline in revision 4689.
  • Revision ID: ian.clatworthy@canonical.com-20090909114310-glw7tv76i5gnx9pt
put rules back in Makefile supporting plain-style docs

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.
48
48
        for index, topic in topics[1:]:
49
49
            shadowed_terms.append('%s%s' % (index.prefix,
50
50
                topic.get_help_topic()))
51
 
        outfile.write(topics[0][1].get_help_text(shadowed_terms))
 
51
        source = topics[0][1]
 
52
        outfile.write(source.get_help_text(shadowed_terms))
52
53
    except errors.NoHelpTopic:
53
54
        if alias is None:
54
55
            raise
65
66
    outfile.write(_help_commands_to_text('commands'))
66
67
 
67
68
 
68
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_sixteen)
69
 
def command_usage(cmd):
70
 
    return cmd._usage()
71
 
 
72
 
 
73
69
def _help_commands_to_text(topic):
74
70
    """Generate the help text for the list of commands"""
75
71
    out = []
77
73
        hidden = True
78
74
    else:
79
75
        hidden = False
80
 
    names = set(_mod_commands.builtin_command_names()) # to eliminate duplicates
81
 
    names.update(_mod_commands.plugin_command_names())
 
76
    names = list(_mod_commands.all_command_names())
82
77
    commands = ((n, _mod_commands.get_cmd_object(n)) for n in names)
83
78
    shown_commands = [(n, o) for n, o in commands if o.hidden == hidden]
84
79
    max_name = max(len(n) for n, o in shown_commands)
98
93
        else:
99
94
            firstline = ''
100
95
        helpstring = '%-*s %s%s' % (max_name, cmd_name, firstline, plugin_name)
101
 
        lines = textwrap.wrap(helpstring, subsequent_indent=indent,
102
 
                              width=width)
 
96
        lines = textwrap.wrap(
 
97
            helpstring, subsequent_indent=indent,
 
98
            width=width,
 
99
            break_long_words=False)
103
100
        for line in lines:
104
101
            out.append(line + '\n')
105
102
    return ''.join(out)
117
114
 
118
115
class HelpIndices(object):
119
116
    """Maintainer of help topics across multiple indices.
120
 
    
 
117
 
121
118
    It is currently separate to the HelpTopicRegistry because of its ordered
122
119
    nature, but possibly we should instead structure it as a search within the
123
120
    registry and add ordering and searching facilities to the registry. The
148
145
 
149
146
    def search(self, topic):
150
147
        """Search for topic across the help search path.
151
 
        
 
148
 
152
149
        :param topic: A string naming the help topic to search for.
153
150
        :raises: NoHelpTopic if none of the indexs in search_path have topic.
154
151
        :return: A list of HelpTopics which matched 'topic'.