← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-14 03:59:22 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070814035922-siavg542cwvkf4r5
Fix pretty doc generation so works for all html docs

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
"""A collection of extra help information for using bzr.
18
18
 
33
33
rendering on the screen naturally.
34
34
"""
35
35
 
36
 
import sys
37
 
 
38
 
import bzrlib
39
 
from bzrlib import (
40
 
    osutils,
41
 
    registry,
42
 
    )
 
36
from bzrlib import registry
43
37
 
44
38
 
45
39
# Section identifiers (map topics to the right place in the manual)
126
120
 
127
121
    topics = topic_registry.keys()
128
122
    lmax = max(len(topic) for topic in topics)
129
 
 
 
123
        
130
124
    out = []
131
125
    for topic in topics:
132
126
        summary = topic_registry.get_summary(topic)
134
128
    return ''.join(out)
135
129
 
136
130
 
137
 
def _load_from_file(topic_name):
138
 
    """Load help from a file.
139
 
 
140
 
    Topics are expected to be txt files in bzrlib.help_topics.
141
 
    """
142
 
    resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
143
 
    return osutils.resource_string('bzrlib.help_topics', resource_name)
144
 
 
145
 
 
146
131
def _help_on_revisionspec(name):
147
132
    """Generate the help for revision specs."""
148
133
    import re
149
134
    import bzrlib.revisionspec
150
135
 
151
136
    out = []
152
 
    out.append(
153
 
"""Revision Identifiers
154
 
 
155
 
A revision identifier refers to a specific state of a branch's history.  It
156
 
can be expressed in several ways.  It can begin with a keyword to
157
 
unambiguously specify a given lookup type; some examples are 'last:1',
158
 
'before:yesterday' and 'submit:'.
159
 
 
160
 
Alternately, it can be given without a keyword, in which case it will be
161
 
checked as a revision number, a tag, a revision id, a date specification, or a
162
 
branch specification, in that order.  For example, 'date:today' could be
163
 
written as simply 'today', though if you have a tag called 'today' that will
164
 
be found first.
165
 
 
166
 
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
167
 
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
168
 
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
169
 
spaces around the '..').
170
 
 
171
 
Ranges are interpreted differently by different commands. To the "log" command,
172
 
a range is a sequence of log messages, but to the "diff" command, the range
173
 
denotes a change between revisions (and not a sequence of changes).  In
174
 
addition, "log" considers a closed range whereas "diff" and "merge" consider it
175
 
to be open-ended, that is, they include one end but not the other.  For example:
176
 
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
177
 
while "bzr diff -r 3647..3649" includes the changes done in revisions 3648 and
178
 
3649, but not 3647.
179
 
 
180
 
The keywords used as revision selection methods are the following:
181
 
""")
 
137
    out.append("Revision Identifiers\n")
 
138
    out.append("A revision, or a range bound, can be one of the following.\n")
182
139
    details = []
183
 
    details.append("\nIn addition, plugins can provide other keywords.")
184
 
    details.append("\nA detailed description of each keyword is given below.\n")
 
140
    details.append("\nFurther details are given below.\n")
185
141
 
186
142
    # The help text is indented 4 spaces - this re cleans that up below
187
143
    indent_re = re.compile(r'^    ', re.MULTILINE)
188
 
    for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
 
144
    for i in bzrlib.revisionspec.SPEC_TYPES:
189
145
        doc = i.help_txt
190
146
        if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
191
147
            summary = "N/A"
197
153
            #doc = indent_re.sub('', doc)
198
154
            while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
199
155
                doc = doc[:-1]
200
 
 
 
156
        
201
157
        # Note: The leading : here are HACKs to get reStructuredText
202
158
        # 'field' formatting - we know that the prefix ends in a ':'.
203
159
        out.append(":%s\n\t%s" % (i.prefix, summary))
213
169
    import textwrap
214
170
 
215
171
    def add_string(proto, help, maxl, prefix_width=20):
216
 
       help_lines = textwrap.wrap(help, maxl - prefix_width,
217
 
            break_long_words=False)
 
172
       help_lines = textwrap.wrap(help, maxl - prefix_width)
