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.
36
from bzrlib import registry
39
# Section identifiers (map topics to the right place in the manual)
40
SECT_COMMAND = "command"
41
SECT_CONCEPT = "concept"
42
SECT_HIDDEN = "hidden"
44
SECT_PLUGIN = "plugin"
47
class HelpTopicRegistry(registry.Registry):
48
"""A Registry customized for handling help topics."""
50
def register(self, topic, detail, summary, section=SECT_LIST):
51
"""Register a new help topic.
53
:param topic: Name of documentation entry
54
:param detail: Function or string object providing detailed
55
documentation for topic. Function interface is detail(topic).
56
This should return a text string of the detailed information.
57
See the module documentation for details on help text formatting.
58
:param summary: String providing single-line documentation for topic.
59
:param section: Section in reference manual - see SECT_* identifiers.
61
# The detail is stored as the 'object' and the metadata as the info
62
info=(summary,section)
63
super(HelpTopicRegistry, self).register(topic, detail, info=info)
65
def register_lazy(self, topic, module_name, member_name, summary,
67
"""Register a new help topic, and import the details on demand.
69
:param topic: Name of documentation entry
70
:param module_name: The module to find the detailed help.
71
:param member_name: The member of the module to use for detailed help.
72
:param summary: String providing single-line documentation for topic.
73
:param section: Section in reference manual - see SECT_* identifiers.
75
# The detail is stored as the 'object' and the metadata as the info
76
info=(summary,section)
77
super(HelpTopicRegistry, self).register_lazy(topic, module_name,
78
member_name, info=info)
80
def get_detail(self, topic):
81
"""Get the detailed help on a given topic."""
88
def get_summary(self, topic):
89
"""Get the single line summary for the topic."""
90
info = self.get_info(topic)
96
def get_section(self, topic):
97
"""Get the section for the topic."""
98
info = self.get_info(topic)
104
def get_topics_for_section(self, section):
105
"""Get the set of topics in a section."""
107
for topic in self.keys():
108
if section == self.get_section(topic):
113
topic_registry = HelpTopicRegistry()
116
#----------------------------------------------------
118
def _help_on_topics(dummy):
119
"""Write out the help for topics to outfile"""
121
topics = topic_registry.keys()
122
lmax = max(len(topic) for topic in topics)
126
summary = topic_registry.get_summary(topic)
127
out.append("%-*s %s\n" % (lmax, topic, summary))
131
def _load_from_file(topic_name):
132
"""Load help from a file.
134
The help is already expected to be in ReStructuredText format.
138
filename = "%s/doc/en/user-reference/%s.txt" % (bzr_dir,topic_name)
139
lines = open(filename).readlines()
140
return ''.join(lines)
143
def _help_on_revisionspec(name):
144
"""Generate the help for revision specs."""
146
import bzrlib.revisionspec
149
out.append("Revision Identifiers\n")
150
out.append("A revision, or a range bound, can be one of the following.\n")
152
details.append("\nFurther details are given below.\n")
154
# The help text is indented 4 spaces - this re cleans that up below
155
indent_re = re.compile(r'^ ', re.MULTILINE)
156
for i in bzrlib.revisionspec.SPEC_TYPES:
158
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
162
# Extract out the top line summary from the body and
163
# clean-up the unwanted whitespace
164
summary,doc = doc.split("\n", 1)
165
#doc = indent_re.sub('', doc)
166
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
169
# Note: The leading : here are HACKs to get reStructuredText
170
# 'field' formatting - we know that the prefix ends in a ':'.
171
out.append(":%s\n\t%s" % (i.prefix, summary))
172
details.append(":%s\n%s" % (i.prefix, doc))
174
return '\n'.join(out + details)
177
def _help_on_transport(name):
178
from bzrlib.transport import (
179
transport_list_registry,
183
def add_string(proto, help, maxl, prefix_width=20):
184
help_lines = textwrap.wrap(help, maxl - prefix_width)
185
line_with_indent = '\n' + ' ' * prefix_width
186
help_text = line_with_indent.join(help_lines)
187
return "%-20s%s\n" % (proto, help_text)
190
a1 = a[:a.rfind("://")]
191
b1 = b[:b.rfind("://")]
201
protos = transport_list_registry.keys( )
202
protos.sort(sort_func)
204
shorthelp = transport_list_registry.get_help(proto)
207
if proto.endswith("://"):
208
protl.append(add_string(proto, shorthelp, 79))
210
decl.append(add_string(proto, shorthelp, 79))
213
out = "URL Identifiers\n\n" + \
214
"Supported URL prefixes::\n\n " + \
218
out += "\nSupported modifiers::\n\n " + \
225
"""Bazaar -- a free distributed version-control tool
226
http://bazaar-vcs.org/
229
bzr init makes this directory a versioned branch
230
bzr branch make a copy of another branch
232
bzr add make files or directories versioned
233
bzr ignore ignore a file or pattern
234
bzr mv move or rename a versioned file
236
bzr status summarize changes in working copy
237
bzr diff show detailed diffs
239
bzr merge pull in changes from another branch
240
bzr commit save some or all changes
242
bzr log show history of changes
243
bzr check validate storage
245
bzr help init more help on e.g. init command
246
bzr help commands list all commands
247
bzr help topics list all help topics
254
These options may be used with any command, and may appear in front of any
255
command. (e.g. "bzr --profile help").
257
--version Print the version number. Must be supplied before the command.
258
--no-aliases Do not process command aliases when running this command.
259
--builtin Use the built-in version of a command, not the plugin version.
260
This does not suppress other plugin effects.
261
--no-plugins Do not process any plugins.
263
--profile Profile execution using the hotshot profiler.
264
--lsprof Profile execution using the lsprof profiler.
265
--lsprof-file Profile execution using the lsprof profiler, and write the
266
results to a specified file. If the filename ends with ".txt",
267
text format will be used. If the filename either starts with
268
"callgrind.out" or end with ".callgrind", the output will be
269
formatted for use with KCacheGrind. Otherwise, the output
272
See doc/developers/profiling.txt for more information on profiling.
273
A number of debug flags are also available to assist troubleshooting and
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.
290
_standard_options = \
293
Standard options are legal for all commands.
295
--help, -h Show help message.
296
--verbose, -v Display more information.
297
--quiet, -q Only display errors and warnings.
299
Unlike global options, standard options can be used in aliases.
306
Checkouts are source trees that are connected to a branch, so that when
307
you commit in the source tree, the commit goes into that branch. They
308
allow you to use a simpler, more centralized workflow, ignoring some of
309
Bazaar's decentralized features until you want them. Using checkouts
310
with shared repositories is very similar to working with SVN or CVS, but
311
doesn't have the same restrictions. And using checkouts still allows
312
others working on the project to use whatever workflow they like.
314
A checkout is created with the bzr checkout command (see "help checkout").
315
You pass it a reference to another branch, and it will create a local copy
316
for you that still contains a reference to the branch you created the
317
checkout from (the master branch). Then if you make any commits they will be
318
made on the other branch first. This creates an instant mirror of your work, or
319
facilitates lockstep development, where each developer is working together,
320
continuously integrating the changes of others.
322
However the checkout is still a first class branch in Bazaar terms, so that
323
you have the full history locally. As you have a first class branch you can
324
also commit locally if you want, for instance due to the temporary loss af a
325
network connection. Use the --local option to commit to do this. All the local
326
commits will then be made on the master branch the next time you do a non-local
329
If you are using a checkout from a shared branch you will periodically want to
330
pull in all the changes made by others. This is done using the "update"
331
command. The changes need to be applied before any non-local commit, but
332
Bazaar will tell you if there are any changes and suggest that you use this
335
It is also possible to create a "lightweight" checkout by passing the
336
--lightweight flag to checkout. A lightweight checkout is even closer to an
337
SVN checkout in that it is not a first class branch, it mainly consists of the
338
working tree. This means that any history operations must query the master
339
branch, which could be slow if a network connection is involved. Also, as you
340
don't have a local branch, then you cannot commit locally.
342
Lightweight checkouts work best when you have fast reliable access to the
343
master branch. This means that if the master branch is on the same disk or LAN
344
a lightweight checkout will be faster than a heavyweight one for any commands
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.
350
Another possible use for a checkout is to use it with a treeless repository
351
containing your branches, where you maintain only one working tree by
352
switching the master branch that the checkout points to when you want to
353
work on a different branch.
355
Obviously to commit on a checkout you need to be able to write to the master
356
branch. This means that the master branch must be accessible over a writeable
357
protocol , such as sftp://, and that you have write permissions at the other
358
end. Checkouts also work on the local file system, so that all that matters is
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.
369
checkout Create a checkout. Pass --lightweight to get a lightweight
371
update Pull any changes in the master branch in to your checkout
372
commit Make a commit that is sent to the master branch. If you have
373
a heavy checkout then the --local option will commit to the
374
checkout without sending the commit to the master
375
bind Change the master branch that the commits in the checkout will
377
unbind Turn a heavy checkout into a standalone branch so that any
378
commits are only made locally
384
Repositories in Bazaar are where committed information is stored. There is
385
a repository associated with every branch.
387
Repositories are a form of database. Bzr will usually maintain this for
388
good performance automatically, but in some situations (e.g. when doing
389
very many commits in a short time period) you may want to ask bzr to
390
optimise the database indices. This can be done by the 'bzr pack' command.
392
By default just running 'bzr init' will create a repository within the new
393
branch but it is possible to create a shared repository which allows multiple
394
branches to share their information in the same location. When a new branch is
395
created it will first look to see if there is a containing shared repository it
398
When two branches of the same project share a repository, there is
399
generally a large space saving. For some operations (e.g. branching
400
within the repository) this translates in to a large time saving.
402
To create a shared repository use the init-repository command (or the alias
403
init-repo). This command takes the location of the repository to create. This
404
means that 'bzr init-repository repo' will create a directory named 'repo',
405
which contains a shared repository. Any new branches that are created in this
406
directory will then use it for storage.
408
It is a good idea to create a repository whenever you might create more
409
than one branch of a project. This is true for both working areas where you
410
are doing the development, and any server areas that you use for hosting
411
projects. In the latter case, it is common to want branches without working
412
trees. Since the files in the branch will not be edited directly there is no
413
need to use up disk space for a working tree. To create a repository in which
414
the branches will not have working trees pass the '--no-trees' option to
419
init-repository Create a shared repository. Use --no-trees to create one
420
in which new branches won't get a working tree.
427
A working tree is the contents of a branch placed on disk so that you can
428
see the files and edit them. The working tree is where you make changes to a
429
branch, and when you commit the current state of the working tree is the
430
snapshot that is recorded in the commit.
432
When you push a branch to a remote system, a working tree will not be
433
created. If one is already present the files will not be updated. The
434
branch information will be updated and the working tree will be marked
435
as out-of-date. Updating a working tree remotely is difficult, as there
436
may be uncommitted changes or the update may cause content conflicts that are
437
difficult to deal with remotely.
439
If you have a branch with no working tree you can use the 'checkout' command
440
to create a working tree. If you run 'bzr checkout .' from the branch it will
441
create the working tree. If the branch is updated remotely, you can update the
442
working tree by running 'bzr update' in that directory.
444
If you have a branch with a working tree that you do not want the 'remove-tree'
445
command will remove the tree if it is safe. This can be done to avoid the
446
warning about the remote working tree not being updated when pushing to the
447
branch. It can also be useful when working with a '--no-trees' repository
448
(see 'bzr help repositories').
450
If you want to have a working tree on a remote machine that you push to you
451
can either run 'bzr update' in the remote branch after each push, or use some
452
other method to update the tree during the push. There is an 'rspush' plugin
453
that will update the working tree using rsync as well as doing a push. There
454
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
459
checkout Create a working tree when a branch does not have one.
460
remove-tree Removes the working tree from a branch when it is safe to do so.
461
update When a working tree is out of sync with it's associated branch
462
this will update the tree to match the branch.
469
A branch consists of the state of a project, including all of its
470
history. All branches have a repository associated (which is where the
471
branch history is stored), but multiple branches may share the same
472
repository (a shared repository). Branches can be copied and merged.
476
init Make a directory into a versioned branch.
477
branch Create a new copy of a branch.
478
merge Perform a three-way merge.
482
_standalone_trees = \
485
A standalone tree is a working tree with an associated repository. It
486
is an independently usable branch, with no dependencies on any other.
487
Creating a standalone tree (via bzr init) is the quickest way to put
488
an existing project under version control.
492
init Make a directory into a versioned branch.
499
Status flags are used to summarise changes to the working tree in a concise
500
manner. They are in the form::
504
where the columns' meanings are as follows.
506
Column 1 - versioning/renames::
513
P Entry for a pending merge (not a file)
515
Column 2 - contents::
524
* The execute bit was changed
529
"""Environment Variables
531
================ =================================================================
532
BZRPATH Path where bzr is to look for shell plugin external commands.
533
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
534
EMAIL E-Mail address of the user.
535
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
536
EDITOR Editor for editing commit messages.
537
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
538
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
539
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
540
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
541
================ =================================================================
548
:On Linux: ~/.bazaar/bazaar.conf
549
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
551
Contains the user's default configuration. The section ``[DEFAULT]`` is
552
used to define general configuration that will be applied everywhere.
553
The section ``[ALIASES]`` can be used to create command aliases for
554
commonly used options.
556
A typical config file might look something like::
559
email=John Doe <jdoe@isp.com>
562
commit = commit --strict
563
log10 = log --short -r -10..-1
568
A criss-cross in the branch history can cause the default merge technique
569
to emit more conflicts than would normally be expected.
571
If you encounter criss-crosses, you can use merge --weave instead, which
572
should provide a much better result.
574
Criss-crosses occur in a branch's history if two branches merge the same thing
575
and then merge one another, or if two branches merge one another at the same
576
time. They can be avoided by having each branch only merge from or into a
577
designated central branch (a "star topology").
579
Criss-crosses cause problems because of the way merge works. Bazaar's default
580
merge is a three-way merger; in order to merge OTHER into THIS, it must
581
find a basis for comparison, BASE. Using BASE, it can determine whether
582
differences between THIS and OTHER are due to one side adding lines, or
583
from another side removing lines.
585
Criss-crosses mean there is no good choice for a base. Selecting the recent
586
merge points could cause one side's changes to be silently discarded.
587
Selecting older merge points (which Bazaar does) mean that extra conflicts
590
The ``weave`` merge type is not affected by this problem because it uses
591
line-origin detection instead of a basis revision to determine the cause of
595
# Register help topics
596
topic_registry.register("revisionspec", _help_on_revisionspec,
597
"Explain how to use --revision")
598
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
599
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
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')
604
topic_registry.register('standard-options', _standard_options,
605
'Options that can be used with any command')
606
topic_registry.register('global-options', _global_options,
607
'Options that control how Bazaar runs')
608
topic_registry.register('urlspec', _help_on_transport,
609
"Supported transport protocols")
610
topic_registry.register('status-flags', _status_flags,
611
"Help on status flags")
612
def get_bugs_topic(topic):
613
from bzrlib import bugtracker
614
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
615
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
616
topic_registry.register('env-variables', _env_variables,
617
'Environment variable names and values')
618
topic_registry.register('files', _files,
619
'Information on configuration and log files')
621
# Load some of the help topics from files
622
topic_registry.register('authentication', _load_from_file,
623
'Information on configuring authentication')
624
topic_registry.register('configuration', _load_from_file,
625
'Details on the configuration settings available')
626
topic_registry.register('conflicts', _load_from_file,
627
'Types of conflicts and what to do about them')
628
topic_registry.register('hooks', _load_from_file,
629
'Points at which custom processing can be added')
632
# Register concept topics.
633
# Note that we might choose to remove these from the online help in the
634
# future or implement them via loading content from files. In the meantime,
635
# please keep them concise.
636
topic_registry.register('branches', _branches,
637
'Information on what a branch is', SECT_CONCEPT)
638
topic_registry.register('checkouts', _checkouts,
639
'Information on what a checkout is', SECT_CONCEPT)
640
topic_registry.register('repositories', _repositories,
641
'Basic information on shared repositories.',
643
topic_registry.register('standalone-trees', _standalone_trees,
644
'Information on what a standalone tree is',
646
topic_registry.register('working-trees', _working_trees,
647
'Information on working trees', SECT_CONCEPT)
648
topic_registry.register('criss-cross', _criss_cross,
649
'Information on criss-cross merging', SECT_CONCEPT)
652
class HelpTopicIndex(object):
653
"""A index for bzr help that returns topics."""
658
def get_topics(self, topic):
659
"""Search for topic in the HelpTopicRegistry.
661
:param topic: A topic to search for. None is treated as 'basic'.
662
:return: A list which is either empty or contains a single
663
RegisteredTopic entry.
667
if topic in topic_registry:
668
return [RegisteredTopic(topic)]
673
class RegisteredTopic(object):
674
"""A help topic which has been registered in the HelpTopicRegistry.
676
These topics consist of nothing more than the name of the topic - all
677
data is retrieved on demand from the registry.
680
def __init__(self, topic):
683
:param topic: The name of the topic that this represents.
687
def get_help_text(self, additional_see_also=None, plain=True):
688
"""Return a string with the help for this topic.
690
:param additional_see_also: Additional help topics to be
692
:param plain: if False, raw help (reStructuredText) is
693
returned instead of plain text.
695
result = topic_registry.get_detail(self.topic)
696
# there is code duplicated here and in bzrlib/plugin.py's
697
# matching Topic code. This should probably be factored in
698
# to a helper function and a common base class.
699
if additional_see_also is not None:
700
see_also = sorted(set(additional_see_also))
704
result += '\n:See also: '
705
result += ', '.join(see_also)
708
result = help_as_plain_text(result)
711
def get_help_topic(self):
712
"""Return the help topic this can be found under."""
716
def help_as_plain_text(text):
717
"""Minimal converter of reStructuredText to plain text."""
718
lines = text.splitlines()
721
if line.startswith(':'):
723
elif line.endswith('::'):
726
return "\n".join(result) + "\n"
added
removed
bzrlib/help_topics.py
