← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics.py

move reference material out of User Guide into User Reference

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics.py
128
128
    return ''.join(out)
129
129
 
130
130
 
 
131
def _load_from_file(topic_name):
 
132
    """Load help from a file.
 
133
 
 
134
    The help is already expected to be in ReStructuredText format.
 
135
    """
 
136
    # FIXME ...
 
137
    bzr_dir = "."
 
138
    filename = "%s/doc/en/user-reference/%s.txt" % (bzr_dir,topic_name)
 
139
    lines = open(filename).readlines()
 
140
    return ''.join(lines)
 
141
 
 
142
 
131
143
def _help_on_revisionspec(name):
132
144
    """Generate the help for revision specs."""
133
145
    import re
606
618
topic_registry.register('files', _files,
607
619
                        'Information on configuration and log files')
608
620
 
 
621
# Load some of the help topics from files
 
622
topic_registry.register('authentication', _load_from_file,
 
623
                        'Information on configuring authentication')
 
624
topic_registry.register('configuration', _load_from_file,
 
625
                        'Details on the configuration settings available')
 
626
topic_registry.register('conflicts', _load_from_file,
 
627
                        'Types of conflicts and what to do about them')
 
628
topic_registry.register('hooks', _load_from_file,
 
629
                        'Points at which custom processing can be added')
 
630
 
609
631
 
610
632
# Register concept topics.
611
633
# Note that we might choose to remove these from the online help in the