218
173
       line_with_indent = '\n' + ' ' * prefix_width
219
174
       help_text = line_with_indent.join(help_lines)
220
175
       return "%-20s%s\n" % (proto, help_text)
251
206
        out += "\nSupported modifiers::\n\n  " + \
252
207
            '  '.join(decl)
253
208
 
254
 
    out += """\
255
 
\nBazaar supports all of the standard parts within the URL::
256
 
 
257
 
  <protocol>://[user[:password]@]host[:port]/[path]
258
 
 
259
 
allowing URLs such as::
260
 
 
261
 
  http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
262
 
 
263
 
For bzr+ssh:// and sftp:// URLs, Bazaar also supports paths that begin
264
 
with '~' as meaning that the rest of the path should be interpreted
265
 
relative to the remote user's home directory.  For example if the user
266
 
``remote`` has a  home directory of ``/home/remote`` on the server
267
 
shell.example.com, then::
268
 
 
269
 
  bzr+ssh://remote@shell.example.com/~/myproject/trunk
270
 
 
271
 
would refer to ``/home/remote/myproject/trunk``.
272
 
 
273
 
Many commands that accept URLs also accept location aliases too.  See
274
 
::doc:`location-alias-help`.
275
 
"""
276
 
 
277
209
    return out
278
210
 
279
211
 
280
212
_basic_help = \
281
213
"""Bazaar -- a free distributed version-control tool
282
 
http://www.bazaar.canonical.com/
 
214
http://bazaar-vcs.org/
283
215
 
284
216
Basic commands:
285
217
  bzr init           makes this directory a versioned branch
294
226
 
295
227
  bzr merge          pull in changes from another branch
296
228
  bzr commit         save some or all changes
297
 
  bzr send           send changes via email
298
229
 
299
230
  bzr log            show history of changes
300
231
  bzr check          validate storage
309
240
"""Global Options
310
241
 
311
242
These options may be used with any command, and may appear in front of any
312
 
command.  (e.g. ``bzr --profile help``).
313
 
 
314
 
--version      Print the version number. Must be supplied before the command.
315
 
--no-aliases   Do not process command aliases when running this command.
 
243
command.  (e.g. "bzr --quiet help").
 
244
 
 
245
--quiet        Suppress informational output; only print errors and warnings
 
246
--version      Print the version number
 
247
 
 
248
--no-aliases   Do not process command aliases when running this command
316
249
--builtin      Use the built-in version of a command, not the plugin version.
317
 
               This does not suppress other plugin effects.
318
 
--no-plugins   Do not process any plugins.
319
 
--concurrency  Number of processes that can be run concurrently (selftest).
 
250
               This does not suppress other plugin effects
 
251
--no-plugins   Do not process any plugins
320
252
 
321
 
--profile      Profile execution using the hotshot profiler.
322
 
--lsprof       Profile execution using the lsprof profiler.
 
253
-Derror        Instead of normal error handling, always print a traceback on
 
254
               error.
 
255
--profile      Profile execution using the hotshot profiler
 
256
--lsprof       Profile execution using the lsprof profiler
323
257
--lsprof-file  Profile execution using the lsprof profiler, and write the
324
258
               results to a specified file.  If the filename ends with ".txt",
325
259
               text format will be used.  If the filename either starts with
326
260
               "callgrind.out" or end with ".callgrind", the output will be
327
261
               formatted for use with KCacheGrind. Otherwise, the output
328
262
               will be a pickle.
329
 
--coverage     Generate line coverage report in the specified directory.
330
 
 
331
 
See http://doc.bazaar.canonical.com/developers/profiling.html for more
332
 
information on profiling.
333
 
 
334
 
A number of debug flags are also available to assist troubleshooting and
335
 
development.  See :doc:`debug-flags-help`.
336
 
"""
337
 
 
338
 
_standard_options = \
339
 
"""Standard Options
340
 
 
341
 
Standard options are legal for all commands.
342
 
 
343
 
--help, -h     Show help message.
344
 
--verbose, -v  Display more information.
345
 
--quiet, -q    Only display errors and warnings.
346
 
 
347
 
Unlike global options, standard options can be used in aliases.
348
 
