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:
302
233
bzr help init more help on e.g. init command
303
234
bzr help commands list all commands
304
235
bzr help topics list all help topics
305
""" % bzrlib.__version__
308
239
_global_options = \
309
240
"""Global Options
311
242
These options may be used with any command, and may appear in front of any
312
command. (e.g. ``bzr --profile help``).
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").
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
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
--no-l10n Do not translate messages.
320
--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
322
--profile Profile execution using the hotshot profiler.
323
--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
324
257
--lsprof-file Profile execution using the lsprof profiler, and write the
325
258
results to a specified file. If the filename ends with ".txt",
326
259
text format will be used. If the filename either starts with
327
260
"callgrind.out" or end with ".callgrind", the output will be
328
261
formatted for use with KCacheGrind. Otherwise, the output
329
262
will be a pickle.
330
--coverage Generate line coverage report in the specified directory.
332
See http://doc.bazaar.canonical.com/developers/profiling.html for more
333
information on profiling.
335
A number of debug flags are also available to assist troubleshooting and
336
development. See :doc:`debug-flags-help`.
339
_standard_options = \
342
Standard options are legal for all commands.
344
--help, -h Show help message.
345
--verbose, -v Display more information.
346
--quiet, -q Only display errors and warnings.
348
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.
592
463
_env_variables = \
593
464
"""Environment Variables
595
=================== ===========================================================
596
BZRPATH Path where bzr is to look for shell plugin external
598
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
599
EMAIL E-Mail address of the user.
600
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
601
EDITOR Editor for editing commit messages.
602
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
603
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
604
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
605
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
606
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and
608
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
609
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp,
611
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
612
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
613
BZR_COLUMNS Override implicit terminal width.
614
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest)
615
BZR_PROGRESS_BAR Override the progress display. Values are 'none', 'dots',
617
BZR_PDB Control whether to launch a debugger on error.
618
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a
620
=================== ===========================================================
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
================ =================================================================
627
:On Unix: ~/.bazaar/bazaar.conf
482
:On Linux: ~/.bazaar/bazaar.conf
628
483
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
630
485
Contains the user's default configuration. The section ``[DEFAULT]`` is
642
497
log10 = log --short -r -10..-1
648
A criss-cross in the branch history can cause the default merge technique
649
to emit more conflicts than would normally be expected.
651
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
652
better results. You may wish to ``bzr revert`` the working tree and merge
653
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
655
Criss-crosses occur in a branch's history if two branches merge the same thing
656
and then merge one another, or if two branches merge one another at the same
657
time. They can be avoided by having each branch only merge from or into a
658
designated central branch (a "star topology").
660
Criss-crosses cause problems because of the way merge works. Bazaar's default
661
merge is a three-way merger; in order to merge OTHER into THIS, it must
662
find a basis for comparison, BASE. Using BASE, it can determine whether
663
differences between THIS and OTHER are due to one side adding lines, or
664
from another side removing lines.
666
Criss-crosses mean there is no good choice for a base. Selecting the recent
667
merge points could cause one side's changes to be silently discarded.
668
Selecting older merge points (which Bazaar does) mean that extra conflicts
671
The ``weave`` merge type is not affected by this problem because it uses
672
line-origin detection instead of a basis revision to determine the cause of
676
_branches_out_of_sync = """Branches Out of Sync
678
When reconfiguring a checkout, tree or branch into a lightweight checkout,
679
a local branch must be destroyed. (For checkouts, this is the local branch
680
that serves primarily as a cache.) If the branch-to-be-destroyed does not
681
have the same last revision as the new reference branch for the lightweight
682
checkout, data could be lost, so Bazaar refuses.
684
How you deal with this depends on *why* the branches are out of sync.
686
If you have a checkout and have done local commits, you can get back in sync
687
by running "bzr update" (and possibly "bzr commit").
689
If you have a branch and the remote branch is out-of-date, you can push
690
the local changes using "bzr push". If the local branch is out of date, you
691
can do "bzr pull". If both branches have had changes, you can merge, commit
692
and then push your changes. If you decide that some of the changes aren't
693
useful, you can "push --overwrite" or "pull --overwrite" instead.
700
To ensure that older clients do not access data incorrectly,
701
Bazaar's policy is to introduce a new storage format whenever
702
new features requiring new metadata are added. New storage
703
formats may also be introduced to improve performance and
706
The newest format, 2a, is highly recommended. If your
707
project is not using 2a, then you should suggest to the
708
project owner to upgrade.
713
Some of the older formats have two variants:
714
a plain one and a rich-root one. The latter include an additional
715
field about the root of the tree. There is no performance cost
716
for using a rich-root format but you cannot easily merge changes
717
from a rich-root format into a plain format. As a consequence,
718
moving a project to a rich-root format takes some co-ordination
719
in that all contributors need to upgrade their repositories
720
around the same time. 2a and all future formats will be
721
implicitly rich-root.
723
See :doc:`current-formats-help` for the complete list of
724
currently supported formats. See :doc:`other-formats-help` for
725
descriptions of any available experimental and deprecated formats.
729
# Register help topics
730
501
topic_registry.register("revisionspec", _help_on_revisionspec,
731
502
"Explain how to use --revision")
732
503
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
733
504
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
734
def get_current_formats_topic(topic):
735
from bzrlib import bzrdir
736
return "Current Storage Formats\n\n" + \
737
bzrdir.format_registry.help_topic(topic)
738
def get_other_formats_topic(topic):
739
from bzrlib import bzrdir
740
return "Other Storage Formats\n\n" + \
741
bzrdir.format_registry.help_topic(topic)
742
topic_registry.register('current-formats', get_current_formats_topic,
743
'Current storage formats')
744
topic_registry.register('other-formats', get_other_formats_topic,
745
'Experimental and deprecated storage formats')
746
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,
747
510
'Options that can be used with any command')
748
topic_registry.register('global-options', _global_options,
749
'Options that control how Bazaar runs')
511
topic_registry.register('checkouts', _checkouts,
512
'Information on what a checkout is', SECT_CONCEPT)
750
513
topic_registry.register('urlspec', _help_on_transport,
751
514
"Supported transport protocols")
752
515
topic_registry.register('status-flags', _status_flags,
753
516
"Help on status flags")
754
517
def get_bugs_topic(topic):
755
518
from bzrlib import bugtracker
756
return ("Bug Tracker Settings\n\n" +
757
bugtracker.tracker_registry.help_topic(topic))
758
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)
759
526
topic_registry.register('env-variables', _env_variables,
760
527
'Environment variable names and values')
761
528
topic_registry.register('files', _files,
762
529
'Information on configuration and log files')
763
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
764
'Points at which custom processing can be added')
766
# Load some of the help topics from files. Note that topics which reproduce API
767
# details will tend to skew (quickly usually!) so please seek other solutions
769
topic_registry.register('authentication', _load_from_file,
770
'Information on configuring authentication')
771
topic_registry.register('configuration', _load_from_file,
772
'Details on the configuration settings available')
773
topic_registry.register('conflict-types', _load_from_file,
774
'Types of conflicts and what to do about them')
775
topic_registry.register('debug-flags', _load_from_file,
776
'Options to show or record debug information')
777
topic_registry.register('location-alias', _load_from_file,
778
'Aliases for remembered locations')
779
topic_registry.register('log-formats', _load_from_file,
780
'Details on the logging formats available')
783
# Register concept topics.
784
# Note that we might choose to remove these from the online help in the
785
# future or implement them via loading content from files. In the meantime,
786
# please keep them concise.
787
topic_registry.register('branches', _branches,
788
'Information on what a branch is', SECT_CONCEPT)
789
topic_registry.register('checkouts', _checkouts,
790
'Information on what a checkout is', SECT_CONCEPT)
791
topic_registry.register('content-filters', _load_from_file,
792
'Conversion of content into/from working trees',
794
topic_registry.register('diverged-branches', _load_from_file,
795
'How to fix diverged branches',
797
topic_registry.register('eol', _load_from_file,
798
'Information on end-of-line handling',
800
topic_registry.register('formats', _storage_formats,
801
'Information on choosing a storage format',
803
topic_registry.register('patterns', _load_from_file,
804
'Information on the pattern syntax',
806
topic_registry.register('repositories', _repositories,
807
'Basic information on shared repositories.',
809
topic_registry.register('rules', _load_from_file,
810
'Information on defining rule-based preferences',
812
topic_registry.register('standalone-trees', _standalone_trees,
813
'Information on what a standalone tree is',
815
topic_registry.register('working-trees', _working_trees,
816
'Information on working trees', SECT_CONCEPT)
817
topic_registry.register('criss-cross', _criss_cross,
818
'Information on criss-cross merging', SECT_CONCEPT)
819
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
820
'Steps to resolve "out-of-sync" when reconfiguring',
824
532
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
