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 in bzrlib/help_topics.
142
base = osutils.dirname(bzrlib.__file__)
143
if getattr(sys, 'frozen', None): # bzr.exe
144
base = osutils.abspath(osutils.pathjoin(base, '..', '..'))
145
filename = osutils.pathjoin(base, 'help_topics', 'en', topic_name + ".txt")
146
return open(filename, 'rU').read()
149
def _help_on_revisionspec(name):
150
"""Generate the help for revision specs."""
152
import bzrlib.revisionspec
155
out.append("Revision Identifiers\n")
156
out.append("A revision, or a range bound, can be one of the following.\n")
158
details.append("\nFurther details are given below.\n")
160
# The help text is indented 4 spaces - this re cleans that up below
161
indent_re = re.compile(r'^ ', re.MULTILINE)
162
for i in bzrlib.revisionspec.SPEC_TYPES:
164
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
168
# Extract out the top line summary from the body and
169
# clean-up the unwanted whitespace
170
summary,doc = doc.split("\n", 1)
171
#doc = indent_re.sub('', doc)
172
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
175
# Note: The leading : here are HACKs to get reStructuredText
176
# 'field' formatting - we know that the prefix ends in a ':'.
177
out.append(":%s\n\t%s" % (i.prefix, summary))
178
details.append(":%s\n%s" % (i.prefix, doc))
180
return '\n'.join(out + details)
183
def _help_on_transport(name):
184
from bzrlib.transport import (
185
transport_list_registry,
189
def add_string(proto, help, maxl, prefix_width=20):
190
help_lines = textwrap.wrap(help, maxl - prefix_width)
191
line_with_indent = '\n' + ' ' * prefix_width
192
help_text = line_with_indent.join(help_lines)
193
return "%-20s%s\n" % (proto, help_text)
196
a1 = a[:a.rfind("://")]
197
b1 = b[:b.rfind("://")]
207
protos = transport_list_registry.keys( )
208
protos.sort(sort_func)
210
shorthelp = transport_list_registry.get_help(proto)
213
if proto.endswith("://"):
214
protl.append(add_string(proto, shorthelp, 79))
216
decl.append(add_string(proto, shorthelp, 79))
219
out = "URL Identifiers\n\n" + \
220
"Supported URL prefixes::\n\n " + \
224
out += "\nSupported modifiers::\n\n " + \
231
"""Bazaar -- a free distributed version-control tool
232
http://bazaar-vcs.org/
235
bzr init makes this directory a versioned branch
236
bzr branch make a copy of another branch
238
bzr add make files or directories versioned
239
bzr ignore ignore a file or pattern
240
bzr mv move or rename a versioned file
242
bzr status summarize changes in working copy
243
bzr diff show detailed diffs
245
bzr merge pull in changes from another branch
246
bzr commit save some or all changes
248
bzr log show history of changes
249
bzr check validate storage
251
bzr help init more help on e.g. init command
252
bzr help commands list all commands
253
bzr help topics list all help topics
260
These options may be used with any command, and may appear in front of any
261
command. (e.g. "bzr --profile help").
263
--version Print the version number. Must be supplied before the command.
264
--no-aliases Do not process command aliases when running this command.
265
--builtin Use the built-in version of a command, not the plugin version.
266
This does not suppress other plugin effects.
267
--no-plugins Do not process any plugins.
269
--profile Profile execution using the hotshot profiler.
270
--lsprof Profile execution using the lsprof profiler.
271
--lsprof-file Profile execution using the lsprof profiler, and write the
272
results to a specified file. If the filename ends with ".txt",
273
text format will be used. If the filename either starts with
274
"callgrind.out" or end with ".callgrind", the output will be
275
formatted for use with KCacheGrind. Otherwise, the output
278
See doc/developers/profiling.txt for more information on profiling.
279
A number of debug flags are also available to assist troubleshooting and
282
-Dauth Trace authentication sections used.
283
-Derror Instead of normal error handling, always print a traceback on
285
-Devil Capture call sites that do expensive or badly-scaling
287
-Dhashcache Log every time a working file is read to determine its hash.
288
-Dhooks Trace hook execution.
289
-Dhttp Trace http connections, requests and responses
290
-Dhpss Trace smart protocol requests and responses.
291
-Dindex Trace major index operations.
292
-Dlock Trace when lockdir locks are taken or released.
293
-Dmerge Emit information for debugging merges.
296
_standard_options = \
299
Standard options are legal for all commands.
301
--help, -h Show help message.
302
--verbose, -v Display more information.
303
--quiet, -q Only display errors and warnings.
305
Unlike global options, standard options can be used in aliases.
312
Checkouts are source trees that are connected to a branch, so that when
313
you commit in the source tree, the commit goes into that branch. They
314
allow you to use a simpler, more centralized workflow, ignoring some of
315
Bazaar's decentralized features until you want them. Using checkouts
316
with shared repositories is very similar to working with SVN or CVS, but
317
doesn't have the same restrictions. And using checkouts still allows
318
others working on the project to use whatever workflow they like.
320
A checkout is created with the bzr checkout command (see "help checkout").
321
You pass it a reference to another branch, and it will create a local copy
322
for you that still contains a reference to the branch you created the
323
checkout from (the master branch). Then if you make any commits they will be
324
made on the other branch first. This creates an instant mirror of your work, or
325
facilitates lockstep development, where each developer is working together,
326
continuously integrating the changes of others.
328
However the checkout is still a first class branch in Bazaar terms, so that
329
you have the full history locally. As you have a first class branch you can
330
also commit locally if you want, for instance due to the temporary loss af a
331
network connection. Use the --local option to commit to do this. All the local
332
commits will then be made on the master branch the next time you do a non-local
335
If you are using a checkout from a shared branch you will periodically want to
336
pull in all the changes made by others. This is done using the "update"
337
command. The changes need to be applied before any non-local commit, but
338
Bazaar will tell you if there are any changes and suggest that you use this
341
It is also possible to create a "lightweight" checkout by passing the
342
--lightweight flag to checkout. A lightweight checkout is even closer to an
343
SVN checkout in that it is not a first class branch, it mainly consists of the
344
working tree. This means that any history operations must query the master
345
branch, which could be slow if a network connection is involved. Also, as you
346
don't have a local branch, then you cannot commit locally.
348
Lightweight checkouts work best when you have fast reliable access to the
349
master branch. This means that if the master branch is on the same disk or LAN
350
a lightweight checkout will be faster than a heavyweight one for any commands
351
that modify the revision history (as only one copy branch needs to be updated).
352
Heavyweight checkouts will generally be faster for any command that uses the
353
history but does not change it, but if the master branch is on the same disk
354
then there wont be a noticeable difference.
356
Another possible use for a checkout is to use it with a treeless repository
357
containing your branches, where you maintain only one working tree by
358
switching the master branch that the checkout points to when you want to
359
work on a different branch.
361
Obviously to commit on a checkout you need to be able to write to the master
362
branch. This means that the master branch must be accessible over a writeable
363
protocol , such as sftp://, and that you have write permissions at the other
364
end. Checkouts also work on the local file system, so that all that matters is
367
You can change the master of a checkout by using the "bind" command (see "help
368
bind"). This will change the location that the commits are sent to. The bind
369
command can also be used to turn a branch into a heavy checkout. If you
370
would like to convert your heavy checkout into a normal branch so that every
371
commit is local, you can use the "unbind" command.
375
checkout Create a checkout. Pass --lightweight to get a lightweight
377
update Pull any changes in the master branch in to your checkout
378
commit Make a commit that is sent to the master branch. If you have
379
a heavy checkout then the --local option will commit to the
380
checkout without sending the commit to the master
381
bind Change the master branch that the commits in the checkout will
383
unbind Turn a heavy checkout into a standalone branch so that any
384
commits are only made locally
390
Repositories in Bazaar are where committed information is stored. There is
391
a repository associated with every branch.
393
Repositories are a form of database. Bzr will usually maintain this for
394
good performance automatically, but in some situations (e.g. when doing
395
very many commits in a short time period) you may want to ask bzr to
396
optimise the database indices. This can be done by the 'bzr pack' command.
398
By default just running 'bzr init' will create a repository within the new
399
branch but it is possible to create a shared repository which allows multiple
400
branches to share their information in the same location. When a new branch is
401
created it will first look to see if there is a containing shared repository it
404
When two branches of the same project share a repository, there is
405
generally a large space saving. For some operations (e.g. branching
406
within the repository) this translates in to a large time saving.
408
To create a shared repository use the init-repository command (or the alias
409
init-repo). This command takes the location of the repository to create. This
410
means that 'bzr init-repository repo' will create a directory named 'repo',
411
which contains a shared repository. Any new branches that are created in this
412
directory will then use it for storage.
414
It is a good idea to create a repository whenever you might create more
415
than one branch of a project. This is true for both working areas where you
416
are doing the development, and any server areas that you use for hosting
417
projects. In the latter case, it is common to want branches without working
418
trees. Since the files in the branch will not be edited directly there is no
419
need to use up disk space for a working tree. To create a repository in which
420
the branches will not have working trees pass the '--no-trees' option to
425
init-repository Create a shared repository. Use --no-trees to create one
426
in which new branches won't get a working tree.
433
A working tree is the contents of a branch placed on disk so that you can
434
see the files and edit them. The working tree is where you make changes to a
435
branch, and when you commit the current state of the working tree is the
436
snapshot that is recorded in the commit.
438
When you push a branch to a remote system, a working tree will not be
439
created. If one is already present the files will not be updated. The
440
branch information will be updated and the working tree will be marked
441
as out-of-date. Updating a working tree remotely is difficult, as there
442
may be uncommitted changes or the update may cause content conflicts that are
443
difficult to deal with remotely.
445
If you have a branch with no working tree you can use the 'checkout' command
446
to create a working tree. If you run 'bzr checkout .' from the branch it will
447
create the working tree. If the branch is updated remotely, you can update the
448
working tree by running 'bzr update' in that directory.
450
If you have a branch with a working tree that you do not want the 'remove-tree'
451
command will remove the tree if it is safe. This can be done to avoid the
452
warning about the remote working tree not being updated when pushing to the
453
branch. It can also be useful when working with a '--no-trees' repository
454
(see 'bzr help repositories').
456
If you want to have a working tree on a remote machine that you push to you
457
can either run 'bzr update' in the remote branch after each push, or use some
458
other method to update the tree during the push. There is an 'rspush' plugin
459
that will update the working tree using rsync as well as doing a push. There
460
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
465
checkout Create a working tree when a branch does not have one.
466
remove-tree Removes the working tree from a branch when it is safe to do so.
467
update When a working tree is out of sync with it's associated branch
468
this will update the tree to match the branch.
475
A branch consists of the state of a project, including all of its
476
history. All branches have a repository associated (which is where the
477
branch history is stored), but multiple branches may share the same
478
repository (a shared repository). Branches can be copied and merged.
482
init Make a directory into a versioned branch.
483
branch Create a new copy of a branch.
484
merge Perform a three-way merge.
488
_standalone_trees = \
491
A standalone tree is a working tree with an associated repository. It
492
is an independently usable branch, with no dependencies on any other.
493
Creating a standalone tree (via bzr init) is the quickest way to put
494
an existing project under version control.
498
init Make a directory into a versioned branch.
505
Status flags are used to summarise changes to the working tree in a concise
506
manner. They are in the form::
510
where the columns' meanings are as follows.
512
Column 1 - versioning/renames::
519
P Entry for a pending merge (not a file)
521
Column 2 - contents::
530
* The execute bit was changed
535
"""Environment Variables
537
================ =================================================================
538
BZRPATH Path where bzr is to look for shell plugin external commands.
539
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
540
EMAIL E-Mail address of the user.
541
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
542
EDITOR Editor for editing commit messages.
543
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
544
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
545
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
546
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
547
================ =================================================================
554
:On Linux: ~/.bazaar/bazaar.conf
555
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
557
Contains the user's default configuration. The section ``[DEFAULT]`` is
558
used to define general configuration that will be applied everywhere.
559
The section ``[ALIASES]`` can be used to create command aliases for
560
commonly used options.
562
A typical config file might look something like::
565
email=John Doe <jdoe@isp.com>
568
commit = commit --strict
569
log10 = log --short -r -10..-1
575
A criss-cross in the branch history can cause the default merge technique
576
to emit more conflicts than would normally be expected.
578
If you encounter criss-crosses, you can use merge --weave instead, which
579
should provide a much better result.
581
Criss-crosses occur in a branch's history if two branches merge the same thing
582
and then merge one another, or if two branches merge one another at the same
583
time. They can be avoided by having each branch only merge from or into a
584
designated central branch (a "star topology").
586
Criss-crosses cause problems because of the way merge works. Bazaar's default
587
merge is a three-way merger; in order to merge OTHER into THIS, it must
588
find a basis for comparison, BASE. Using BASE, it can determine whether
589
differences between THIS and OTHER are due to one side adding lines, or
590
from another side removing lines.
592
Criss-crosses mean there is no good choice for a base. Selecting the recent
593
merge points could cause one side's changes to be silently discarded.
594
Selecting older merge points (which Bazaar does) mean that extra conflicts
597
The ``weave`` merge type is not affected by this problem because it uses
598
line-origin detection instead of a basis revision to determine the cause of
602
# Register help topics
603
topic_registry.register("revisionspec", _help_on_revisionspec,
604
"Explain how to use --revision")
605
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
606
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
607
def get_format_topic(topic):
608
from bzrlib import bzrdir
609
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
610
topic_registry.register('formats', get_format_topic, 'Directory formats')
611
topic_registry.register('standard-options', _standard_options,
612
'Options that can be used with any command')
613
topic_registry.register('global-options', _global_options,
614
'Options that control how Bazaar runs')
615
topic_registry.register('urlspec', _help_on_transport,
616
"Supported transport protocols")
617
topic_registry.register('status-flags', _status_flags,
618
"Help on status flags")
619
def get_bugs_topic(topic):
620
from bzrlib import bugtracker
621
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
622
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
623
topic_registry.register('env-variables', _env_variables,
624
'Environment variable names and values')
625
topic_registry.register('files', _files,
626
'Information on configuration and log files')
628
# Load some of the help topics from files
629
topic_registry.register('authentication', _load_from_file,
630
'Information on configuring authentication')
631
topic_registry.register('configuration', _load_from_file,
632
'Details on the configuration settings available')
633
topic_registry.register('conflicts', _load_from_file,
634
'Types of conflicts and what to do about them')
635
topic_registry.register('hooks', _load_from_file,
636
'Points at which custom processing can be added')
639
# Register concept topics.
640
# Note that we might choose to remove these from the online help in the
641
# future or implement them via loading content from files. In the meantime,
642
# please keep them concise.
643
topic_registry.register('branches', _branches,
644
'Information on what a branch is', SECT_CONCEPT)
645
topic_registry.register('checkouts', _checkouts,
646
'Information on what a checkout is', SECT_CONCEPT)
647
topic_registry.register('repositories', _repositories,
648
'Basic information on shared repositories.',
650
topic_registry.register('standalone-trees', _standalone_trees,
651
'Information on what a standalone tree is',
653
topic_registry.register('working-trees', _working_trees,
654
'Information on working trees', SECT_CONCEPT)
655
topic_registry.register('criss-cross', _criss_cross,
656
'Information on criss-cross merging', SECT_CONCEPT)
659
class HelpTopicIndex(object):
660
"""A index for bzr help that returns topics."""
665
def get_topics(self, topic):
666
"""Search for topic in the HelpTopicRegistry.
668
:param topic: A topic to search for. None is treated as 'basic'.
669
:return: A list which is either empty or contains a single
670
RegisteredTopic entry.
674
if topic in topic_registry:
675
return [RegisteredTopic(topic)]
680
class RegisteredTopic(object):
681
"""A help topic which has been registered in the HelpTopicRegistry.
683
These topics consist of nothing more than the name of the topic - all
684
data is retrieved on demand from the registry.
687
def __init__(self, topic):
690
:param topic: The name of the topic that this represents.
694
def get_help_text(self, additional_see_also=None, plain=True):
695
"""Return a string with the help for this topic.
697
:param additional_see_also: Additional help topics to be
699
:param plain: if False, raw help (reStructuredText) is
700
returned instead of plain text.
702
result = topic_registry.get_detail(self.topic)
703
# there is code duplicated here and in bzrlib/plugin.py's
704
# matching Topic code. This should probably be factored in
705
# to a helper function and a common base class.
706
if additional_see_also is not None:
707
see_also = sorted(set(additional_see_also))
711
result += '\n:See also: '
712
result += ', '.join(see_also)
715
result = help_as_plain_text(result)
718
def get_help_topic(self):
719
"""Return the help topic this can be found under."""
723
def help_as_plain_text(text):
724
"""Minimal converter of reStructuredText to plain text."""
725
lines = text.splitlines()
728
if line.startswith(':'):
730
elif line.endswith('::'):
733
return "\n".join(result) + "\n"
added
removed
bzrlib/help_topics.py
