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.
23
from bzrlib import registry
26
class HelpTopicRegistry(registry.Registry):
27
"""A Registry customized for handling help topics."""
29
def register(self, topic, detail, summary):
30
"""Register a new help topic.
32
:param topic: Name of documentation entry
33
:param detail: Function or string object providing detailed
34
documentation for topic. Function interface is detail(topic).
35
This should return a text string of the detailed information.
36
:param summary: String providing single-line documentation for topic.
38
# The detail is stored as the 'object' and the
39
super(HelpTopicRegistry, self).register(topic, detail, info=summary)
41
def register_lazy(self, topic, module_name, member_name, summary):
42
"""Register a new help topic, and import the details on demand.
44
:param topic: Name of documentation entry
45
:param module_name: The module to find the detailed help.
46
:param member_name: The member of the module to use for detailed help.
47
:param summary: String providing single-line documentation for topic.
49
super(HelpTopicRegistry, self).register_lazy(topic, module_name,
50
member_name, info=summary)
52
def get_detail(self, topic):
53
"""Get the detailed help on a given topic."""
60
def get_summary(self, topic):
61
"""Get the single line summary for the topic."""
62
return self.get_info(topic)
65
topic_registry = HelpTopicRegistry()
68
#----------------------------------------------------
70
def _help_on_topics(dummy):
71
"""Write out the help for topics to outfile"""
73
topics = topic_registry.keys()
74
lmax = max(len(topic) for topic in topics)
78
summary = topic_registry.get_summary(topic)
79
out.append("%-*s %s\n" % (lmax, topic, summary))
83
def _help_on_revisionspec(name):
84
"""Write the summary help for all documented topics to outfile."""
85
import bzrlib.revisionspec
88
out.append("\nRevision prefix specifier:"
89
"\n--------------------------\n")
91
for i in bzrlib.revisionspec.SPEC_TYPES:
93
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
95
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
98
out.append(" %s %s\n\n" % (i.prefix, doc))
103
def _help_on_transport(name):
104
from bzrlib.transport import (
105
transport_list_registry,
109
def add_string(proto, help, maxl, prefix_width=20):
110
help_lines = textwrap.wrap(help, maxl - prefix_width)
111
line_with_indent = '\n' + ' ' * prefix_width
112
help_text = line_with_indent.join(help_lines)
113
return "%-20s%s\n" % (proto, help_text)
116
a1 = a[:a.rfind("://")]
117
b1 = b[:b.rfind("://")]
128
protos = transport_list_registry.keys( )
129
protos.sort(sort_func)
131
shorthelp = transport_list_registry.get_help(proto)
134
if proto.endswith("://"):
135
protl.extend(add_string(proto, shorthelp, 79))
137
decl.extend(add_string(proto, shorthelp, 79))
140
out = "\nSupported URL prefix\n--------------------\n" + \
144
out += "\nSupported modifiers\n-------------------\n" + \
151
"""Bazaar -- a free distributed version-control tool
152
http://bazaar-vcs.org/
155
bzr init makes this directory a versioned branch
156
bzr branch make a copy of another branch
158
bzr add make files or directories versioned
159
bzr ignore ignore a file or pattern
160
bzr mv move or rename a versioned file
162
bzr status summarize changes in working copy
163
bzr diff show detailed diffs
165
bzr merge pull in changes from another branch
166
bzr commit save some or all changes
168
bzr log show history of changes
169
bzr check validate storage
171
bzr help init more help on e.g. init command
172
bzr help commands list all commands
173
bzr help topics list all help topics
180
These options may be used with any command, and may appear in front of any
181
command. (e.g. "bzr --quiet help").
183
--quiet Suppress informational output; only print errors and warnings
184
--version Print the version number
186
--no-aliases Do not process command aliases when running this command
187
--builtin Use the built-in version of a command, not the plugin version.
188
This does not suppress other plugin effects
189
--no-plugins Do not process any plugins
191
-Derror Instead of normal error handling, always print a traceback on
193
--profile Profile execution using the hotshot profiler
194
--lsprof Profile execution using the lsprof profiler
195
--lsprof-file Profile execution using the lsprof profiler, and write the
196
results to a specified file.
198
Note: --version must be supplied before any command.
204
Checkouts are source trees that are connected to a branch, so that when
205
you commit in the source tree, the commit goes into that branch. They
206
allow you to use a simpler, more centralized workflow, ignoring some of
207
Bazaar's decentralized features until you want them. Using checkouts
208
with shared repositories is very similar to working with SVN or CVS, but
209
doesn't have the same restrictions. And using checkouts still allows
210
others working on the project to use whatever workflow they like.
212
A checkout is created with the bzr checkout command (see "help checkout").
213
You pass it a reference to another branch, and it will create a local copy
214
for you that still contains a reference to the branch you created the
215
checkout from (the master branch). Then if you make any commits they will be
216
made on the other branch first. This creates an instant mirror of your work, or
217
facilitates lockstep development, where each developer is working together,
218
continuously integrating the changes of others.
220
However the checkout is still a first class branch in Bazaar terms, so that
221
you have the full history locally. As you have a first class branch you can
222
also commit locally if you want, for instance due to the temporary loss af a
223
network connection. Use the --local option to commit to do this. All the local
224
commits will then be made on the master branch the next time you do a non-local
227
If you are using a checkout from a shared branch you will periodically want to
228
pull in all the changes made by others. This is done using the "update"
229
command. The changes need to be applied before any non-local commit, but
230
Bazaar will tell you if there are any changes and suggest that you use this
233
It is also possible to create a "lightweight" checkout by passing the
234
--lightweight flag to checkout. A lightweight checkout is even closer to an
235
SVN checkout in that it is not a first class branch, it mainly consists of the
236
working tree. This means that any history operations must query the master
237
branch, which could be slow if a network connection is involved. Also, as you
238
don't have a local branch, then you cannot commit locally.
240
Lightweight checkouts work best when you have fast reliable access to the
241
master branch. This means that if the master branch is on the same disk or LAN
242
a lightweight checkout will be faster than a heavyweight one for any commands
243
that modify the revision history (as only one copy branch needs to be updated).
244
Heavyweight checkouts will generally be faster for any command that uses the
245
history but does not change it, but if the master branch is on the same disk
246
then there wont be a noticeable difference.
248
Another possible use for a checkout is to use it with a treeless repository
249
containing your branches, where you maintain only one working tree by
250
switching the master branch that the checkout points to when you want to
251
work on a different branch.
253
Obviously to commit on a checkout you need to be able to write to the master
254
branch. This means that the master branch must be accessible over a writeable
255
protocol , such as sftp://, and that you have write permissions at the other
256
end. Checkouts also work on the local file system, so that all that matters is
259
You can change the master of a checkout by using the "bind" command (see "help
260
bind"). This will change the location that the commits are sent to. The bind
261
command can also be used to turn a branch into a heavy checkout. If you
262
would like to convert your heavy checkout into a normal branch so that every
263
commit is local, you can use the "unbind" command.
267
checkout Create a checkout. Pass --lightweight to get a lightweight
269
update Pull any changes in the master branch in to your checkout
270
commit Make a commit that is sent to the master branch. If you have
271
a heavy checkout then the --local option will commit to the
272
checkout without sending the commit to the master
273
bind Change the master branch that the commits in the checkout will
275
unbind Turn a heavy checkout into a standalone branch so that any
276
commits are only made locally
282
Repositories in Bazaar are where committed information is stored. It is
283
possible to create a shared repository which allows multiple branches to
284
share their information in the same location. When a new branch is
285
created it will first look to see if there is a containing repository it
288
When two branches of the same project share a repository, there is
289
generally a large space saving. For some operations (e.g. branching
290
within the repository) this translates in to a large time saving.
292
To create a shared repository use the init-repository command (or the alias
293
init-repo). This command takes the location of the repository to create. This
294
means that 'bzr init-repository repo' will create a directory named 'repo',
295
which contains a shared repository. Any new branches that are created in this
296
directory will then use it for storage.
298
It is a good idea to create a repository whenever you might create more
299
than one branch of a project. This is true for both working areas where you
300
are doing the development, and any server areas that you use for hosting
301
projects. In the latter case, it is common to want branches without working
302
trees. Since the files in the branch will not be edited directly there is no
303
need to use up disk space for a working tree. To create a repository in which
304
the branches will not have working trees pass the '--no-trees' option to
309
init-repository Create a shared repository. Use --no-trees to create one
310
in which new branches won't get a working tree.
317
A working tree is the contents of a branch placed on disk so that you can
318
see the files and edit them. The working tree is where you make changes to a
319
branch, and when you commit the current state of the working tree is the
320
snapshot that is recorded in the commit.
322
When you push a branch to a remote system, a working tree will not be
323
created. If one is already present the files will not be updated. The
324
branch information will be updated and the working tree will be marked
325
as out-of-date. Updating a working tree remotely is difficult, as there
326
may be uncommitted changes or the update may cause content conflicts that are
327
difficult to deal with remotely.
329
If you have a branch with no working tree you can use the 'checkout' command
330
to create a working tree. If you run 'bzr checkout .' from the branch it will
331
create the working tree. If the branch is updated remotely, you can update the
332
working tree by running 'bzr update' in that directory.
334
If you have a branch with a working tree that you do not want the 'remove-tree'
335
command will remove the tree if it is safe. This can be done to avoid the
336
warning about the remote working tree not being updated when pushing to the
337
branch. It can also be useful when working with a '--no-trees' repository
338
(see 'bzr help repositories').
340
If you want to have a working tree on a remote machine that you push to you
341
can either run 'bzr update' in the remote branch after each push, or use some
342
other method to update the tree during the push. There is an 'rspush' plugin
343
that will update the working tree using rsync as well as doing a push. There
344
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
349
checkout Create a working tree when a branch does not have one.
350
remove-tree Removes the working tree from a branch when it is safe to do so.
351
update When a working tree is out of sync with it's associated branch
352
this will update the tree to match the branch.
356
topic_registry.register("revisionspec", _help_on_revisionspec,
357
"Explain how to use --revision")
358
topic_registry.register('basic', _basic_help, "Basic commands")
359
topic_registry.register('topics', _help_on_topics, "Topics list")
360
def get_format_topic(topic):
361
from bzrlib import bzrdir
362
return bzrdir.format_registry.help_topic(topic)
363
topic_registry.register('formats', get_format_topic, 'Directory formats')
364
topic_registry.register('global-options', _global_options,
365
'Options that can be used with any command')
366
topic_registry.register('checkouts', _checkouts,
367
'Information on what a checkout is')
368
topic_registry.register('urlspec', _help_on_transport,
369
"Supported transport protocols")
370
def get_bugs_topic(topic):
371
from bzrlib import bugtracker
372
return bugtracker.tracker_registry.help_topic(topic)
373
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
374
topic_registry.register('repositories', _repositories,
375
'Basic information on shared repositories.')
376
topic_registry.register('working-trees', _working_trees,
377
'Information on working trees')
380
class HelpTopicIndex(object):
381
"""A index for bzr help that returns topics."""
386
def get_topics(self, topic):
387
"""Search for topic in the HelpTopicRegistry.
389
:param topic: A topic to search for. None is treated as 'basic'.
390
:return: A list which is either empty or contains a single
391
RegisteredTopic entry.
395
if topic in topic_registry:
396
return [RegisteredTopic(topic)]
401
class RegisteredTopic(object):
402
"""A help topic which has been registered in the HelpTopicRegistry.
404
These topics consist of nothing more than the name of the topic - all
405
data is retrieved on demand from the registry.
408
def __init__(self, topic):
411
:param topic: The name of the topic that this represents.
415
def get_help_text(self, additional_see_also=None):
416
"""Return a string with the help for this topic.
418
:param additional_see_also: Additional help topics to be
421
result = topic_registry.get_detail(self.topic)
422
# there is code duplicated here and in bzrlib/plugin.py's
423
# matching Topic code. This should probably be factored in
424
# to a helper function and a common base class.
425
if additional_see_also is not None:
426
see_also = sorted(set(additional_see_also))
430
result += '\nSee also: '
431
result += ', '.join(see_also)
435
def get_help_topic(self):
436
"""Return the help topic this can be found under."""
added
removed
bzrlib/help_topics.py