"""
349
 
 
 
263
 
 
264
See doc/developers/profiling.txt for more information on profiling.
 
265
 
 
266
Note: --version must be supplied before any command.
 
267
"""
350
268
 
351
269
_checkouts = \
352
270
"""Checkouts
390
308
Lightweight checkouts work best when you have fast reliable access to the
391
309
master branch. This means that if the master branch is on the same disk or LAN
392
310
a lightweight checkout will be faster than a heavyweight one for any commands
393
 
that modify the revision history (as only one copy of the branch needs to
394
 
be updated). Heavyweight checkouts will generally be faster for any command
395
 
that uses the history but does not change it, but if the master branch is on
396
 
the same disk then there won't be a noticeable difference.
 
311
that modify the revision history (as only one copy branch needs to be updated).
 
312
Heavyweight checkouts will generally be faster for any command that uses the
 
313
history but does not change it, but if the master branch is on the same disk
 
314
then there wont be a noticeable difference.
397
315
 
398
316
Another possible use for a checkout is to use it with a treeless repository
399
317
containing your branches, where you maintain only one working tree by
400
 
switching the master branch that the checkout points to when you want to
 
318
switching the master branch that the checkout points to when you want to 
401
319
work on a different branch.
402
320
 
403
321
Obviously to commit on a checkout you need to be able to write to the master
406
324
end. Checkouts also work on the local file system, so that all that matters is
407
325
file permissions.
408
326
 
409
 
You can change the master of a checkout by using the "switch" command (see
410
 
"help switch").  This will change the location that the commits are sent to.
411
 
The "bind" command can also be used to turn a normal branch into a heavy
412
 
checkout. If you would like to convert your heavy checkout into a normal
413
 
branch so that every commit is local, you can use the "unbind" command. To see
414
 
whether or not a branch is bound or not you can use the "info" command. If the
415
 
branch is bound it will tell you the location of the bound branch.
 
327
You can change the master of a checkout by using the "bind" command (see "help
 
328
bind"). This will change the location that the commits are sent to. The bind
 
329
command can also be used to turn a branch into a heavy checkout. If you
 
330
would like to convert your heavy checkout into a normal branch so that every
 
331
commit is local, you can use the "unbind" command.
416
332
 
417
333
Related commands::
418
334
 
420
336
              checkout
421
337
  update      Pull any changes in the master branch in to your checkout
422
338
  commit      Make a commit that is sent to the master branch. If you have
423
 
              a heavy checkout then the --local option will commit to the
 
339
              a heavy checkout then the --local option will commit to the 
424
340
              checkout without sending the commit to the master
425
 
  switch      Change the master branch that the commits in the checkout will
 
341
  bind        Change the master branch that the commits in the checkout will
426
342
              be sent to
427
 
  bind        Turn a standalone branch into a heavy checkout so that any
428
 
              commits will be sent to the master branch
429
343
  unbind      Turn a heavy checkout into a standalone branch so that any
430
344
              commits are only made locally
431
 
  info        Displays whether a branch is bound or unbound. If the branch is
432
 
              bound, then it will also display the location of the bound branch
433
345
"""
434
346
 
435
347
_repositories = \
440
352
 
441
353
Repositories are a form of database. Bzr will usually maintain this for
442
354
good performance automatically, but in some situations (e.g. when doing
443
 
very many commits in a short time period) you may want to ask bzr to
 
355
very many commits in a short time period) you may want to ask bzr to 
444
356
optimise the database indices. This can be done by the 'bzr pack' command.
445
357
 
446
358
By default just running 'bzr init' will create a repository within the new
516
428
               this will update the tree to match the branch.
517
429
"""
518
430
 
519
 
 
520
 
_branches = \
521
 
"""Branches
522
 
 
523
 
A branch consists of the state of a project, including all of its
524
 
history. All branches have a repository associated (which is where the
525
 
branch history is stored), but multiple branches may share the same
526
 
repository (a shared repository). Branches can be copied and merged.
527
 
 
528
 
In addition, one branch may be bound to another one.  Binding to another
529
 
branch indicates that commits which happen in this branch must also 
530
 
happen in the other branch.  Bazaar ensures consistency by not allowing 
531
 
