13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""A collection of extra help information for using bzr.
137
131
def _load_from_file(topic_name):
138
132
"""Load help from a file.
140
Topics are expected to be txt files in bzrlib.help_topics.
134
The help is already expected to be in ReStructuredText format.
142
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
143
return osutils.resource_string('bzrlib.help_topics', resource_name)
138
filename = "%s/doc/en/user-reference/%s.txt" % (bzr_dir,topic_name)
139
lines = open(filename).readlines()
140
return ''.join(lines)
146
143
def _help_on_revisionspec(name):
149
146
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:
149
out.append("Revision Identifiers\n")
150
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")
152
details.append("\nFurther details are given below.\n")
186
154
# The help text is indented 4 spaces - this re cleans that up below
187
155
indent_re = re.compile(r'^ ', re.MULTILINE)
188
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
156
for i in bzrlib.revisionspec.SPEC_TYPES:
190
158
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
197
165
#doc = indent_re.sub('', doc)
198
166
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
201
169
# Note: The leading : here are HACKs to get reStructuredText
202
170
# 'field' formatting - we know that the prefix ends in a ':'.
203
171
out.append(":%s\n\t%s" % (i.prefix, summary))
215
183
def add_string(proto, help, maxl, prefix_width=20):
216
help_lines = textwrap.wrap(help, maxl - prefix_width,
217
break_long_words=False)
184
help_lines = textwrap.wrap(help, maxl - prefix_width)
218
185
line_with_indent = '\n' + ' ' * prefix_width
219
186
help_text = line_with_indent.join(help_lines)
220
187
return "%-20s%s\n" % (proto, help_text)
251
218
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/
225
"""Bazaar -- a free distributed version-control tool
226
http://bazaar-vcs.org/
285
229
bzr init makes this directory a versioned branch
302
245
bzr help init more help on e.g. init command
303
246
bzr help commands list all commands
304
247
bzr help topics list all help topics
305
""" % bzrlib.__version__
308
251
_global_options = \
309
252
"""Global Options
311
254
These options may be used with any command, and may appear in front of any
312
command. (e.g. ``bzr --profile help``).
255
command. (e.g. "bzr --profile help").
314
257
--version Print the version number. Must be supplied before the command.
315
258
--no-aliases Do not process command aliases when running this command.
316
259
--builtin Use the built-in version of a command, not the plugin version.
317
260
This does not suppress other plugin effects.
318
261
--no-plugins Do not process any plugins.
319
--concurrency Number of processes that can be run concurrently (selftest).
321
263
--profile Profile execution using the hotshot profiler.
322
264
--lsprof Profile execution using the lsprof profiler.
326
268
"callgrind.out" or end with ".callgrind", the output will be
327
269
formatted for use with KCacheGrind. Otherwise, the output
328
270
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.
272
See doc/developers/profiling.txt for more information on profiling.
334
273
A number of debug flags are also available to assist troubleshooting and
335
development. See :doc:`debug-flags-help`.
276
-Dauth Trace authentication sections used.
277
-Derror Instead of normal error handling, always print a traceback on
279
-Devil Capture call sites that do expensive or badly-scaling
281
-Dhashcache Log every time a working file is read to determine its hash.
282
-Dhooks Trace hook execution.
283
-Dhttp Trace http connections, requests and responses
284
-Dhpss Trace smart protocol requests and responses.
285
-Dindex Trace major index operations.
286
-Dlock Trace when lockdir locks are taken or released.
287
-Dmerge Emit information for debugging merges.
338
290
_standard_options = \
339
291
"""Standard Options
341
293
Standard options are legal for all commands.
343
295
--help, -h Show help message.
344
296
--verbose, -v Display more information.
345
297
--quiet, -q Only display errors and warnings.
390
342
Lightweight checkouts work best when you have fast reliable access to the
391
343
master branch. This means that if the master branch is on the same disk or LAN
392
344
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.
345
that modify the revision history (as only one copy branch needs to be updated).
346
Heavyweight checkouts will generally be faster for any command that uses the
347
history but does not change it, but if the master branch is on the same disk
348
then there wont be a noticeable difference.
398
350
Another possible use for a checkout is to use it with a treeless repository
399
351
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
352
switching the master branch that the checkout points to when you want to
401
353
work on a different branch.
403
355
Obviously to commit on a checkout you need to be able to write to the master
406
358
end. Checkouts also work on the local file system, so that all that matters is
407
359
file permissions.
409
You can change the master of a checkout by using the "switch" command (see
410
"help switch"). This will change the location that the commits are sent to.
411
The "bind" command can also be used to turn a normal branch into a heavy
412
checkout. If you would like to convert your heavy checkout into a normal
413
branch so that every commit is local, you can use the "unbind" command. To see
414
whether or not a branch is bound or not you can use the "info" command. If the
415
branch is bound it will tell you the location of the bound branch.
361
You can change the master of a checkout by using the "bind" command (see "help
362
bind"). This will change the location that the commits are sent to. The bind
363
command can also be used to turn a branch into a heavy checkout. If you
364
would like to convert your heavy checkout into a normal branch so that every
365
commit is local, you can use the "unbind" command.
417
367
Related commands::
421
371
update Pull any changes in the master branch in to your checkout
422
372
commit Make a commit that is sent to the master branch. If you have
423
a heavy checkout then the --local option will commit to the
373
a heavy checkout then the --local option will commit to the
424
374
checkout without sending the commit to the master
425
switch Change the master branch that the commits in the checkout will
375
bind Change the master branch that the commits in the checkout will
427
bind Turn a standalone branch into a heavy checkout so that any
428
commits will be sent to the master branch
429
377
unbind Turn a heavy checkout into a standalone branch so that any
430
378
commits are only made locally
431
info Displays whether a branch is bound or unbound. If the branch is
432
bound, then it will also display the location of the bound branch
435
381
_repositories = \
441
387
Repositories are a form of database. Bzr will usually maintain this for
442
388
good performance automatically, but in some situations (e.g. when doing
443
very many commits in a short time period) you may want to ask bzr to
389
very many commits in a short time period) you may want to ask bzr to
444
390
optimise the database indices. This can be done by the 'bzr pack' command.
446
392
By default just running 'bzr init' will create a repository within the new
525
471
branch history is stored), but multiple branches may share the same
526
472
repository (a shared repository). Branches can be copied and merged.
528
In addition, one branch may be bound to another one. Binding to another
529
branch indicates that commits which happen in this branch must also
530
happen in the other branch. Bazaar ensures consistency by not allowing
531
commits when the two branches are out of date. In order for a commit
532
to succeed, it may be necessary to update the current branch using
535
474
Related commands::
537
init Change a directory into a versioned branch.
538
branch Create a new branch that is a copy of an existing branch.
476
init Make a directory into a versioned branch.
477
branch Create a new copy of a branch.
539
478
merge Perform a three-way merge.
540
bind Bind a branch to another one.
601
538
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
602
539
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
603
540
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
604
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
605
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
606
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
607
BZR_COLUMNS Override implicit terminal width.
608
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest).
609
541
================ =================================================================
637
568
A criss-cross in the branch history can cause the default merge technique
638
569
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.
571
If you encounter criss-crosses, you can use merge --weave instead, which
572
should provide a much better result.
644
574
Criss-crosses occur in a branch's history if two branches merge the same thing
645
575
and then merge one another, or if two branches merge one another at the same
660
590
The ``weave`` merge type is not affected by this problem because it uses
661
591
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
595
# Register help topics
720
597
"Explain how to use --revision")
721
598
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
722
599
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')
600
def get_format_topic(topic):
601
from bzrlib import bzrdir
602
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
603
topic_registry.register('formats', get_format_topic, 'Directory formats')
735
604
topic_registry.register('standard-options', _standard_options,
736
605
'Options that can be used with any command')
737
606
topic_registry.register('global-options', _global_options,
742
611
"Help on status flags")
743
612
def get_bugs_topic(topic):
744
613
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')
614
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
615
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
748
616
topic_registry.register('env-variables', _env_variables,
749
617
'Environment variable names and values')
750
618
topic_registry.register('files', _files,
751
619
'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
621
# Load some of the help topics from files
758
622
topic_registry.register('authentication', _load_from_file,
759
623
'Information on configuring authentication')
760
624
topic_registry.register('configuration', _load_from_file,
761
625
'Details on the configuration settings available')
762
topic_registry.register('conflict-types', _load_from_file,
626
topic_registry.register('conflicts', _load_from_file,
763
627
'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')
628
topic_registry.register('hooks', _load_from_file,
629
'Points at which custom processing can be added')
772
632
# Register concept topics.
777
637
'Information on what a branch is', SECT_CONCEPT)
778
638
topic_registry.register('checkouts', _checkouts,
779
639
'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
640
topic_registry.register('repositories', _repositories,
796
641
'Basic information on shared repositories.',
798
topic_registry.register('rules', _load_from_file,
799
'Information on defining rule-based preferences',
801
643
topic_registry.register('standalone-trees', _standalone_trees,
802
644
'Information on what a standalone tree is',
805
647
'Information on working trees', SECT_CONCEPT)
806
648
topic_registry.register('criss-cross', _criss_cross,
807
649
'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
652
class HelpTopicIndex(object):
854
693
returned instead of plain text.
856
695
result = topic_registry.get_detail(self.topic)
857
# there is code duplicated here and in bzrlib/plugin.py's
696
# there is code duplicated here and in bzrlib/plugin.py's
858
697
# matching Topic code. This should probably be factored in
859
698
# to a helper function and a common base class.
860
699
if additional_see_also is not None:
added
removed
bzrlib/help_topics.py
