1
# Copyright (C) 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""A collection of extra help information for using bzr.
19
Help topics are meant to be help for items that aren't commands, but will
20
help bzr become fully learnable without referring to a tutorial.
22
Limited formatting of help text is permitted to make the text useful
23
both within the reference manual (reStructuredText) and on the screen.
24
The help text should be reStructuredText with formatting kept to a
25
minimum and, in particular, no headings. The onscreen renderer applies
26
the following simple rules before rendering the text:
28
1. A '::' appearing on the end of a line is replaced with ':'.
29
2. Lines starting with a ':' have it stripped.
31
These rules mean that literal blocks and field lists respectively can
32
be used in the help text, producing sensible input to a manual while
33
rendering on the screen naturally.
45
# Section identifiers (map topics to the right place in the manual)
46
SECT_COMMAND = "command"
47
SECT_CONCEPT = "concept"
48
SECT_HIDDEN = "hidden"
50
SECT_PLUGIN = "plugin"
53
class HelpTopicRegistry(registry.Registry):
54
"""A Registry customized for handling help topics."""
56
def register(self, topic, detail, summary, section=SECT_LIST):
57
"""Register a new help topic.
59
:param topic: Name of documentation entry
60
:param detail: Function or string object providing detailed
61
documentation for topic. Function interface is detail(topic).
62
This should return a text string of the detailed information.
63
See the module documentation for details on help text formatting.
64
:param summary: String providing single-line documentation for topic.
65
:param section: Section in reference manual - see SECT_* identifiers.
67
# The detail is stored as the 'object' and the metadata as the info
68
info=(summary,section)
69
super(HelpTopicRegistry, self).register(topic, detail, info=info)
71
def register_lazy(self, topic, module_name, member_name, summary,
73
"""Register a new help topic, and import the details on demand.
75
:param topic: Name of documentation entry
76
:param module_name: The module to find the detailed help.
77
:param member_name: The member of the module to use for detailed help.
78
:param summary: String providing single-line documentation for topic.
79
:param section: Section in reference manual - see SECT_* identifiers.
81
# The detail is stored as the 'object' and the metadata as the info
82
info=(summary,section)
83
super(HelpTopicRegistry, self).register_lazy(topic, module_name,
84
member_name, info=info)
86
def get_detail(self, topic):
87
"""Get the detailed help on a given topic."""
94
def get_summary(self, topic):
95
"""Get the single line summary for the topic."""
96
info = self.get_info(topic)
102
def get_section(self, topic):
103
"""Get the section for the topic."""
104
info = self.get_info(topic)
110
def get_topics_for_section(self, section):
111
"""Get the set of topics in a section."""
113
for topic in self.keys():
114
if section == self.get_section(topic):
119
topic_registry = HelpTopicRegistry()
122
#----------------------------------------------------
124
def _help_on_topics(dummy):
125
"""Write out the help for topics to outfile"""
127
topics = topic_registry.keys()
128
lmax = max(len(topic) for topic in topics)
132
summary = topic_registry.get_summary(topic)
133
out.append("%-*s %s\n" % (lmax, topic, summary))
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
def _help_on_revisionspec(name):
147
"""Generate the help for revision specs."""
149
import bzrlib.revisionspec
153
"""Revision Identifiers
155
A revision identifier refers to a specific state of a branch's history. It can
156
be a revision number, or a keyword followed by ':' and often other
157
parameters. Some examples of identifiers are '3', 'last:1', 'before:yesterday'
160
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
161
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
162
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
163
spaces around the '..').
165
Ranges are interpreted differently by different commands. To the "log" command,
166
a range is a sequence of log messages, but to the "diff" command, the range
167
denotes a change between revisions (and not a sequence of changes). In
168
addition, "log" considers a closed range whereas "diff" and "merge" consider it
169
to be open-ended, that is, they include one end but not the other. For example:
170
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
171
while "bzr diff -r 3647..3649" includes the changes done in revisions 3647 and
174
The keywords used as revision selection methods are the following:
177
details.append("\nIn addition, plugins can provide other keywords.")
178
details.append("\nA detailed description of each keyword is given below.\n")
180
# The help text is indented 4 spaces - this re cleans that up below
181
indent_re = re.compile(r'^ ', re.MULTILINE)
182
for i in bzrlib.revisionspec.SPEC_TYPES:
184
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
188
# Extract out the top line summary from the body and
189
# clean-up the unwanted whitespace
190
summary,doc = doc.split("\n", 1)
191
#doc = indent_re.sub('', doc)
192
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
195
# Note: The leading : here are HACKs to get reStructuredText
196
# 'field' formatting - we know that the prefix ends in a ':'.
197
out.append(":%s\n\t%s" % (i.prefix, summary))
198
details.append(":%s\n%s" % (i.prefix, doc))
200
return '\n'.join(out + details)
203
def _help_on_transport(name):
204
from bzrlib.transport import (
205
transport_list_registry,
209
def add_string(proto, help, maxl, prefix_width=20):
210
help_lines = textwrap.wrap(help, maxl - prefix_width)
211
line_with_indent = '\n' + ' ' * prefix_width
212
help_text = line_with_indent.join(help_lines)
213
return "%-20s%s\n" % (proto, help_text)
216
a1 = a[:a.rfind("://")]
217
b1 = b[:b.rfind("://")]
227
protos = transport_list_registry.keys( )
228
protos.sort(sort_func)
230
shorthelp = transport_list_registry.get_help(proto)
233
if proto.endswith("://"):
234
protl.append(add_string(proto, shorthelp, 79))
236
decl.append(add_string(proto, shorthelp, 79))
239
out = "URL Identifiers\n\n" + \
240
"Supported URL prefixes::\n\n " + \
244
out += "\nSupported modifiers::\n\n " + \
251
"""Bazaar -- a free distributed version-control tool
252
http://bazaar-vcs.org/
255
bzr init makes this directory a versioned branch
256
bzr branch make a copy of another branch
258
bzr add make files or directories versioned
259
bzr ignore ignore a file or pattern
260
bzr mv move or rename a versioned file
262
bzr status summarize changes in working copy
263
bzr diff show detailed diffs
265
bzr merge pull in changes from another branch
266
bzr commit save some or all changes
268
bzr log show history of changes
269
bzr check validate storage
271
bzr help init more help on e.g. init command
272
bzr help commands list all commands
273
bzr help topics list all help topics
280
These options may be used with any command, and may appear in front of any
281
command. (e.g. "bzr --profile help").
283
--version Print the version number. Must be supplied before the command.
284
--no-aliases Do not process command aliases when running this command.
285
--builtin Use the built-in version of a command, not the plugin version.
286
This does not suppress other plugin effects.
287
--no-plugins Do not process any plugins.
289
--profile Profile execution using the hotshot profiler.
290
--lsprof Profile execution using the lsprof profiler.
291
--lsprof-file Profile execution using the lsprof profiler, and write the
292
results to a specified file. If the filename ends with ".txt",
293
text format will be used. If the filename either starts with
294
"callgrind.out" or end with ".callgrind", the output will be
295
formatted for use with KCacheGrind. Otherwise, the output
297
--coverage Generate line coverage report in the specified directory.
299
See doc/developers/profiling.txt for more information on profiling.
300
A number of debug flags are also available to assist troubleshooting and
303
-Dauth Trace authentication sections used.
304
-Derror Instead of normal error handling, always print a traceback
306
-Devil Capture call sites that do expensive or badly-scaling
308
-Dfetch Trace history copying between repositories.
309
-Dhashcache Log every time a working file is read to determine its hash.
310
-Dhooks Trace hook execution.
311
-Dhpss Trace smart protocol requests and responses.
312
-Dhttp Trace http connections, requests and responses
313
-Dindex Trace major index operations.
314
-Dknit Trace knit operations.
315
-Dlock Trace when lockdir locks are taken or released.
316
-Dmerge Emit information for debugging merges.
317
-Dpack Emit information about pack operations.
320
_standard_options = \
323
Standard options are legal for all commands.
325
--help, -h Show help message.
326
--verbose, -v Display more information.
327
--quiet, -q Only display errors and warnings.
329
Unlike global options, standard options can be used in aliases.
336
Checkouts are source trees that are connected to a branch, so that when
337
you commit in the source tree, the commit goes into that branch. They
338
allow you to use a simpler, more centralized workflow, ignoring some of
339
Bazaar's decentralized features until you want them. Using checkouts
340
with shared repositories is very similar to working with SVN or CVS, but
341
doesn't have the same restrictions. And using checkouts still allows
342
others working on the project to use whatever workflow they like.
344
A checkout is created with the bzr checkout command (see "help checkout").
345
You pass it a reference to another branch, and it will create a local copy
346
for you that still contains a reference to the branch you created the
347
checkout from (the master branch). Then if you make any commits they will be
348
made on the other branch first. This creates an instant mirror of your work, or
349
facilitates lockstep development, where each developer is working together,
350
continuously integrating the changes of others.
352
However the checkout is still a first class branch in Bazaar terms, so that
353
you have the full history locally. As you have a first class branch you can
354
also commit locally if you want, for instance due to the temporary loss af a
355
network connection. Use the --local option to commit to do this. All the local
356
commits will then be made on the master branch the next time you do a non-local
359
If you are using a checkout from a shared branch you will periodically want to
360
pull in all the changes made by others. This is done using the "update"
361
command. The changes need to be applied before any non-local commit, but
362
Bazaar will tell you if there are any changes and suggest that you use this
365
It is also possible to create a "lightweight" checkout by passing the
366
--lightweight flag to checkout. A lightweight checkout is even closer to an
367
SVN checkout in that it is not a first class branch, it mainly consists of the
368
working tree. This means that any history operations must query the master
369
branch, which could be slow if a network connection is involved. Also, as you
370
don't have a local branch, then you cannot commit locally.
372
Lightweight checkouts work best when you have fast reliable access to the
373
master branch. This means that if the master branch is on the same disk or LAN
374
a lightweight checkout will be faster than a heavyweight one for any commands
375
that modify the revision history (as only one copy of the branch needs to
376
be updated). Heavyweight checkouts will generally be faster for any command
377
that uses the history but does not change it, but if the master branch is on
378
the same disk then there won't be a noticeable difference.
380
Another possible use for a checkout is to use it with a treeless repository
381
containing your branches, where you maintain only one working tree by
382
switching the master branch that the checkout points to when you want to
383
work on a different branch.
385
Obviously to commit on a checkout you need to be able to write to the master
386
branch. This means that the master branch must be accessible over a writeable
387
protocol , such as sftp://, and that you have write permissions at the other
388
end. Checkouts also work on the local file system, so that all that matters is
391
You can change the master of a checkout by using the "bind" command (see "help
392
bind"). This will change the location that the commits are sent to. The bind
393
command can also be used to turn a branch into a heavy checkout. If you
394
would like to convert your heavy checkout into a normal branch so that every
395
commit is local, you can use the "unbind" command.
399
checkout Create a checkout. Pass --lightweight to get a lightweight
401
update Pull any changes in the master branch in to your checkout
402
commit Make a commit that is sent to the master branch. If you have
403
a heavy checkout then the --local option will commit to the
404
checkout without sending the commit to the master
405
bind Change the master branch that the commits in the checkout will
407
unbind Turn a heavy checkout into a standalone branch so that any
408
commits are only made locally
414
Repositories in Bazaar are where committed information is stored. There is
415
a repository associated with every branch.
417
Repositories are a form of database. Bzr will usually maintain this for
418
good performance automatically, but in some situations (e.g. when doing
419
very many commits in a short time period) you may want to ask bzr to
420
optimise the database indices. This can be done by the 'bzr pack' command.
422
By default just running 'bzr init' will create a repository within the new
423
branch but it is possible to create a shared repository which allows multiple
424
branches to share their information in the same location. When a new branch is
425
created it will first look to see if there is a containing shared repository it
428
When two branches of the same project share a repository, there is
429
generally a large space saving. For some operations (e.g. branching
430
within the repository) this translates in to a large time saving.
432
To create a shared repository use the init-repository command (or the alias
433
init-repo). This command takes the location of the repository to create. This
434
means that 'bzr init-repository repo' will create a directory named 'repo',
435
which contains a shared repository. Any new branches that are created in this
436
directory will then use it for storage.
438
It is a good idea to create a repository whenever you might create more
439
than one branch of a project. This is true for both working areas where you
440
are doing the development, and any server areas that you use for hosting
441
projects. In the latter case, it is common to want branches without working
442
trees. Since the files in the branch will not be edited directly there is no
443
need to use up disk space for a working tree. To create a repository in which
444
the branches will not have working trees pass the '--no-trees' option to
449
init-repository Create a shared repository. Use --no-trees to create one
450
in which new branches won't get a working tree.
457
A working tree is the contents of a branch placed on disk so that you can
458
see the files and edit them. The working tree is where you make changes to a
459
branch, and when you commit the current state of the working tree is the
460
snapshot that is recorded in the commit.
462
When you push a branch to a remote system, a working tree will not be
463
created. If one is already present the files will not be updated. The
464
branch information will be updated and the working tree will be marked
465
as out-of-date. Updating a working tree remotely is difficult, as there
466
may be uncommitted changes or the update may cause content conflicts that are
467
difficult to deal with remotely.
469
If you have a branch with no working tree you can use the 'checkout' command
470
to create a working tree. If you run 'bzr checkout .' from the branch it will
471
create the working tree. If the branch is updated remotely, you can update the
472
working tree by running 'bzr update' in that directory.
474
If you have a branch with a working tree that you do not want the 'remove-tree'
475
command will remove the tree if it is safe. This can be done to avoid the
476
warning about the remote working tree not being updated when pushing to the
477
branch. It can also be useful when working with a '--no-trees' repository
478
(see 'bzr help repositories').
480
If you want to have a working tree on a remote machine that you push to you
481
can either run 'bzr update' in the remote branch after each push, or use some
482
other method to update the tree during the push. There is an 'rspush' plugin
483
that will update the working tree using rsync as well as doing a push. There
484
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
489
checkout Create a working tree when a branch does not have one.
490
remove-tree Removes the working tree from a branch when it is safe to do so.
491
update When a working tree is out of sync with it's associated branch
492
this will update the tree to match the branch.
499
A branch consists of the state of a project, including all of its
500
history. All branches have a repository associated (which is where the
501
branch history is stored), but multiple branches may share the same
502
repository (a shared repository). Branches can be copied and merged.
506
init Change a directory into a versioned branch.
507
branch Create a new copy of a branch.
508
merge Perform a three-way merge.
512
_standalone_trees = \
515
A standalone tree is a working tree with an associated repository. It
516
is an independently usable branch, with no dependencies on any other.
517
Creating a standalone tree (via bzr init) is the quickest way to put
518
an existing project under version control.
522
init Make a directory into a versioned branch.
529
Status flags are used to summarise changes to the working tree in a concise
530
manner. They are in the form::
534
where the columns' meanings are as follows.
536
Column 1 - versioning/renames::
543
P Entry for a pending merge (not a file)
545
Column 2 - contents::
554
* The execute bit was changed
559
"""Environment Variables
561
================ =================================================================
562
BZRPATH Path where bzr is to look for shell plugin external commands.
563
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
564
EMAIL E-Mail address of the user.
565
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
566
EDITOR Editor for editing commit messages.
567
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
568
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
569
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
570
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
571
BZR_SSH SSH client: paramiko (default), openssh, ssh, plink.
572
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
573
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
574
================ =================================================================
581
:On Linux: ~/.bazaar/bazaar.conf
582
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
584
Contains the user's default configuration. The section ``[DEFAULT]`` is
585
used to define general configuration that will be applied everywhere.
586
The section ``[ALIASES]`` can be used to create command aliases for
587
commonly used options.
589
A typical config file might look something like::
592
email=John Doe <jdoe@isp.com>
595
commit = commit --strict
596
log10 = log --short -r -10..-1
602
A criss-cross in the branch history can cause the default merge technique
603
to emit more conflicts than would normally be expected.
605
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
606
better results. You may wish to ``bzr revert`` the working tree and merge
607
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
609
Criss-crosses occur in a branch's history if two branches merge the same thing
610
and then merge one another, or if two branches merge one another at the same
611
time. They can be avoided by having each branch only merge from or into a
612
designated central branch (a "star topology").
614
Criss-crosses cause problems because of the way merge works. Bazaar's default
615
merge is a three-way merger; in order to merge OTHER into THIS, it must
616
find a basis for comparison, BASE. Using BASE, it can determine whether
617
differences between THIS and OTHER are due to one side adding lines, or
618
from another side removing lines.
620
Criss-crosses mean there is no good choice for a base. Selecting the recent
621
merge points could cause one side's changes to be silently discarded.
622
Selecting older merge points (which Bazaar does) mean that extra conflicts
625
The ``weave`` merge type is not affected by this problem because it uses
626
line-origin detection instead of a basis revision to determine the cause of
630
_branches_out_of_sync = """Branches out of sync
632
When reconfiguring a checkout, tree or branch into a lightweight checkout,
633
a local branch must be destroyed. (For checkouts, this is the local branch
634
that serves primarily as a cache.) If the branch-to-be-destroyed does not
635
have the same last revision as the new reference branch for the lightweight
636
checkout, data could be lost, so Bazaar refuses.
638
How you deal with this depends on *why* the branches are out of sync.
640
If you have a checkout and have done local commits, you can get back in sync
641
by running "bzr update" (and possibly "bzr commit").
643
If you have a branch and the remote branch is out-of-date, you can push
644
the local changes using "bzr push". If the local branch is out of date, you
645
can do "bzr pull". If both branches have had changes, you can merge, commit
646
and then push your changes. If you decide that some of the changes aren't
647
useful, you can "push --overwrite" or "pull --overwrite" instead.
651
# Register help topics
652
topic_registry.register("revisionspec", _help_on_revisionspec,
653
"Explain how to use --revision")
654
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
655
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
656
def get_format_topic(topic):
657
from bzrlib import bzrdir
658
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
659
topic_registry.register('formats', get_format_topic, 'Directory formats')
660
topic_registry.register('standard-options', _standard_options,
661
'Options that can be used with any command')
662
topic_registry.register('global-options', _global_options,
663
'Options that control how Bazaar runs')
664
topic_registry.register('urlspec', _help_on_transport,
665
"Supported transport protocols")
666
topic_registry.register('status-flags', _status_flags,
667
"Help on status flags")
668
def get_bugs_topic(topic):
669
from bzrlib import bugtracker
670
return ("Bug Tracker Settings\n\n" +
671
bugtracker.tracker_registry.help_topic(topic))
672
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
673
topic_registry.register('env-variables', _env_variables,
674
'Environment variable names and values')
675
topic_registry.register('files', _files,
676
'Information on configuration and log files')
678
# Load some of the help topics from files
679
topic_registry.register('authentication', _load_from_file,
680
'Information on configuring authentication')
681
topic_registry.register('configuration', _load_from_file,
682
'Details on the configuration settings available')
683
topic_registry.register('conflicts', _load_from_file,
684
'Types of conflicts and what to do about them')
685
topic_registry.register('hooks', _load_from_file,
686
'Points at which custom processing can be added')
689
# Register concept topics.
690
# Note that we might choose to remove these from the online help in the
691
# future or implement them via loading content from files. In the meantime,
692
# please keep them concise.
693
topic_registry.register('branches', _branches,
694
'Information on what a branch is', SECT_CONCEPT)
695
topic_registry.register('checkouts', _checkouts,
696
'Information on what a checkout is', SECT_CONCEPT)
697
topic_registry.register('patterns', _load_from_file,
698
'Information on the pattern syntax',
700
topic_registry.register('repositories', _repositories,
701
'Basic information on shared repositories.',
703
topic_registry.register('rules', _load_from_file,
704
'Information on defining rule-based preferences',
706
topic_registry.register('standalone-trees', _standalone_trees,
707
'Information on what a standalone tree is',
709
topic_registry.register('working-trees', _working_trees,
710
'Information on working trees', SECT_CONCEPT)
711
topic_registry.register('criss-cross', _criss_cross,
712
'Information on criss-cross merging', SECT_CONCEPT)
713
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
714
'Steps to resolve "out-of-sync" when reconfiguring',
718
class HelpTopicIndex(object):
719
"""A index for bzr help that returns topics."""
724
def get_topics(self, topic):
725
"""Search for topic in the HelpTopicRegistry.
727
:param topic: A topic to search for. None is treated as 'basic'.
728
:return: A list which is either empty or contains a single
729
RegisteredTopic entry.
733
if topic in topic_registry:
734
return [RegisteredTopic(topic)]
739
class RegisteredTopic(object):
740
"""A help topic which has been registered in the HelpTopicRegistry.
742
These topics consist of nothing more than the name of the topic - all
743
data is retrieved on demand from the registry.
746
def __init__(self, topic):
749
:param topic: The name of the topic that this represents.
753
def get_help_text(self, additional_see_also=None, plain=True):
754
"""Return a string with the help for this topic.
756
:param additional_see_also: Additional help topics to be
758
:param plain: if False, raw help (reStructuredText) is
759
returned instead of plain text.
761
result = topic_registry.get_detail(self.topic)
762
# there is code duplicated here and in bzrlib/plugin.py's
763
# matching Topic code. This should probably be factored in
764
# to a helper function and a common base class.
765
if additional_see_also is not None:
766
see_also = sorted(set(additional_see_also))
770
result += '\n:See also: '
771
result += ', '.join(see_also)
774
result = help_as_plain_text(result)
777
def get_help_topic(self):
778
"""Return the help topic this can be found under."""
782
def help_as_plain_text(text):
783
"""Minimal converter of reStructuredText to plain text."""
784
lines = text.splitlines()
787
if line.startswith(':'):
789
elif line.endswith('::'):
792
return "\n".join(result) + "\n"
added
removed
bzrlib/help_topics/__init__.py