commits when the two branches are out of date.  In order for a commit 
532
 
to succeed, it may be necessary to update the current branch using 
533
 
``bzr update``.
534
 
 
535
 
Related commands::
536
 
 
537
 
  init    Change a directory into a versioned branch.
538
 
  branch  Create a new branch that is a copy of an existing branch.
539
 
  merge   Perform a three-way merge.
540
 
  bind    Bind a branch to another one.
541
 
"""
542
 
 
543
 
 
544
 
_standalone_trees = \
545
 
"""Standalone Trees
546
 
 
547
 
A standalone tree is a working tree with an associated repository. It
548
 
is an independently usable branch, with no dependencies on any other.
549
 
Creating a standalone tree (via bzr init) is the quickest way to put
550
 
an existing project under version control.
551
 
 
552
 
Related Commands::
553
 
 
554
 
  init    Make a directory into a versioned branch.
555
 
"""
556
 
 
557
 
 
558
431
_status_flags = \
559
432
"""Status Flags
560
433
 
571
444
  - File unversioned
572
445
  R File renamed
573
446
  ? File unknown
574
 
  X File nonexistent (and unknown to bzr)
575
447
  C File has conflicts
576
448
  P Entry for a pending merge (not a file)
577
449
 
600
472
BZR_PLUGIN_PATH  Paths where bzr should look for plugins.
601
473
BZR_HOME         Directory holding .bazaar config dir. Overrides HOME.
602
474
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
603
 
