← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/__init__.py

  • Committer: Andrew Bennetts
  • Date: 2010-01-13 23:16:20 UTC
  • mfrom: (4957 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4960.
  • Revision ID: andrew.bennetts@canonical.com-20100113231620-n6in2yjib2v6z03g
Merge lp:bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/__init__.py
306
306
"""Global Options
307
307
 
308
308
These options may be used with any command, and may appear in front of any
309
 
command.  (e.g. "bzr --profile help").
 
309
command.  (e.g. ``bzr --profile help``).
310
310
 
311
311
--version      Print the version number. Must be supplied before the command.
312
312
--no-aliases   Do not process command aliases when running this command.
325
325
               will be a pickle.
326
326
--coverage     Generate line coverage report in the specified directory.
327
327
 
328
 
See doc/developers/profiling.txt for more information on profiling.
 
328
See http://doc.bazaar.canonical.com/developers/profiling.html for more
 
329
information on profiling.
 
330
 
329
331
A number of debug flags are also available to assist troubleshooting and
330
 
development.  See `bzr help debug-flags`.
 
332
development.  See :doc:`debug-flags-help`.
331
333
"""
332
334
 
333
335
_standard_options = \
647
649
differences.
648
650
"""
649
651
 
650
 
_branches_out_of_sync = """Branches out of sync
 
652
_branches_out_of_sync = """Branches Out of Sync
651
653
 
652
654
When reconfiguring a checkout, tree or branch into a lightweight checkout,
653
655
a local branch must be destroyed.  (For checkouts, this is the local branch
682
684
project owner to upgrade.
683
685
 
684
686
 
685
 
Note: Some of the older formats have two variants:
686
 
a plain one and a rich-root one. The latter include an additional
687
 
field about the root of the tree. There is no performance cost
688
 
for using a rich-root format but you cannot easily merge changes
689
 
from a rich-root format into a plain format. As a consequence,
690
 
moving a project to a rich-root format takes some co-ordination
691
 
in that all contributors need to upgrade their repositories
692
 
around the same time. 2a and all future formats will be
693
 
implicitly rich-root.
694
 
 
695
 
See ``bzr help current-formats`` for the complete list of
696
 
currently supported formats. See ``bzr help other-formats`` for
 
687
.. note::
 
688
 
 
689
   Some of the older formats have two variants:
 
690
   a plain one and a rich-root one. The latter include an additional
 
691
   field about the root of the tree. There is no performance cost
 
692
   for using a rich-root format but you cannot easily merge changes
 
693
   from a rich-root format into a plain format. As a consequence,
 
694
   moving a project to a rich-root format takes some co-ordination
 
695
   in that all contributors need to upgrade their repositories
 
696
   around the same time. 2a and all future formats will be
 
697
   implicitly rich-root.
 
698
 
 
699
See :doc:`current-formats-help` for the complete list of
 
700
currently supported formats. See :doc:`other-formats-help` for
697
701
descriptions of any available experimental and deprecated formats.
698
702
"""
699
703
 
742
746
                        'Information on configuring authentication')
743
747
topic_registry.register('configuration', _load_from_file,
744
748
                        'Details on the configuration settings available')
745
 
topic_registry.register('conflicts', _load_from_file,
 
749
topic_registry.register('conflict-types', _load_from_file,
746
750
                        'Types of conflicts and what to do about them')
747
751
topic_registry.register('debug-flags', _load_from_file,
748
752
                        'Options to show or record debug information')
749
753
topic_registry.register('log-formats', _load_from_file,
750
754
                        'Details on the logging formats available')
751
 
topic_registry.register('diverged-branches', _load_from_file,
752
 
                        'How to fix diverged branches')
753
755
 
754
756
 
755
757
# Register concept topics.
763
765
topic_registry.register('content-filters', _load_from_file,
764
766
                        'Conversion of content into/from working trees',
765
767
                        SECT_CONCEPT)
 
768
topic_registry.register('diverged-branches', _load_from_file,
 
769
                        'How to fix diverged branches',
 
770
                        SECT_CONCEPT)
766
771
topic_registry.register('eol', _load_from_file,
767
772
                        'Information on end-of-line handling',
768
773
                        SECT_CONCEPT)
856
861
 
857
862
def help_as_plain_text(text):
858
863
    """Minimal converter of reStructuredText to plain text."""
 
864
    import re
859
865
    lines = text.splitlines()
860
866
    result = []
861
867
    for line in lines:
863
869
            line = line[1:]
864
870
        elif line.endswith('::'):
865
871
            line = line[:-1]
 
872
        # Map :doc:`xxx-help` to ``bzr help xxx``
 
873
        line = re.sub(":doc:`(.+)-help`", r'``bzr help \1``', line)
866
874
        result.append(line)
867
875
    return "\n".join(result) + "\n"