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:
251
206
out += "\nSupported modifiers::\n\n " + \
255
\nBazaar supports all of the standard parts within the URL::
257
<protocol>://[user[:password]@]host[:port]/[path]
259
allowing URLs such as::
261
http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
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::
269
bzr+ssh://remote@shell.example.com/~/myproject/trunk
271
would refer to ``/home/remote/myproject/trunk``.
273
Many commands that accept URLs also accept location aliases too. See
274
::doc:`location-alias-help`.
281
"""Bazaar %s -- a free distributed version-control tool
282
http://www.bazaar.canonical.com/
213
"""Bazaar -- a free distributed version-control tool
214
http://bazaar-vcs.org/
285
217
bzr init makes this directory a versioned branch
326
256
"callgrind.out" or end with ".callgrind", the output will be
327
257
formatted for use with KCacheGrind. Otherwise, the output
328
258
will be a pickle.
329
--coverage Generate line coverage report in the specified directory.
331
See http://doc.bazaar.canonical.com/developers/profiling.html for more
332
information on profiling.
260
See doc/developers/profiling.txt for more information on profiling.
334
261
A number of debug flags are also available to assist troubleshooting and
335
development. See :doc:`debug-flags-help`.
264
-Dauth Trace authentication sections used.
265
-Derror Instead of normal error handling, always print a traceback on
267
-Devil Capture call sites that do expensive or badly-scaling
269
-Dhashcache Log every time a working file is read to determine its hash.
270
-Dhooks Trace hook execution.
271
-Dhpss Trace smart protocol requests and responses.
272
-Dindex Trace major index operations.
273
-Dlock Trace when lockdir locks are taken or released.
338
276
_standard_options = \
339
277
"""Standard Options
341
279
Standard options are legal for all commands.
343
281
--help, -h Show help message.
344
282
--verbose, -v Display more information.
345
283
--quiet, -q Only display errors and warnings.
390
328
Lightweight checkouts work best when you have fast reliable access to the
391
329
master branch. This means that if the master branch is on the same disk or LAN
392
330
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.
331
that modify the revision history (as only one copy branch needs to be updated).
332
Heavyweight checkouts will generally be faster for any command that uses the
333
history but does not change it, but if the master branch is on the same disk
334
then there wont be a noticeable difference.
398
336
Another possible use for a checkout is to use it with a treeless repository
399
337
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
338
switching the master branch that the checkout points to when you want to
401
339
work on a different branch.
403
341
Obviously to commit on a checkout you need to be able to write to the master
631
549
log10 = log --short -r -10..-1
637
A criss-cross in the branch history can cause the default merge technique
638
to emit more conflicts than would normally be expected.
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.
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").
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.
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
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
665
_branches_out_of_sync = """Branches Out of Sync
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.
673
How you deal with this depends on *why* the branches are out of sync.
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").
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.
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
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.
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.
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.
718
553
# Register help topics
719
554
topic_registry.register("revisionspec", _help_on_revisionspec,
720
555
"Explain how to use --revision")
721
556
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
722
557
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')
558
def get_format_topic(topic):
559
from bzrlib import bzrdir
560
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
561
topic_registry.register('formats', get_format_topic, 'Directory formats')
735
562
topic_registry.register('standard-options', _standard_options,
736
563
'Options that can be used with any command')
737
564
topic_registry.register('global-options', _global_options,
742
569
"Help on status flags")
743
570
def get_bugs_topic(topic):
744
571
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')
572
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
573
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
748
574
topic_registry.register('env-variables', _env_variables,
749
575
'Environment variable names and values')
750
576
topic_registry.register('files', _files,
751
577
'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')
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
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')
772
580
# Register concept topics.
777
585
'Information on what a branch is', SECT_CONCEPT)
778
586
topic_registry.register('checkouts', _checkouts,
779
587
'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',
783
topic_registry.register('diverged-branches', _load_from_file,
784
'How to fix diverged branches',
786
topic_registry.register('eol', _load_from_file,
787
'Information on end-of-line handling',
789
topic_registry.register('formats', _storage_formats,
790
'Information on choosing a storage format',
792
topic_registry.register('patterns', _load_from_file,
793
'Information on the pattern syntax',
795
588
topic_registry.register('repositories', _repositories,
796
589
'Basic information on shared repositories.',
798
topic_registry.register('rules', _load_from_file,
799
'Information on defining rule-based preferences',
801
591
topic_registry.register('standalone-trees', _standalone_trees,
802
592
'Information on what a standalone tree is',
804
594
topic_registry.register('working-trees', _working_trees,
805
595
'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',
813
598
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
