← 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: 2007-12-07 04:21:59 UTC
  • mto: This revision was merged to the branch mainline in revision 3092.
  • Revision ID: ian.clatworthy@internode.on.net-20071207042159-n9rmhanqid1l7olh
Better PDF for Qiock Start Card (Ian Clatworthy)

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