BZR_REMOTE_PATH  Full name of remote 'bzr' command (for bzr+ssh:// URLs).
604
 
BZR_SSH          Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
605
 
BZR_LOG          Location of .bzr.log (use '/dev/null' to suppress log).
606
 
BZR_LOG (Win32)  Location of .bzr.log (use 'NUL' to suppress log).
607
 
BZR_COLUMNS      Override implicit terminal width.
608
 
BZR_CONCURRENCY  Number of processes that can be run concurrently (selftest).
609
475
================ =================================================================
610
476
"""
611
477
 
631
497
  log10 = log --short -r -10..-1
632
498
"""
633
499
 
634
 
_criss_cross = \
635
 
"""Criss-Cross
636
 
 
637
 
A criss-cross in the branch history can cause the default merge technique
638
 
to emit more conflicts than would normally be expected.
639
 
 
640
 
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
641
 
better results.  You may wish to ``bzr revert`` the working tree and merge
642
 
again.  Alternatively, use ``bzr remerge`` on particular conflicted files.
643
 
 
644
 
Criss-crosses occur in a branch's history if two branches merge the same thing
645
 
and then merge one another, or if two branches merge one another at the same
646
 
time.  They can be avoided by having each branch only merge from or into a
647
 
designated central branch (a "star topology").
648
 
 
649
 
Criss-crosses cause problems because of the way merge works.  Bazaar's default
650
 
merge is a three-way merger; in order to merge OTHER into THIS, it must
651
 
find a basis for comparison, BASE.  Using BASE, it can determine whether
652
 
differences between THIS and OTHER are due to one side adding lines, or
653
 
from another side removing lines.
654
 
 
655
 
Criss-crosses mean there is no good choice for a base.  Selecting the recent
656
 
merge points could cause one side's changes to be silently discarded.
657
 
Selecting older merge points (which Bazaar does) mean that extra conflicts
658
 
are emitted.
659
 
 
660
 
The ``weave`` merge type is not affected by this problem because it uses
661
 
line-origin detection instead of a basis revision to determine the cause of
662
 
differences.
663
 
"""
664
 
 
665
 
_branches_out_of_sync = """Branches Out of Sync
666
 
 
667
 
When reconfiguring a checkout, tree or branch into a lightweight checkout,
668
 
a local branch must be destroyed.  (For checkouts, this is the local branch
669
 
that serves primarily as a cache.)  If the branch-to-be-destroyed does not
670
 
have the same last revision as the new reference branch for the lightweight
671
 
checkout, data could be lost, so Bazaar refuses.
672
 
 
673
 
How you deal with this depends on *why* the branches are out of sync.
674
 
 
675
 
If you have a checkout and have done local commits, you can get back in sync
676
 
by running "bzr update" (and possibly "bzr commit").
677
 
 
678
 
If you have a branch and the remote branch is out-of-date, you can push
679
 
the local changes using "bzr push".  If the local branch is out of date, you
680
 
can do "bzr pull".  If both branches have had changes, you can merge, commit
681
 
and then push your changes.  If you decide that some of the changes aren't
682
 
useful, you can "push --overwrite" or "pull --overwrite" instead.
683
 
"""
684
 
 
685
 
 
686
 
_storage_formats = \
687
 
"""Storage Formats
688
 
 
689
 
To ensure that older clients do not access data incorrectly,
690
 
Bazaar's policy is to introduce a new storage format whenever
691
 
new features requiring new metadata are added. New storage
692
 
formats may also be introduced to improve performance and
693
 
scalability.
694
 
 
695
 
The newest format, 2a, is highly recommended. If your
696
 
project is not using 2a, then you should suggest to the
697
 
project owner to upgrade.
698
 
 
699
 
 
700
 
.. note::
701
 
 
702
 
   Some of the older formats have two variants:
703
 
   a plain one and a rich-root one. The latter include an additional
704
 
   field about the root of the tree. There is no performance cost
705
 
   for using a rich-root format but you cannot easily merge changes
706
 
   from a rich-root format into a plain format. As a consequence,
707
 
   moving a project to a rich-root format takes some co-ordination
708
 
   in that all contributors need to upgrade their repositories
709
 
   around the same time. 2a and all future formats will be
710
 
   implicitly rich-root.
711
 
 
712
 
See :doc:`current-formats-help` for the complete list of
713
 
currently supported formats. See :doc:`other-formats-help` for
714
 
descriptions of any available experimental and deprecated formats.
715
 
"""
716
 
 
717
 
 
718
 
# Register help topics
 
500
 
719
501
topic_registry.register("revisionspec", _help_on_revisionspec,
720
502
                        "Explain how to use --revision")
721
503
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
722
504
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
723
 
def get_current_formats_topic(topic):
724
 
    from bzrlib import bzrdir
725
 
    return "Current Storage Formats\n\n" + \
726
 
        bzrdir.format_registry.help_topic(topic)
727
 
def get_other_formats_topic(topic):
728
 
    from bzrlib import bzrdir
729
 
    return "Other Storage Formats\n\n" + \
730
 
        bzrdir.format_registry.help_topic(topic)
731
 
topic_registry.register('current-formats', get_current_formats_topic,
732
 
    'Current storage formats')
733
 
topic_registry.register('other-formats', get_other_formats_topic,
734
 
    'Experimental and deprecated storage formats')
735
 
topic_registry.register('standard-options', _standard_options,
 
505
def get_format_topic(topic):
 
506
    from bzrlib import bzrdir
 
507
    return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
 
508
topic_registry.register('formats', get_format_topic, 'Directory formats')
 
509
topic_registry.register('global-options', _global_options,
736
510
                        'Options that can be used with any command')
737
 
topic_registry.register('global-options', _global_options,
738
 
                    'Options that control how Bazaar runs')
 
511
topic_registry.register('checkouts', _checkouts,
 
512
                        'Information on what a checkout is', SECT_CONCEPT)
739
513
topic_registry.register('urlspec', _help_on_transport,
740
514
                        "Supported transport protocols")
741
515
topic_registry.register('status-flags', _status_flags,
742
516
                        "Help on status flags")
743
517
def get_bugs_topic(topic):
744
518
    from bzrlib import bugtracker
745
 
    return ("Bug Tracker Settings\n\n" +
746
 
        bugtracker.tracker_registry.help_topic(topic))
747
 
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
 
519
    return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
 
520
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
 
521
topic_registry.register('repositories', _repositories,
 
522
                        'Basic information on shared repositories.',
 
523
                        SECT_CONCEPT)
 
524
topic_registry.register('working-trees', _working_trees,
 
525
                        'Information on working trees', SECT_CONCEPT)
748
526
topic_registry.register('env-variables', _env_variables,
749
527
                        'Environment variable names and values')
750
528
topic_registry.register('files', _files,
751
529
                        'Information on configuration and log files')
752
 
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
753
 
                        'Points at which custom processing can be added')
754
 
 
755
 
# Load some of the help topics from files. Note that topics which reproduce API
756
 
# details will tend to skew (quickly usually!) so please seek other solutions
757
 
# for such things.
758
 
topic_registry.register('authentication', _load_from_file,
759
 
                        'Information on configuring authentication')
760
 
topic_registry.register('configuration', _load_from_file,
761
 
                        'Details on the configuration settings available')
762
 
topic_registry.register('conflict-types', _load_from_file,
763
 
                        'Types of conflicts and what to do about them')
764
 
topic_registry.register('debug-flags', _load_from_file,
765
 
                        'Options to show or record debug information')
766
 
topic_registry.register('location-alias', _load_from_file,
767
 
                        'Aliases for remembered locations')
768
 
topic_registry.register('log-formats', _load_from_file,
769
 
                        'Details on the logging formats available')
770
 
 
771
 
 
772
 
# Register concept topics.
773
 
# Note that we might choose to remove these from the online help in the
774
 
# future or implement them via loading content from files. In the meantime,
775
 
# please keep them concise.
776
 
topic_registry.register('branches', _branches,
777
 
                        'Information on what a branch is', SECT_CONCEPT)
778
 
topic_registry.register('checkouts', _checkouts,
779
 
                        'Information on what a checkout is', SECT_CONCEPT)
780
 
topic_registry.register('content-filters', _load_from_file,
781
 
                        'Conversion of content into/from working trees',
782
 
                        SECT_CONCEPT)
783
 
topic_registry.register('diverged-branches', _load_from_file,
784
 
                        'How to fix diverged branches',
785
 
                        SECT_CONCEPT)
786
 
topic_registry.register('eol', _load_from_file,
787
 
                        'Information on end-of-line handling',
788
 
                        SECT_CONCEPT)
789
 
topic_registry.register('formats', _storage_formats,
790
 
                        'Information on choosing a storage format',
791
 
                        SECT_CONCEPT)
792
 
topic_registry.register('patterns', _load_from_file,
793
 
                        'Information on the pattern syntax',
794
 
                        SECT_CONCEPT)
795
 
topic_registry.register('repositories', _repositories,
796
 
                        'Basic information on shared repositories.',
797
 
                        SECT_CONCEPT)
798
 
topic_registry.register('rules', _load_from_file,
799
 
                        'Information on defining rule-based preferences',
800
 
                        SECT_CONCEPT)
801
 
topic_registry.register('standalone-trees', _standalone_trees,
802
 
                        'Information on what a standalone tree is',
803
 
                        SECT_CONCEPT)
804
 
topic_registry.register('working-trees', _working_trees,
805
 
                        'Information on working trees', SECT_CONCEPT)
806
 
topic_registry.register('criss-cross', _criss_cross,
807
 
                        'Information on criss-cross merging', SECT_CONCEPT)
808
 
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
809
 
                        'Steps to resolve "out-of-sync" when reconfiguring',
810
 
                        SECT_CONCEPT)
811
530
 
812
531
 
813
532
class HelpTopicIndex(object):
854
573
            returned instead of plain text.
855
574
        """
856
575
        result = topic_registry.get_detail(self.topic)
857
 
        # there is code duplicated here and in bzrlib/plugin.py's
 
576
        # there is code duplicated here and in bzrlib/plugin.py's 
858
577
        # matching Topic code. This should probably be factored in
859
578
        # to a helper function and a common base class.
860
579
        if additional_see_also is not None:
876
595
 
877
596
def help_as_plain_text(text):
878
597
    """Minimal converter of reStructuredText to plain text."""
879
 
    import re
880
598
    lines = text.splitlines()
881
599
    result = []
882
600
    for line in lines:
884
602
            line = line[1:]
885
603
        elif line.endswith('::'):
886
604
            line = line[:-1]
887
 
        # Map :doc:`xxx-help` to ``bzr help xxx``
888
 
        line = re.sub(":doc:`(.+)-help`", r'``bzr help \1``', line)
889
605
        result.append(line)
890
606
    return "\n".join(result) + "\n"