136
128
return ''.join(out)
139
def _load_from_file(topic_name):
140
"""Load help from a file.
142
Topics are expected to be txt files in bzrlib.help_topics.
144
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
145
return osutils.resource_string('bzrlib.help_topics', resource_name)
148
131
def _help_on_revisionspec(name):
149
132
"""Generate the help for revision specs."""
151
134
import bzrlib.revisionspec
155
"""Revision Identifiers
157
A revision identifier refers to a specific state of a branch's history. It
158
can be expressed in several ways. It can begin with a keyword to
159
unambiguously specify a given lookup type; some examples are 'last:1',
160
'before:yesterday' and 'submit:'.
162
Alternately, it can be given without a keyword, in which case it will be
163
checked as a revision number, a tag, a revision id, a date specification, or a
164
branch specification, in that order. For example, 'date:today' could be
165
written as simply 'today', though if you have a tag called 'today' that will
168
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
169
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
170
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
171
spaces around the '..').
173
Ranges are interpreted differently by different commands. To the "log" command,
174
a range is a sequence of log messages, but to the "diff" command, the range
175
denotes a change between revisions (and not a sequence of changes). In
176
addition, "log" considers a closed range whereas "diff" and "merge" consider it
177
to be open-ended, that is, they include one end but not the other. For example:
178
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
179
while "bzr diff -r 3647..3649" includes the changes done in revisions 3648 and
182
The keywords used as revision selection methods are the following:
137
out.append("Revision Identifiers\n")
138
out.append("A revision, or a range bound, can be one of the following.\n")
185
details.append("\nIn addition, plugins can provide other keywords.")
186
details.append("\nA detailed description of each keyword is given below.\n")
140
details.append("\nFurther details are given below.\n")
188
142
# The help text is indented 4 spaces - this re cleans that up below
189
143
indent_re = re.compile(r'^ ', re.MULTILINE)
190
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
144
for i in bzrlib.revisionspec.SPEC_TYPES:
192
146
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
304
233
bzr help init more help on e.g. init command
305
234
bzr help commands list all commands
306
235
bzr help topics list all help topics
307
""" % bzrlib.__version__
310
239
_global_options = \
311
240
"""Global Options
313
242
These options may be used with any command, and may appear in front of any
314
command. (e.g. ``bzr --profile help``).
316
--version Print the version number. Must be supplied before the command.
317
--no-aliases Do not process command aliases when running this command.
243
command. (e.g. "bzr --quiet help").
245
--quiet Suppress informational output; only print errors and warnings
246
--version Print the version number
248
--no-aliases Do not process command aliases when running this command
318
249
--builtin Use the built-in version of a command, not the plugin version.
319
This does not suppress other plugin effects.
320
--no-plugins Do not process any plugins.
321
--no-l10n Do not translate messages.
322
--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
324
--profile Profile execution using the hotshot profiler.
325
--lsprof Profile execution using the lsprof profiler.
253
-Derror Instead of normal error handling, always print a traceback on
255
--profile Profile execution using the hotshot profiler
256
--lsprof Profile execution using the lsprof profiler
326
257
--lsprof-file Profile execution using the lsprof profiler, and write the
327
258
results to a specified file. If the filename ends with ".txt",
328
259
text format will be used. If the filename either starts with
329
260
"callgrind.out" or end with ".callgrind", the output will be
330
261
formatted for use with KCacheGrind. Otherwise, the output
331
262
will be a pickle.
332
--coverage Generate line coverage report in the specified directory.
334
See http://doc.bazaar.canonical.com/developers/profiling.html for more
335
information on profiling.
337
A number of debug flags are also available to assist troubleshooting and
338
development. See :doc:`debug-flags-help`.
341
_standard_options = \
344
Standard options are legal for all commands.
346
--help, -h Show help message.
347
--verbose, -v Display more information.
348
--quiet, -q Only display errors and warnings.
350
Unlike global options, standard options can be used in aliases.
264
See doc/developers/profiling.txt for more information on profiling.
266
Note: --version must be supplied before any command.
594
463
_env_variables = \
595
464
"""Environment Variables
597
=================== ===========================================================
598
BZRPATH Path where bzr is to look for shell plugin external
600
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
601
EMAIL E-Mail address of the user.
602
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
603
EDITOR Editor for editing commit messages.
604
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
605
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
606
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
607
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
608
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and
610
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
611
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp,
613
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
614
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
615
BZR_COLUMNS Override implicit terminal width.
616
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest)
617
BZR_PROGRESS_BAR Override the progress display. Values are 'none' or 'text'.
618
BZR_PDB Control whether to launch a debugger on error.
619
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a
621
=================== ===========================================================
466
================ =================================================================
467
BZRPATH Path where bzr is to look for shell plugin external commands.
468
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
469
EMAIL E-Mail address of the user.
470
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
471
EDITOR Editor for editing commit messages.
472
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
473
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
474
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
475
================ =================================================================
628
:On Unix: ~/.bazaar/bazaar.conf
482
:On Linux: ~/.bazaar/bazaar.conf
629
483
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
631
485
Contains the user's default configuration. The section ``[DEFAULT]`` is
643
497
log10 = log --short -r -10..-1
649
A criss-cross in the branch history can cause the default merge technique
650
to emit more conflicts than would normally be expected.
652
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
653
better results. You may wish to ``bzr revert`` the working tree and merge
654
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
656
Criss-crosses occur in a branch's history if two branches merge the same thing
657
and then merge one another, or if two branches merge one another at the same
658
time. They can be avoided by having each branch only merge from or into a
659
designated central branch (a "star topology").
661
Criss-crosses cause problems because of the way merge works. Bazaar's default
662
merge is a three-way merger; in order to merge OTHER into THIS, it must
663
find a basis for comparison, BASE. Using BASE, it can determine whether
664
differences between THIS and OTHER are due to one side adding lines, or
665
from another side removing lines.
667
Criss-crosses mean there is no good choice for a base. Selecting the recent
668
merge points could cause one side's changes to be silently discarded.
669
Selecting older merge points (which Bazaar does) mean that extra conflicts
672
The ``weave`` merge type is not affected by this problem because it uses
673
line-origin detection instead of a basis revision to determine the cause of
677
_branches_out_of_sync = """Branches Out of Sync
679
When reconfiguring a checkout, tree or branch into a lightweight checkout,
680
a local branch must be destroyed. (For checkouts, this is the local branch
681
that serves primarily as a cache.) If the branch-to-be-destroyed does not
682
have the same last revision as the new reference branch for the lightweight
683
checkout, data could be lost, so Bazaar refuses.
685
How you deal with this depends on *why* the branches are out of sync.
687
If you have a checkout and have done local commits, you can get back in sync
688
by running "bzr update" (and possibly "bzr commit").
690
If you have a branch and the remote branch is out-of-date, you can push
691
the local changes using "bzr push". If the local branch is out of date, you
692
can do "bzr pull". If both branches have had changes, you can merge, commit
693
and then push your changes. If you decide that some of the changes aren't
694
useful, you can "push --overwrite" or "pull --overwrite" instead.
701
To ensure that older clients do not access data incorrectly,
702
Bazaar's policy is to introduce a new storage format whenever
703
new features requiring new metadata are added. New storage
704
formats may also be introduced to improve performance and
707
The newest format, 2a, is highly recommended. If your
708
project is not using 2a, then you should suggest to the
709
project owner to upgrade.
714
Some of the older formats have two variants:
715
a plain one and a rich-root one. The latter include an additional
716
field about the root of the tree. There is no performance cost
717
for using a rich-root format but you cannot easily merge changes
718
from a rich-root format into a plain format. As a consequence,
719
moving a project to a rich-root format takes some co-ordination
720
in that all contributors need to upgrade their repositories
721
around the same time. 2a and all future formats will be
722
implicitly rich-root.
724
See :doc:`current-formats-help` for the complete list of
725
currently supported formats. See :doc:`other-formats-help` for
726
descriptions of any available experimental and deprecated formats.
730
# Register help topics
731
501
topic_registry.register("revisionspec", _help_on_revisionspec,
732
502
"Explain how to use --revision")
733
503
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
734
504
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
735
def get_current_formats_topic(topic):
736
from bzrlib import bzrdir
737
return "Current Storage Formats\n\n" + \
738
bzrdir.format_registry.help_topic(topic)
739
def get_other_formats_topic(topic):
740
from bzrlib import bzrdir
741
return "Other Storage Formats\n\n" + \
742
bzrdir.format_registry.help_topic(topic)
743
topic_registry.register('current-formats', get_current_formats_topic,
744
'Current storage formats')
745
topic_registry.register('other-formats', get_other_formats_topic,
746
'Experimental and deprecated storage formats')
747
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,
748
510
'Options that can be used with any command')
749
topic_registry.register('global-options', _global_options,
750
'Options that control how Bazaar runs')
511
topic_registry.register('checkouts', _checkouts,
512
'Information on what a checkout is', SECT_CONCEPT)
751
513
topic_registry.register('urlspec', _help_on_transport,
752
514
"Supported transport protocols")
753
515
topic_registry.register('status-flags', _status_flags,
754
516
"Help on status flags")
755
517
def get_bugs_topic(topic):
756
518
from bzrlib import bugtracker
757
return ("Bug Tracker Settings\n\n" +
758
bugtracker.tracker_registry.help_topic(topic))
759
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.',
524
topic_registry.register('working-trees', _working_trees,
525
'Information on working trees', SECT_CONCEPT)
760
526
topic_registry.register('env-variables', _env_variables,
761
527
'Environment variable names and values')
762
528
topic_registry.register('files', _files,
763
529
'Information on configuration and log files')
764
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
765
'Points at which custom processing can be added')
767
# Load some of the help topics from files. Note that topics which reproduce API
768
# details will tend to skew (quickly usually!) so please seek other solutions
770
topic_registry.register('authentication', _load_from_file,
771
'Information on configuring authentication')
772
topic_registry.register('configuration', _load_from_file,
773
'Details on the configuration settings available')
774
topic_registry.register('conflict-types', _load_from_file,
775
'Types of conflicts and what to do about them')
776
topic_registry.register('debug-flags', _load_from_file,
777
'Options to show or record debug information')
778
topic_registry.register('location-alias', _load_from_file,
779
'Aliases for remembered locations')
780
topic_registry.register('log-formats', _load_from_file,
781
'Details on the logging formats available')
782
topic_registry.register('url-special-chars', _load_from_file,
783
'Special character handling in URLs')
786
# Register concept topics.
787
# Note that we might choose to remove these from the online help in the
788
# future or implement them via loading content from files. In the meantime,
789
# please keep them concise.
790
topic_registry.register('branches', _branches,
791
'Information on what a branch is', SECT_CONCEPT)
792
topic_registry.register('checkouts', _checkouts,
793
'Information on what a checkout is', SECT_CONCEPT)
794
topic_registry.register('content-filters', _load_from_file,
795
'Conversion of content into/from working trees',
797
topic_registry.register('diverged-branches', _load_from_file,
798
'How to fix diverged branches',
800
topic_registry.register('eol', _load_from_file,
801
'Information on end-of-line handling',
803
topic_registry.register('formats', _storage_formats,
804
'Information on choosing a storage format',
806
topic_registry.register('patterns', _load_from_file,
807
'Information on the pattern syntax',
809
topic_registry.register('repositories', _repositories,
810
'Basic information on shared repositories.',
812
topic_registry.register('rules', _load_from_file,
813
'Information on defining rule-based preferences',
815
topic_registry.register('standalone-trees', _standalone_trees,
816
'Information on what a standalone tree is',
818
topic_registry.register('working-trees', _working_trees,
819
'Information on working trees', SECT_CONCEPT)
820
topic_registry.register('criss-cross', _criss_cross,
821
'Information on criss-cross merging', SECT_CONCEPT)
822
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
823
'Steps to resolve "out-of-sync" when reconfiguring',
827
532
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
