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
152
out.append("Revision Identifiers\n")
153
out.append("A revision, or a range bound, can be one of the following.\n")
155
details.append("\nFurther details are given below.\n")
157
# The help text is indented 4 spaces - this re cleans that up below
158
indent_re = re.compile(r'^ ', re.MULTILINE)
159
for i in bzrlib.revisionspec.SPEC_TYPES:
161
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
165
# Extract out the top line summary from the body and
166
# clean-up the unwanted whitespace
167
summary,doc = doc.split("\n", 1)
168
#doc = indent_re.sub('', doc)
169
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
172
# Note: The leading : here are HACKs to get reStructuredText
173
# 'field' formatting - we know that the prefix ends in a ':'.
174
out.append(":%s\n\t%s" % (i.prefix, summary))
175
details.append(":%s\n%s" % (i.prefix, doc))
177
return '\n'.join(out + details)
180
def _help_on_transport(name):
181
from bzrlib.transport import (
182
transport_list_registry,
186
def add_string(proto, help, maxl, prefix_width=20):
187
help_lines = textwrap.wrap(help, maxl - prefix_width)
188
line_with_indent = '\n' + ' ' * prefix_width
189
help_text = line_with_indent.join(help_lines)
190
return "%-20s%s\n" % (proto, help_text)
193
a1 = a[:a.rfind("://")]
194
b1 = b[:b.rfind("://")]
204
protos = transport_list_registry.keys( )
205
protos.sort(sort_func)
207
shorthelp = transport_list_registry.get_help(proto)
210
if proto.endswith("://"):
211
protl.append(add_string(proto, shorthelp, 79))
213
decl.append(add_string(proto, shorthelp, 79))
216
out = "URL Identifiers\n\n" + \
217
"Supported URL prefixes::\n\n " + \
221
out += "\nSupported modifiers::\n\n " + \
228
"""Bazaar -- a free distributed version-control tool
229
http://bazaar-vcs.org/
232
bzr init makes this directory a versioned branch
233
bzr branch make a copy of another branch
235
bzr add make files or directories versioned
236
bzr ignore ignore a file or pattern
237
bzr mv move or rename a versioned file
239
bzr status summarize changes in working copy
240
bzr diff show detailed diffs
242
bzr merge pull in changes from another branch
243
bzr commit save some or all changes
245
bzr log show history of changes
246
bzr check validate storage
248
bzr help init more help on e.g. init command
249
bzr help commands list all commands
250
bzr help topics list all help topics
257
These options may be used with any command, and may appear in front of any
258
command. (e.g. "bzr --profile help").
260
--version Print the version number. Must be supplied before the command.
261
--no-aliases Do not process command aliases when running this command.
262
--builtin Use the built-in version of a command, not the plugin version.
263
This does not suppress other plugin effects.
264
--no-plugins Do not process any plugins.
266
--profile Profile execution using the hotshot profiler.
267
--lsprof Profile execution using the lsprof profiler.
268
--lsprof-file Profile execution using the lsprof profiler, and write the
269
results to a specified file. If the filename ends with ".txt",
270
text format will be used. If the filename either starts with
271
"callgrind.out" or end with ".callgrind", the output will be
272
formatted for use with KCacheGrind. Otherwise, the output
274
--coverage Generate line coverage report in the specified directory.
276
See doc/developers/profiling.txt for more information on profiling.
277
A number of debug flags are also available to assist troubleshooting and
280
-Dauth Trace authentication sections used.
281
-Derror Instead of normal error handling, always print a traceback
283
-Devil Capture call sites that do expensive or badly-scaling
285
-Dfetch Trace history copying between repositories.
286
-Dhashcache Log every time a working file is read to determine its hash.
287
-Dhooks Trace hook execution.
288
-Dhpss Trace smart protocol requests and responses.
289
-Dhttp Trace http connections, requests and responses
290
-Dindex Trace major index operations.
291
-Dknit Trace knit operations.
292
-Dlock Trace when lockdir locks are taken or released.
293
-Dmerge Emit information for debugging merges.
294
-Dpack Emit information about pack operations.
297
_standard_options = \
300
Standard options are legal for all commands.
302
--help, -h Show help message.
303
--verbose, -v Display more information.
304
--quiet, -q Only display errors and warnings.
306
Unlike global options, standard options can be used in aliases.
313
Checkouts are source trees that are connected to a branch, so that when
314
you commit in the source tree, the commit goes into that branch. They
315
allow you to use a simpler, more centralized workflow, ignoring some of
316
Bazaar's decentralized features until you want them. Using checkouts
317
with shared repositories is very similar to working with SVN or CVS, but
318
doesn't have the same restrictions. And using checkouts still allows
319
others working on the project to use whatever workflow they like.
321
A checkout is created with the bzr checkout command (see "help checkout").
322
You pass it a reference to another branch, and it will create a local copy
323
for you that still contains a reference to the branch you created the
324
checkout from (the master branch). Then if you make any commits they will be
325
made on the other branch first. This creates an instant mirror of your work, or
326
facilitates lockstep development, where each developer is working together,
327
continuously integrating the changes of others.
329
However the checkout is still a first class branch in Bazaar terms, so that
330
you have the full history locally. As you have a first class branch you can
331
also commit locally if you want, for instance due to the temporary loss af a
332
network connection. Use the --local option to commit to do this. All the local
333
commits will then be made on the master branch the next time you do a non-local
336
If you are using a checkout from a shared branch you will periodically want to
337
pull in all the changes made by others. This is done using the "update"
338
command. The changes need to be applied before any non-local commit, but
339
Bazaar will tell you if there are any changes and suggest that you use this
342
It is also possible to create a "lightweight" checkout by passing the
343
--lightweight flag to checkout. A lightweight checkout is even closer to an
344
SVN checkout in that it is not a first class branch, it mainly consists of the
345
working tree. This means that any history operations must query the master
346
branch, which could be slow if a network connection is involved. Also, as you
347
don't have a local branch, then you cannot commit locally.
349
Lightweight checkouts work best when you have fast reliable access to the
350
master branch. This means that if the master branch is on the same disk or LAN
351
a lightweight checkout will be faster than a heavyweight one for any commands
352
that modify the revision history (as only one copy of the branch needs to
353
be updated). Heavyweight checkouts will generally be faster for any command
354
that uses the history but does not change it, but if the master branch is on
355
the same disk then there won't be a noticeable difference.
357
Another possible use for a checkout is to use it with a treeless repository
358
containing your branches, where you maintain only one working tree by
359
switching the master branch that the checkout points to when you want to
360
work on a different branch.
362
Obviously to commit on a checkout you need to be able to write to the master
363
branch. This means that the master branch must be accessible over a writeable
364
protocol , such as sftp://, and that you have write permissions at the other
365
end. Checkouts also work on the local file system, so that all that matters is
368
You can change the master of a checkout by using the "bind" command (see "help
369
bind"). This will change the location that the commits are sent to. The bind
370
command can also be used to turn a branch into a heavy checkout. If you
371
would like to convert your heavy checkout into a normal branch so that every
372
commit is local, you can use the "unbind" command.
376
checkout Create a checkout. Pass --lightweight to get a lightweight
378
update Pull any changes in the master branch in to your checkout
379
commit Make a commit that is sent to the master branch. If you have
380
a heavy checkout then the --local option will commit to the
381
checkout without sending the commit to the master
382
bind Change the master branch that the commits in the checkout will
384
unbind Turn a heavy checkout into a standalone branch so that any
385
commits are only made locally
391
Repositories in Bazaar are where committed information is stored. There is
392
a repository associated with every branch.
394
Repositories are a form of database. Bzr will usually maintain this for
395
good performance automatically, but in some situations (e.g. when doing
396
very many commits in a short time period) you may want to ask bzr to
397
optimise the database indices. This can be done by the 'bzr pack' command.
399
By default just running 'bzr init' will create a repository within the new
400
branch but it is possible to create a shared repository which allows multiple
401
branches to share their information in the same location. When a new branch is
402
created it will first look to see if there is a containing shared repository it
405
When two branches of the same project share a repository, there is
406
generally a large space saving. For some operations (e.g. branching
407
within the repository) this translates in to a large time saving.
409
To create a shared repository use the init-repository command (or the alias
410
init-repo). This command takes the location of the repository to create. This
411
means that 'bzr init-repository repo' will create a directory named 'repo',
412
which contains a shared repository. Any new branches that are created in this
413
directory will then use it for storage.
415
It is a good idea to create a repository whenever you might create more
416
than one branch of a project. This is true for both working areas where you
417
are doing the development, and any server areas that you use for hosting
418
projects. In the latter case, it is common to want branches without working
419
trees. Since the files in the branch will not be edited directly there is no
420
need to use up disk space for a working tree. To create a repository in which
421
the branches will not have working trees pass the '--no-trees' option to
426
init-repository Create a shared repository. Use --no-trees to create one
427
in which new branches won't get a working tree.
434
A working tree is the contents of a branch placed on disk so that you can
435
see the files and edit them. The working tree is where you make changes to a
436
branch, and when you commit the current state of the working tree is the
437
snapshot that is recorded in the commit.
439
When you push a branch to a remote system, a working tree will not be
440
created. If one is already present the files will not be updated. The
441
branch information will be updated and the working tree will be marked
442
as out-of-date. Updating a working tree remotely is difficult, as there
443
may be uncommitted changes or the update may cause content conflicts that are
444
difficult to deal with remotely.
446
If you have a branch with no working tree you can use the 'checkout' command
447
to create a working tree. If you run 'bzr checkout .' from the branch it will
448
create the working tree. If the branch is updated remotely, you can update the
449
working tree by running 'bzr update' in that directory.
451
If you have a branch with a working tree that you do not want the 'remove-tree'
452
command will remove the tree if it is safe. This can be done to avoid the
453
warning about the remote working tree not being updated when pushing to the
454
branch. It can also be useful when working with a '--no-trees' repository
455
(see 'bzr help repositories').
457
If you want to have a working tree on a remote machine that you push to you
458
can either run 'bzr update' in the remote branch after each push, or use some
459
other method to update the tree during the push. There is an 'rspush' plugin
460
that will update the working tree using rsync as well as doing a push. There
461
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
466
checkout Create a working tree when a branch does not have one.
467
remove-tree Removes the working tree from a branch when it is safe to do so.
468
update When a working tree is out of sync with it's associated branch
469
this will update the tree to match the branch.
476
A branch consists of the state of a project, including all of its
477
history. All branches have a repository associated (which is where the
478
branch history is stored), but multiple branches may share the same
479
repository (a shared repository). Branches can be copied and merged.
483
init Change a directory into a versioned branch.
484
branch Create a new copy of a branch.
485
merge Perform a three-way merge.
489
_standalone_trees = \
492
A standalone tree is a working tree with an associated repository. It
493
is an independently usable branch, with no dependencies on any other.
494
Creating a standalone tree (via bzr init) is the quickest way to put
495
an existing project under version control.
499
init Make a directory into a versioned branch.
506
Status flags are used to summarise changes to the working tree in a concise
507
manner. They are in the form::
511
where the columns' meanings are as follows.
513
Column 1 - versioning/renames::
520
P Entry for a pending merge (not a file)
522
Column 2 - contents::
531
* The execute bit was changed
536
"""Environment Variables
538
================ =================================================================
539
BZRPATH Path where bzr is to look for shell plugin external commands.
540
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
541
EMAIL E-Mail address of the user.
542
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
543
EDITOR Editor for editing commit messages.
544
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
545
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
546
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
547
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
548
BZR_SSH SSH client: paramiko (default), openssh, ssh, plink.
549
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
550
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
551
================ =================================================================
558
:On Linux: ~/.bazaar/bazaar.conf
559
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
561
Contains the user's default configuration. The section ``[DEFAULT]`` is
562
used to define general configuration that will be applied everywhere.
563
The section ``[ALIASES]`` can be used to create command aliases for
564
commonly used options.
566
A typical config file might look something like::
569
email=John Doe <jdoe@isp.com>
572
commit = commit --strict
573
log10 = log --short -r -10..-1
579
A criss-cross in the branch history can cause the default merge technique
580
to emit more conflicts than would normally be expected.
582
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
583
better results. You may wish to ``bzr revert`` the working tree and merge
584
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
586
Criss-crosses occur in a branch's history if two branches merge the same thing
587
and then merge one another, or if two branches merge one another at the same
588
time. They can be avoided by having each branch only merge from or into a
589
designated central branch (a "star topology").
591
Criss-crosses cause problems because of the way merge works. Bazaar's default
592
merge is a three-way merger; in order to merge OTHER into THIS, it must
593
find a basis for comparison, BASE. Using BASE, it can determine whether
594
differences between THIS and OTHER are due to one side adding lines, or
595
from another side removing lines.
597
Criss-crosses mean there is no good choice for a base. Selecting the recent
598
merge points could cause one side's changes to be silently discarded.
599
Selecting older merge points (which Bazaar does) mean that extra conflicts
602
The ``weave`` merge type is not affected by this problem because it uses
603
line-origin detection instead of a basis revision to determine the cause of
607
_branches_out_of_sync = """Branches out of sync
609
When reconfiguring a checkout, tree or branch into a lightweight checkout,
610
a local branch must be destroyed. (For checkouts, this is the local branch
611
that serves primarily as a cache.) If the branch-to-be-destroyed does not
612
have the same last revision as the new reference branch for the lightweight
613
checkout, data could be lost, so Bazaar refuses.
615
How you deal with this depends on *why* the branches are out of sync.
617
If you have a checkout and have done local commits, you can get back in sync
618
by running "bzr update" (and possibly "bzr commit").
620
If you have a branch and the remote branch is out-of-date, you can push
621
the local changes using "bzr push". If the local branch is out of date, you
622
can do "bzr pull". If both branches have had changes, you can merge, commit
623
and then push your changes. If you decide that some of the changes aren't
624
useful, you can "push --overwrite" or "pull --overwrite" instead.
628
# Register help topics
629
topic_registry.register("revisionspec", _help_on_revisionspec,
630
"Explain how to use --revision")
631
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
632
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
633
def get_format_topic(topic):
634
from bzrlib import bzrdir
635
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
636
topic_registry.register('formats', get_format_topic, 'Directory formats')
637
topic_registry.register('standard-options', _standard_options,
638
'Options that can be used with any command')
639
topic_registry.register('global-options', _global_options,
640
'Options that control how Bazaar runs')
641
topic_registry.register('urlspec', _help_on_transport,
642
"Supported transport protocols")
643
topic_registry.register('status-flags', _status_flags,
644
"Help on status flags")
645
def get_bugs_topic(topic):
646
from bzrlib import bugtracker
647
return ("Bug Tracker Settings\n\n" +
648
bugtracker.tracker_registry.help_topic(topic))
649
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
650
topic_registry.register('env-variables', _env_variables,
651
'Environment variable names and values')
652
topic_registry.register('files', _files,
653
'Information on configuration and log files')
655
# Load some of the help topics from files
656
topic_registry.register('authentication', _load_from_file,
657
'Information on configuring authentication')
658
topic_registry.register('configuration', _load_from_file,
659
'Details on the configuration settings available')
660
topic_registry.register('conflicts', _load_from_file,
661
'Types of conflicts and what to do about them')
662
topic_registry.register('hooks', _load_from_file,
663
'Points at which custom processing can be added')
666
# Register concept topics.
667
# Note that we might choose to remove these from the online help in the
668
# future or implement them via loading content from files. In the meantime,
669
# please keep them concise.
670
topic_registry.register('branches', _branches,
671
'Information on what a branch is', SECT_CONCEPT)
672
topic_registry.register('checkouts', _checkouts,
673
'Information on what a checkout is', SECT_CONCEPT)
674
topic_registry.register('patterns', _load_from_file,
675
'Information on the pattern syntax',
677
topic_registry.register('repositories', _repositories,
678
'Basic information on shared repositories.',
680
topic_registry.register('rules', _load_from_file,
681
'Information on defining rule-based preferences',
683
topic_registry.register('standalone-trees', _standalone_trees,
684
'Information on what a standalone tree is',
686
topic_registry.register('working-trees', _working_trees,
687
'Information on working trees', SECT_CONCEPT)
688
topic_registry.register('criss-cross', _criss_cross,
689
'Information on criss-cross merging', SECT_CONCEPT)
690
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
691
'Information on criss-cross merging', SECT_CONCEPT)
694
class HelpTopicIndex(object):
695
"""A index for bzr help that returns topics."""
700
def get_topics(self, topic):
701
"""Search for topic in the HelpTopicRegistry.
703
:param topic: A topic to search for. None is treated as 'basic'.
704
:return: A list which is either empty or contains a single
705
RegisteredTopic entry.
709
if topic in topic_registry:
710
return [RegisteredTopic(topic)]
715
class RegisteredTopic(object):
716
"""A help topic which has been registered in the HelpTopicRegistry.
718
These topics consist of nothing more than the name of the topic - all
719
data is retrieved on demand from the registry.
722
def __init__(self, topic):
725
:param topic: The name of the topic that this represents.
729
def get_help_text(self, additional_see_also=None, plain=True):
730
"""Return a string with the help for this topic.
732
:param additional_see_also: Additional help topics to be
734
:param plain: if False, raw help (reStructuredText) is
735
returned instead of plain text.
737
result = topic_registry.get_detail(self.topic)
738
# there is code duplicated here and in bzrlib/plugin.py's
739
# matching Topic code. This should probably be factored in
740
# to a helper function and a common base class.
741
if additional_see_also is not None:
742
see_also = sorted(set(additional_see_also))
746
result += '\n:See also: '
747
result += ', '.join(see_also)
750
result = help_as_plain_text(result)
753
def get_help_topic(self):
754
"""Return the help topic this can be found under."""
758
def help_as_plain_text(text):
759
"""Minimal converter of reStructuredText to plain text."""
760
lines = text.splitlines()
763
if line.startswith(':'):
765
elif line.endswith('::'):
768
return "\n".join(result) + "\n"
added
removed
bzrlib/help_topics/__init__.py
