134
80
return ''.join(out)
137
def _load_from_file(topic_name):
138
"""Load help from a file.
140
Topics are expected to be txt files in breezy.help_topics.
142
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
143
return osutils.resource_string('breezy.help_topics', resource_name)
146
83
def _help_on_revisionspec(name):
147
"""Generate the help for revision specs."""
149
import breezy.revisionspec
84
""""Write the summary help for all documented topics to outfile."""
85
import bzrlib.revisionspec
153
"""Revision Identifiers
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:'.
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
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 '..').
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
"brz log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
177
while "brz diff -r 3647..3649" includes the changes done in revisions 3648 and
180
The keywords used as revision selection methods are the following:
183
details.append("\nIn addition, plugins can provide other keywords.")
185
"\nA detailed description of each keyword is given below.\n")
187
# The help text is indented 4 spaces - this re cleans that up below
188
indent_re = re.compile(r'^ ', re.MULTILINE)
189
for prefix, i in breezy.revisionspec.revspec_registry.iteritems():
88
out.append("\nRevision prefix specifier:"
89
"\n--------------------------\n")
91
for i in bzrlib.revisionspec.SPEC_TYPES:
191
if doc == breezy.revisionspec.RevisionSpec.help_txt:
195
# Extract out the top line summary from the body and
196
# clean-up the unwanted whitespace
197
summary, doc = doc.split("\n", 1)
198
#doc = indent_re.sub('', doc)
199
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
202
# Note: The leading : here are HACKs to get reStructuredText
203
# 'field' formatting - we know that the prefix ends in a ':'.
204
out.append(":%s\n\t%s" % (i.prefix, summary))
205
details.append(":%s\n%s" % (i.prefix, doc))
207
return '\n'.join(out + details)
210
def _help_on_transport(name):
211
from breezy.transport import (
212
transport_list_registry,
216
def add_string(proto, help, maxl, prefix_width=20):
217
help_lines = textwrap.wrap(help, maxl - prefix_width,
218
break_long_words=False)
219
line_with_indent = '\n' + ' ' * prefix_width
220
help_text = line_with_indent.join(help_lines)
221
return "%-20s%s\n" % (proto, help_text)
224
return a[:a.rfind("://")]
228
protos = transport_list_registry.keys()
229
protos.sort(key=key_func)
231
shorthelp = transport_list_registry.get_help(proto)
234
if proto.endswith("://"):
235
protl.append(add_string(proto, shorthelp, 79))
237
decl.append(add_string(proto, shorthelp, 79))
239
out = "URL Identifiers\n\n" + \
240
"Supported URL prefixes::\n\n " + \
244
out += "\nSupported modifiers::\n\n " + \
248
\nBreezy supports all of the standard parts within the URL::
250
<protocol>://[user[:password]@]host[:port]/[path]
252
allowing URLs such as::
254
http://brzuser:BadPass@brz.example.com:8080/brz/trunk
256
For brz+ssh:// and sftp:// URLs, Breezy also supports paths that begin
257
with '~' as meaning that the rest of the path should be interpreted
258
relative to the remote user's home directory. For example if the user
259
``remote`` has a home directory of ``/home/remote`` on the server
260
shell.example.com, then::
262
brz+ssh://remote@shell.example.com/~/myproject/trunk
264
would refer to ``/home/remote/myproject/trunk``.
266
Many commands that accept URLs also accept location aliases too.
267
See :doc:`location-alias-help` and :doc:`url-special-chars-help`.
274
"""Breezy %s -- a free distributed version-control tool
275
https://www.breezy-vcs.org/
93
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
95
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
98
out.append(" %s %s\n\n" % (i.prefix, doc))
104
"""Bazaar -- a free distributed version-control tool
105
http://bazaar-vcs.org/
278
brz init makes this directory a versioned branch
279
brz branch make a copy of another branch
281
brz add make files or directories versioned
282
brz ignore ignore a file or pattern
283
brz mv move or rename a versioned file
285
brz status summarize changes in working copy
286
brz diff show detailed diffs
288
brz merge pull in changes from another branch
289
brz commit save some or all changes
290
brz send send changes via email
292
brz log show history of changes
293
brz check validate storage
295
brz help init more help on e.g. init command
296
brz help commands list all commands
297
brz help topics list all help topics
298
""" % breezy.__version__
108
bzr init makes this directory a versioned branch
109
bzr branch make a copy of another branch
111
bzr add make files or directories versioned
112
bzr ignore ignore a file or pattern
113
bzr mv move or rename a versioned file
115
bzr status summarize changes in working copy
116
bzr diff show detailed diffs
118
bzr merge pull in changes from another branch
119
bzr commit save some or all changes
121
bzr log show history of changes
122
bzr check validate storage
124
bzr help init more help on e.g. init command
125
bzr help commands list all commands
126
bzr help topics list all help topics
304
133
These options may be used with any command, and may appear in front of any
305
command. (e.g. ``brz --profile help``).
307
--version Print the version number. Must be supplied before the command.
308
--no-aliases Do not process command aliases when running this command.
134
command. (e.g. "bzr --quiet help").
136
--quiet Suppress informational output; only print errors and warnings
137
--version Print the version number
139
--no-aliases Do not process command aliases when running this command
309
140
--builtin Use the built-in version of a command, not the plugin version.
310
This does not suppress other plugin effects.
311
--no-plugins Do not process any plugins.
312
--no-l10n Do not translate messages.
313
--concurrency Number of processes that can be run concurrently (selftest).
141
This does not suppress other plugin effects
142
--no-plugins Do not process any plugins
315
--profile Profile execution using the hotshot profiler.
316
--lsprof Profile execution using the lsprof profiler.
144
-Derror Instead of normal error handling, always print a traceback on
146
--profile Profile execution using the hotshot profiler
147
--lsprof Profile execution using the lsprof profiler
317
148
--lsprof-file Profile execution using the lsprof profiler, and write the
318
results to a specified file. If the filename ends with ".txt",
319
text format will be used. If the filename either starts with
320
"callgrind.out" or end with ".callgrind", the output will be
321
formatted for use with KCacheGrind. Otherwise, the output
323
--coverage Generate line coverage report in the specified directory.
325
-Oname=value Override the ``name`` config option setting it to ``value`` for
326
the duration of the command. This can be used multiple times if
327
several options need to be overridden.
329
See https://www.breezy-vcs.org/developers/profiling.html for more
330
information on profiling.
332
A number of debug flags are also available to assist troubleshooting and
333
development. See :doc:`debug-flags-help`.
336
_standard_options = \
339
Standard options are legal for all commands.
341
--help, -h Show help message.
342
--verbose, -v Display more information.
343
--quiet, -q Only display errors and warnings.
345
Unlike global options, standard options can be used in aliases.
149
results to a specified file.
151
Note: --version must be supplied before any command.
352
157
Checkouts are source trees that are connected to a branch, so that when
353
158
you commit in the source tree, the commit goes into that branch. They
354
159
allow you to use a simpler, more centralized workflow, ignoring some of
355
Breezy's decentralized features until you want them. Using checkouts
160
Bazaar's decentralized features until you want them. Using checkouts
356
161
with shared repositories is very similar to working with SVN or CVS, but
357
162
doesn't have the same restrictions. And using checkouts still allows
358
163
others working on the project to use whatever workflow they like.
360
A checkout is created with the brz checkout command (see "help checkout").
165
A checkout is created with the bzr checkout command (see "help checkout").
361
166
You pass it a reference to another branch, and it will create a local copy
362
167
for you that still contains a reference to the branch you created the
363
168
checkout from (the master branch). Then if you make any commits they will be
404
209
end. Checkouts also work on the local file system, so that all that matters is
405
210
file permissions.
407
You can change the master of a checkout by using the "switch" command (see
408
"help switch"). This will change the location that the commits are sent to.
409
The "bind" command can also be used to turn a normal branch into a heavy
410
checkout. If you would like to convert your heavy checkout into a normal
411
branch so that every commit is local, you can use the "unbind" command. To see
412
whether or not a branch is bound or not you can use the "info" command. If the
413
branch is bound it will tell you the location of the bound branch.
212
You can change the master of a checkout by using the "bind" command (see "help
213
bind"). This will change the location that the commits are sent to. The bind
214
command can also be used to turn a branch into a heavy checkout. If you
215
would like to convert your heavy checkout into a normal branch so that every
216
commit is local, you can use the "unbind" command.
417
220
checkout Create a checkout. Pass --lightweight to get a lightweight
419
222
update Pull any changes in the master branch in to your checkout
420
223
commit Make a commit that is sent to the master branch. If you have
421
a heavy checkout then the --local option will commit to the
224
a heavy checkout then the --local option will commit to the
422
225
checkout without sending the commit to the master
423
switch Change the master branch that the commits in the checkout will
226
bind Change the master branch that the commits in the checkout will
425
bind Turn a standalone branch into a heavy checkout so that any
426
commits will be sent to the master branch
427
228
unbind Turn a heavy checkout into a standalone branch so that any
428
229
commits are only made locally
429
info Displays whether a branch is bound or unbound. If the branch is
430
bound, then it will also display the location of the bound branch
436
Repositories in Breezy are where committed information is stored. There is
437
a repository associated with every branch.
439
Repositories are a form of database. Breezy will usually maintain this for
440
good performance automatically, but in some situations (e.g. when doing
441
very many commits in a short time period) you may want to ask brz to
442
optimise the database indices. This can be done by the 'brz pack' command.
444
By default just running 'brz init' will create a repository within the new
445
branch but it is possible to create a shared repository which allows multiple
446
branches to share their information in the same location. When a new branch is
447
created it will first look to see if there is a containing shared repository it
450
When two branches of the same project share a repository, there is
451
generally a large space saving. For some operations (e.g. branching
452
within the repository) this translates in to a large time saving.
454
To create a shared repository use the init-shared-repository command (or the
455
alias init-shared-repo). This command takes the location of the repository to
456
create. This means that 'brz init-shared-repository repo' will create a
457
directory named 'repo', which contains a shared repository. Any new branches
458
that are created in this directory will then use it for storage.
460
It is a good idea to create a repository whenever you might create more
461
than one branch of a project. This is true for both working areas where you
462
are doing the development, and any server areas that you use for hosting
463
projects. In the latter case, it is common to want branches without working
464
trees. Since the files in the branch will not be edited directly there is no
465
need to use up disk space for a working tree. To create a repository in which
466
the branches will not have working trees pass the '--no-trees' option to
467
'init-shared-repository'.
471
init-shared-repository Create a shared repository. Use --no-trees to create
472
one in which new branches won't get a working tree.
479
A working tree is the contents of a branch placed on disk so that you can
480
see the files and edit them. The working tree is where you make changes to a
481
branch, and when you commit the current state of the working tree is the
482
snapshot that is recorded in the commit.
484
When you push a branch to a remote system, a working tree will not be
485
created. If one is already present the files will not be updated. The
486
branch information will be updated and the working tree will be marked
487
as out-of-date. Updating a working tree remotely is difficult, as there
488
may be uncommitted changes or the update may cause content conflicts that are
489
difficult to deal with remotely.
491
If you have a branch with no working tree you can use the 'checkout' command
492
to create a working tree. If you run 'brz checkout .' from the branch it will
493
create the working tree. If the branch is updated remotely, you can update the
494
working tree by running 'brz update' in that directory.
496
If you have a branch with a working tree that you do not want the 'remove-tree'
497
command will remove the tree if it is safe. This can be done to avoid the
498
warning about the remote working tree not being updated when pushing to the
499
branch. It can also be useful when working with a '--no-trees' repository
500
(see 'brz help repositories').
502
If you want to have a working tree on a remote machine that you push to you
503
can either run 'brz update' in the remote branch after each push, or use some
504
other method to update the tree during the push. There is an 'rspush' plugin
505
that will update the working tree using rsync as well as doing a push. There
506
is also a 'push-and-update' plugin that automates running 'brz update' via SSH
511
checkout Create a working tree when a branch does not have one.
512
remove-tree Removes the working tree from a branch when it is safe to do so.
513
update When a working tree is out of sync with its associated branch
514
this will update the tree to match the branch.
521
A branch consists of the state of a project, including all of its
522
history. All branches have a repository associated (which is where the
523
branch history is stored), but multiple branches may share the same
524
repository (a shared repository). Branches can be copied and merged.
526
In addition, one branch may be bound to another one. Binding to another
527
branch indicates that commits which happen in this branch must also
528
happen in the other branch. Breezy ensures consistency by not allowing
529
commits when the two branches are out of date. In order for a commit
530
to succeed, it may be necessary to update the current branch using
535
init Change a directory into a versioned branch.
536
branch Create a new branch that is a copy of an existing branch.
537
merge Perform a three-way merge.
538
bind Bind a branch to another one.
542
_standalone_trees = \
545
A standalone tree is a working tree with an associated repository. It
546
is an independently usable branch, with no dependencies on any other.
547
Creating a standalone tree (via brz init) is the quickest way to put
548
an existing project under version control.
552
init Make a directory into a versioned branch.
559
Status flags are used to summarise changes to the working tree in a concise
560
manner. They are in the form::
564
where the columns' meanings are as follows.
566
Column 1 - versioning/renames::
572
X File nonexistent (and unknown to brz)
574
P Entry for a pending merge (not a file)
576
Column 2 - contents::
585
* The execute bit was changed
589
known_env_variables = [
590
("BRZPATH", "Path where brz is to look for shell plugin external commands."),
591
("BRZ_EMAIL", "E-Mail address of the user. Overrides EMAIL."),
592
("EMAIL", "E-Mail address of the user."),
593
("BRZ_EDITOR", "Editor for editing commit messages. Overrides EDITOR."),
594
("EDITOR", "Editor for editing commit messages."),
595
("BRZ_PLUGIN_PATH", "Paths where brz should look for plugins."),
596
("BRZ_DISABLE_PLUGINS", "Plugins that brz should not load."),
597
("BRZ_PLUGINS_AT", "Plugins to load from a directory not in BRZ_PLUGIN_PATH."),
598
("BRZ_HOME", "Directory holding breezy config dir. Overrides HOME."),
599
("BRZ_HOME (Win32)", "Directory holding breezy config dir. Overrides APPDATA and HOME."),
600
("BZR_REMOTE_PATH", "Full name of remote 'brz' command (for brz+ssh:// URLs)."),
601
("BRZ_SSH", "Path to SSH client, or one of paramiko, openssh, sshcorp, plink or lsh."),
602
("BRZ_LOG", "Location of brz.log (use '/dev/null' to suppress log)."),
603
("BRZ_LOG (Win32)", "Location of brz.log (use 'NUL' to suppress log)."),
604
("BRZ_COLUMNS", "Override implicit terminal width."),
605
("BRZ_CONCURRENCY", "Number of processes that can be run concurrently (selftest)"),
606
("BRZ_PROGRESS_BAR", "Override the progress display. Values are 'none' or 'text'."),
607
("BRZ_PDB", "Control whether to launch a debugger on error."),
609
"Control whether SIGQUIT behaves normally or invokes a breakin debugger."),
611
"Force console input mode for prompts to line-based (instead of char-based)."),
615
def _env_variables(topic):
617
ret = ["Environment Variables\n\n"
618
"See brz help configuration for more details.\n\n"]
619
max_key_len = max([len(k[0]) for k in known_env_variables])
620
desc_len = (80 - max_key_len - 2)
621
ret.append("=" * max_key_len + " " + "=" * desc_len + "\n")
622
for k, desc in known_env_variables:
623
ret.append(k + (max_key_len + 1 - len(k)) * " ")
624
ret.append("\n".join(textwrap.wrap(
625
desc, width=desc_len, subsequent_indent=" " * (max_key_len + 1))))
627
ret += "=" * max_key_len + " " + "=" * desc_len + "\n"
634
:On Unix: ~/.config/breezy/breezy.conf
635
:On Windows: %APPDATA%\\breezy\\breezy.conf
637
Contains the user's default configuration. The section ``[DEFAULT]`` is
638
used to define general configuration that will be applied everywhere.
639
The section ``[ALIASES]`` can be used to create command aliases for
640
commonly used options.
642
A typical config file might look something like::
645
email=John Doe <jdoe@isp.com>
648
commit = commit --strict
649
log10 = log --short -r -10..-1
655
A criss-cross in the branch history can cause the default merge technique
656
to emit more conflicts than would normally be expected.
658
In complex merge cases, ``brz merge --lca`` or ``brz merge --weave`` may give
659
better results. You may wish to ``brz revert`` the working tree and merge
660
again. Alternatively, use ``brz remerge`` on particular conflicted files.
662
Criss-crosses occur in a branch's history if two branches merge the same thing
663
and then merge one another, or if two branches merge one another at the same
664
time. They can be avoided by having each branch only merge from or into a
665
designated central branch (a "star topology").
667
Criss-crosses cause problems because of the way merge works. Breezy's default
668
merge is a three-way merger; in order to merge OTHER into THIS, it must
669
find a basis for comparison, BASE. Using BASE, it can determine whether
670
differences between THIS and OTHER are due to one side adding lines, or
671
from another side removing lines.
673
Criss-crosses mean there is no good choice for a base. Selecting the recent
674
merge points could cause one side's changes to be silently discarded.
675
Selecting older merge points (which Breezy does) mean that extra conflicts
678
The ``weave`` merge type is not affected by this problem because it uses
679
line-origin detection instead of a basis revision to determine the cause of
683
_branches_out_of_sync = """Branches Out of Sync
685
When reconfiguring a checkout, tree or branch into a lightweight checkout,
686
a local branch must be destroyed. (For checkouts, this is the local branch
687
that serves primarily as a cache.) If the branch-to-be-destroyed does not
688
have the same last revision as the new reference branch for the lightweight
689
checkout, data could be lost, so Breezy refuses.
691
How you deal with this depends on *why* the branches are out of sync.
693
If you have a checkout and have done local commits, you can get back in sync
694
by running "brz update" (and possibly "brz commit").
696
If you have a branch and the remote branch is out-of-date, you can push
697
the local changes using "brz push". If the local branch is out of date, you
698
can do "brz pull". If both branches have had changes, you can merge, commit
699
and then push your changes. If you decide that some of the changes aren't
700
useful, you can "push --overwrite" or "pull --overwrite" instead.
707
To ensure that older clients do not access data incorrectly,
708
Breezy's policy is to introduce a new storage format whenever
709
new features requiring new metadata are added. New storage
710
formats may also be introduced to improve performance and
713
The newest format, 2a, is highly recommended. If your
714
project is not using 2a, then you should suggest to the
715
project owner to upgrade.
720
Some of the older formats have two variants:
721
a plain one and a rich-root one. The latter include an additional
722
field about the root of the tree. There is no performance cost
723
for using a rich-root format but you cannot easily merge changes
724
from a rich-root format into a plain format. As a consequence,
725
moving a project to a rich-root format takes some co-ordination
726
in that all contributors need to upgrade their repositories
727
around the same time. 2a and all future formats will be
728
implicitly rich-root.
730
See :doc:`current-formats-help` for the complete list of
731
currently supported formats. See :doc:`other-formats-help` for
732
descriptions of any available experimental and deprecated formats.
736
# Register help topics
737
233
topic_registry.register("revisionspec", _help_on_revisionspec,
738
234
"Explain how to use --revision")
739
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
740
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
743
def get_current_formats_topic(topic):
744
from breezy import controldir
745
return "Current Storage Formats\n\n" + \
746
controldir.format_registry.help_topic(topic)
749
def get_other_formats_topic(topic):
750
from breezy import controldir
751
return "Other Storage Formats\n\n" + \
752
controldir.format_registry.help_topic(topic)
755
topic_registry.register('current-formats', get_current_formats_topic,
756
'Current storage formats')
757
topic_registry.register('other-formats', get_other_formats_topic,
758
'Experimental and deprecated storage formats')
759
topic_registry.register('standard-options', _standard_options,
235
topic_registry.register('basic', _basic_help, "Basic commands")
236
topic_registry.register('topics', _help_on_topics, "Topics list")
237
def get_format_topic(topic):
238
from bzrlib import bzrdir
239
return bzrdir.format_registry.help_topic(topic)
240
topic_registry.register('formats', get_format_topic, 'Directory formats')
241
topic_registry.register('global-options', _global_options,
760
242
'Options that can be used with any command')
761
topic_registry.register('global-options', _global_options,
762
'Options that control how Breezy runs')
763
topic_registry.register('urlspec', _help_on_transport,
764
"Supported transport protocols")
765
topic_registry.register('status-flags', _status_flags,
766
"Help on status flags")
769
def get_bugs_topic(topic):
770
from breezy import bugtracker
771
return ("Bug Tracker Settings\n\n"
772
+ bugtracker.tracker_registry.help_topic(topic))
775
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
776
topic_registry.register('env-variables', _env_variables,
777
'Environment variable names and values')
778
topic_registry.register('files', _files,
779
'Information on configuration and log files')
780
topic_registry.register_lazy('hooks', 'breezy.hooks', 'hooks_help_text',
781
'Points at which custom processing can be added')
782
topic_registry.register_lazy('location-alias', 'breezy.directory_service',
783
'AliasDirectory.help_text',
784
'Aliases for remembered locations')
786
# Load some of the help topics from files. Note that topics which reproduce API
787
# details will tend to skew (quickly usually!) so please seek other solutions
789
topic_registry.register('authentication', _load_from_file,
790
'Information on configuring authentication')
791
topic_registry.register('configuration', _load_from_file,
792
'Details on the configuration settings available')
793
topic_registry.register('conflict-types', _load_from_file,
794
'Types of conflicts and what to do about them')
795
topic_registry.register('debug-flags', _load_from_file,
796
'Options to show or record debug information')
797
topic_registry.register('glossary', _load_from_file, 'Glossary')
798
topic_registry.register('log-formats', _load_from_file,
799
'Details on the logging formats available')
800
topic_registry.register('missing-extensions', _load_from_file,
801
'What to do when compiled extensions are missing')
802
topic_registry.register('url-special-chars', _load_from_file,
803
'Special character handling in URLs')
806
# Register concept topics.
807
# Note that we might choose to remove these from the online help in the
808
# future or implement them via loading content from files. In the meantime,
809
# please keep them concise.
810
topic_registry.register('branches', _branches,
811
'Information on what a branch is', SECT_CONCEPT)
812
243
topic_registry.register('checkouts', _checkouts,
813
'Information on what a checkout is', SECT_CONCEPT)
814
topic_registry.register('content-filters', _load_from_file,
815
'Conversion of content into/from working trees',
817
topic_registry.register('diverged-branches', _load_from_file,
818
'How to fix diverged branches',
820
topic_registry.register('eol', _load_from_file,
821
'Information on end-of-line handling',
823
topic_registry.register('formats', _storage_formats,
824
'Information on choosing a storage format',
826
topic_registry.register('patterns', _load_from_file,
827
'Information on the pattern syntax',
829
topic_registry.register('repositories', _repositories,
830
'Basic information on shared repositories.',
832
topic_registry.register('rules', _load_from_file,
833
'Information on defining rule-based preferences',
835
topic_registry.register('standalone-trees', _standalone_trees,
836
'Information on what a standalone tree is',
838
topic_registry.register('working-trees', _working_trees,
839
'Information on working trees', SECT_CONCEPT)
840
topic_registry.register('criss-cross', _criss_cross,
841
'Information on criss-cross merging', SECT_CONCEPT)
842
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
843
'Steps to resolve "out-of-sync" when reconfiguring',
847
class HelpTopicIndex(object):
848
"""A index for brz help that returns topics."""
853
def get_topics(self, topic):
854
"""Search for topic in the HelpTopicRegistry.
856
:param topic: A topic to search for. None is treated as 'basic'.
857
:return: A list which is either empty or contains a single
858
RegisteredTopic entry.
862
if topic in topic_registry:
863
return [RegisteredTopic(topic)]
868
def _format_see_also(see_also):
871
result += '\n:See also: '
872
result += ', '.join(sorted(set(see_also)))
877
class RegisteredTopic(object):
878
"""A help topic which has been registered in the HelpTopicRegistry.
880
These topics consist of nothing more than the name of the topic - all
881
data is retrieved on demand from the registry.
884
def __init__(self, topic):
887
:param topic: The name of the topic that this represents.
891
def get_help_text(self, additional_see_also=None, plain=True):
892
"""Return a string with the help for this topic.
894
:param additional_see_also: Additional help topics to be
896
:param plain: if False, raw help (reStructuredText) is
897
returned instead of plain text.
899
result = topic_registry.get_detail(self.topic)
900
result += _format_see_also(additional_see_also)
902
result = help_as_plain_text(result)
904
result = i18n.gettext_per_paragraph(result)
907
def get_help_topic(self):
908
"""Return the help topic this can be found under."""
912
def help_as_plain_text(text):
913
"""Minimal converter of reStructuredText to plain text."""
915
# Remove the standalone code block marker
916
text = re.sub(r"(?m)^\s*::\n\s*$", "", text)
917
lines = text.splitlines()
920
if line.startswith(':'):
922
elif line.endswith('::'):
924
# Map :doc:`xxx-help` to ``brz help xxx``
925
line = re.sub(":doc:`(.+?)-help`", r'``brz help \1``', line)
927
return "\n".join(result) + "\n"
930
class ConfigOptionHelpIndex(object):
931
"""A help index that returns help topics for config options."""
934
self.prefix = 'configuration/'
936
def get_topics(self, topic):
937
"""Search for topic in the registered config options.
939
:param topic: A topic to search for.
940
:return: A list which is either empty or contains a single
945
elif topic.startswith(self.prefix):
946
topic = topic[len(self.prefix):]
947
if topic in config.option_registry:
948
return [config.option_registry.get(topic)]
244
'Information on what a checkout is')
added
removed
bzrlib/help_topics.py
