134
128
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 bzrlib.help_topics.
142
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
143
return osutils.resource_string('bzrlib.help_topics', resource_name)
146
131
def _help_on_revisionspec(name):
147
132
"""Generate the help for revision specs."""
149
134
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
"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
180
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")
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")
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:
190
146
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
591
481
_env_variables = \
592
482
"""Environment Variables
594
=================== =======================================================================
595
BZRPATH Path where bzr is to look for shell plugin external commands.
596
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
597
EMAIL E-Mail address of the user.
598
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
599
EDITOR Editor for editing commit messages.
600
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
601
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
602
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
603
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
604
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
605
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
606
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
607
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
608
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
609
BZR_COLUMNS Override implicit terminal width.
610
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest).
611
BZR_PROGRESS_BAR Override the progress display. Values are 'none', 'dots', or 'tty'.
612
BZR_PDB Control whether to launch a debugger on error.
613
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a breakin debugger.
614
=================== =======================================================================
484
================ =================================================================
485
BZRPATH Path where bzr is to look for shell plugin external commands.
486
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
487
EMAIL E-Mail address of the user.
488
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
489
EDITOR Editor for editing commit messages.
490
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
491
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
492
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
493
================ =================================================================
621
:On Unix: ~/.bazaar/bazaar.conf
500
:On Linux: ~/.bazaar/bazaar.conf
622
501
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
624
503
Contains the user's default configuration. The section ``[DEFAULT]`` is
636
515
log10 = log --short -r -10..-1
642
A criss-cross in the branch history can cause the default merge technique
643
to emit more conflicts than would normally be expected.
645
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
646
better results. You may wish to ``bzr revert`` the working tree and merge
647
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
649
Criss-crosses occur in a branch's history if two branches merge the same thing
650
and then merge one another, or if two branches merge one another at the same
651
time. They can be avoided by having each branch only merge from or into a
652
designated central branch (a "star topology").
654
Criss-crosses cause problems because of the way merge works. Bazaar's default
655
merge is a three-way merger; in order to merge OTHER into THIS, it must
656
find a basis for comparison, BASE. Using BASE, it can determine whether
657
differences between THIS and OTHER are due to one side adding lines, or
658
from another side removing lines.
660
Criss-crosses mean there is no good choice for a base. Selecting the recent
661
merge points could cause one side's changes to be silently discarded.
662
Selecting older merge points (which Bazaar does) mean that extra conflicts
665
The ``weave`` merge type is not affected by this problem because it uses
666
line-origin detection instead of a basis revision to determine the cause of
670
_branches_out_of_sync = """Branches Out of Sync
672
When reconfiguring a checkout, tree or branch into a lightweight checkout,
673
a local branch must be destroyed. (For checkouts, this is the local branch
674
that serves primarily as a cache.) If the branch-to-be-destroyed does not
675
have the same last revision as the new reference branch for the lightweight
676
checkout, data could be lost, so Bazaar refuses.
678
How you deal with this depends on *why* the branches are out of sync.
680
If you have a checkout and have done local commits, you can get back in sync
681
by running "bzr update" (and possibly "bzr commit").
683
If you have a branch and the remote branch is out-of-date, you can push
684
the local changes using "bzr push". If the local branch is out of date, you
685
can do "bzr pull". If both branches have had changes, you can merge, commit
686
and then push your changes. If you decide that some of the changes aren't
687
useful, you can "push --overwrite" or "pull --overwrite" instead.
694
To ensure that older clients do not access data incorrectly,
695
Bazaar's policy is to introduce a new storage format whenever
696
new features requiring new metadata are added. New storage
697
formats may also be introduced to improve performance and
700
The newest format, 2a, is highly recommended. If your
701
project is not using 2a, then you should suggest to the
702
project owner to upgrade.
707
Some of the older formats have two variants:
708
a plain one and a rich-root one. The latter include an additional
709
field about the root of the tree. There is no performance cost
710
for using a rich-root format but you cannot easily merge changes
711
from a rich-root format into a plain format. As a consequence,
712
moving a project to a rich-root format takes some co-ordination
713
in that all contributors need to upgrade their repositories
714
around the same time. 2a and all future formats will be
715
implicitly rich-root.
717
See :doc:`current-formats-help` for the complete list of
718
currently supported formats. See :doc:`other-formats-help` for
719
descriptions of any available experimental and deprecated formats.
723
# Register help topics
724
519
topic_registry.register("revisionspec", _help_on_revisionspec,
725
520
"Explain how to use --revision")
726
521
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
727
522
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
728
def get_current_formats_topic(topic):
729
from bzrlib import bzrdir
730
return "Current Storage Formats\n\n" + \
731
bzrdir.format_registry.help_topic(topic)
732
def get_other_formats_topic(topic):
733
from bzrlib import bzrdir
734
return "Other Storage Formats\n\n" + \
735
bzrdir.format_registry.help_topic(topic)
736
topic_registry.register('current-formats', get_current_formats_topic,
737
'Current storage formats')
738
topic_registry.register('other-formats', get_other_formats_topic,
739
'Experimental and deprecated storage formats')
523
def get_format_topic(topic):
524
from bzrlib import bzrdir
525
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
526
topic_registry.register('formats', get_format_topic, 'Directory formats')
740
527
topic_registry.register('standard-options', _standard_options,
741
528
'Options that can be used with any command')
742
529
topic_registry.register('global-options', _global_options,
743
530
'Options that control how Bazaar runs')
531
topic_registry.register('checkouts', _checkouts,
532
'Information on what a checkout is', SECT_CONCEPT)
744
533
topic_registry.register('urlspec', _help_on_transport,
745
534
"Supported transport protocols")
746
535
topic_registry.register('status-flags', _status_flags,
747
536
"Help on status flags")
748
537
def get_bugs_topic(topic):
749
538
from bzrlib import bugtracker
750
return ("Bug Tracker Settings\n\n" +
751
bugtracker.tracker_registry.help_topic(topic))
752
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
539
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
540
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
541
topic_registry.register('repositories', _repositories,
542
'Basic information on shared repositories.',
544
topic_registry.register('working-trees', _working_trees,
545
'Information on working trees', SECT_CONCEPT)
753
546
topic_registry.register('env-variables', _env_variables,
754
547
'Environment variable names and values')
755
548
topic_registry.register('files', _files,
756
549
'Information on configuration and log files')
757
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
758
'Points at which custom processing can be added')
760
# Load some of the help topics from files. Note that topics which reproduce API
761
# details will tend to skew (quickly usually!) so please seek other solutions
763
topic_registry.register('authentication', _load_from_file,
764
'Information on configuring authentication')
765
topic_registry.register('configuration', _load_from_file,
766
'Details on the configuration settings available')
767
topic_registry.register('conflict-types', _load_from_file,
768
'Types of conflicts and what to do about them')
769
topic_registry.register('debug-flags', _load_from_file,
770
'Options to show or record debug information')
771
topic_registry.register('location-alias', _load_from_file,
772
'Aliases for remembered locations')
773
topic_registry.register('log-formats', _load_from_file,
774
'Details on the logging formats available')
777
# Register concept topics.
778
# Note that we might choose to remove these from the online help in the
779
# future or implement them via loading content from files. In the meantime,
780
# please keep them concise.
781
topic_registry.register('branches', _branches,
782
'Information on what a branch is', SECT_CONCEPT)
783
topic_registry.register('checkouts', _checkouts,
784
'Information on what a checkout is', SECT_CONCEPT)
785
topic_registry.register('content-filters', _load_from_file,
786
'Conversion of content into/from working trees',
788
topic_registry.register('diverged-branches', _load_from_file,
789
'How to fix diverged branches',
791
topic_registry.register('eol', _load_from_file,
792
'Information on end-of-line handling',
794
topic_registry.register('formats', _storage_formats,
795
'Information on choosing a storage format',
797
topic_registry.register('patterns', _load_from_file,
798
'Information on the pattern syntax',
800
topic_registry.register('repositories', _repositories,
801
'Basic information on shared repositories.',
803
topic_registry.register('rules', _load_from_file,
804
'Information on defining rule-based preferences',
806
topic_registry.register('standalone-trees', _standalone_trees,
807
'Information on what a standalone tree is',
809
topic_registry.register('working-trees', _working_trees,
810
'Information on working trees', SECT_CONCEPT)
811
topic_registry.register('criss-cross', _criss_cross,
812
'Information on criss-cross merging', SECT_CONCEPT)
813
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
814
'Steps to resolve "out-of-sync" when reconfiguring',
818
552
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
