2070.4.5
by John Arbash Meinel
cleanup copyright line |
1 |
# Copyright (C) 2006 Canonical Ltd
|
2023.1.2
by ghigo
add help topics module |
2 |
#
|
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.
|
|
7 |
#
|
|
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.
|
|
12 |
#
|
|
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
|
|
16 |
||
17 |
"""A collection of extra help information for using bzr.
|
|
18 |
||
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.
|
|
21 |
"""
|
|
22 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
23 |
from bzrlib import registry |
24 |
||
25 |
||
26 |
class HelpTopicRegistry(registry.Registry): |
|
2070.4.15
by John Arbash Meinel
Fixes from Martin |
27 |
"""A Registry customized for handling help topics."""
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
28 |
|
29 |
def register(self, topic, detail, summary): |
|
30 |
"""Register a new help topic.
|
|
31 |
||
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.
|
|
37 |
"""
|
|
38 |
# The detail is stored as the 'object' and the
|
|
39 |
super(HelpTopicRegistry, self).register(topic, detail, info=summary) |
|
40 |
||
41 |
def register_lazy(self, topic, module_name, member_name, summary): |
|
42 |
"""Register a new help topic, and import the details on demand.
|
|
43 |
||
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.
|
|
48 |
"""
|
|
2070.4.15
by John Arbash Meinel
Fixes from Martin |
49 |
super(HelpTopicRegistry, self).register_lazy(topic, module_name, |
50 |
member_name, info=summary) |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
51 |
|
52 |
def get_detail(self, topic): |
|
53 |
"""Get the detailed help on a given topic."""
|
|
54 |
obj = self.get(topic) |
|
55 |
if callable(obj): |
|
56 |
return obj(topic) |
|
57 |
else: |
|
58 |
return obj |
|
59 |
||
60 |
def get_summary(self, topic): |
|
61 |
"""Get the single line summary for the topic."""
|
|
62 |
return self.get_info(topic) |
|
63 |
||
64 |
||
65 |
topic_registry = HelpTopicRegistry() |
|
2023.1.2
by ghigo
add help topics module |
66 |
|
67 |
||
68 |
#----------------------------------------------------
|
|
69 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
70 |
def _help_on_topics(dummy): |
2023.1.2
by ghigo
add help topics module |
71 |
"""Write out the help for topics to outfile"""
|
72 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
73 |
topics = topic_registry.keys() |
2070.4.2
by John Arbash Meinel
cleanup help_topics.py |
74 |
lmax = max(len(topic) for topic in topics) |
2023.1.4
by ghigo
the ''bzr help topics'' output is shorter |
75 |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
76 |
out = [] |
2023.1.2
by ghigo
add help topics module |
77 |
for topic in topics: |
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
78 |
summary = topic_registry.get_summary(topic) |
79 |
out.append("%-*s %s\n" % (lmax, topic, summary)) |
|
80 |
return ''.join(out) |
|
81 |
||
82 |
||
83 |
def _help_on_revisionspec(name): |
|
2376.4.34
by Jonathan Lange
Remove spurious quote mark in docstring. |
84 |
"""Write the summary help for all documented topics to outfile."""
|
2023.1.2
by ghigo
add help topics module |
85 |
import bzrlib.revisionspec |
86 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
87 |
out = [] |
88 |
out.append("\nRevision prefix specifier:" |
|
89 |
"\n--------------------------\n") |
|
2023.1.2
by ghigo
add help topics module |
90 |
|
91 |
for i in bzrlib.revisionspec.SPEC_TYPES: |
|
2070.4.14
by John Arbash Meinel
Switch revisionspec to use the help defined as help_txt rather than the doc string |
92 |
doc = i.help_txt |
93 |
if doc == bzrlib.revisionspec.RevisionSpec.help_txt: |
|
2023.1.2
by ghigo
add help topics module |
94 |
doc = "N/A\n" |
2070.4.2
by John Arbash Meinel
cleanup help_topics.py |
95 |
while (doc[-2:] == '\n\n' or doc[-1:] == ' '): |
2023.1.2
by ghigo
add help topics module |
96 |
doc = doc[:-1] |
97 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
98 |
out.append(" %s %s\n\n" % (i.prefix, doc)) |
99 |
||
100 |
return ''.join(out) |
|
2023.1.2
by ghigo
add help topics module |
101 |
|
2241.2.11
by ghigo
On the basis of Robert Collins and John Arbash Meinel |
102 |
|
2241.2.5
by ghigo
add the topics transport |
103 |
def _help_on_transport(name): |
104 |
from bzrlib.transport import ( |
|
105 |
transport_list_registry, |
|
106 |
)
|
|
107 |
import textwrap |
|
108 |
||
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) |
|
114 |
||
2241.2.8
by ghigo
- rename transport urlspec |
115 |
def sort_func(a,b): |
116 |
a1 = a[:a.rfind("://")] |
|
117 |
b1 = b[:b.rfind("://")] |
|
118 |
if a1>b1: |
|
119 |
return +1 |
|
120 |
elif a1<b1: |
|
121 |
return -1 |
|
122 |
else: |
|
123 |
return 0 |
|
124 |
||
2241.2.6
by ghigo
removed unused code |
125 |
out = [] |
2241.2.5
by ghigo
add the topics transport |
126 |
protl = [] |
127 |
decl = [] |
|
128 |
protos = transport_list_registry.keys( ) |
|
2241.2.8
by ghigo
- rename transport urlspec |
129 |
protos.sort(sort_func) |
2241.2.5
by ghigo
add the topics transport |
130 |
for proto in protos: |
131 |
shorthelp = transport_list_registry.get_help(proto) |
|
132 |
if not shorthelp: |
|
133 |
continue
|
|
134 |
if proto.endswith("://"): |
|
135 |
protl.extend(add_string(proto, shorthelp, 79)) |
|
136 |
else: |
|
137 |
decl.extend(add_string(proto, shorthelp, 79)) |
|
138 |
||
139 |
||
2241.2.11
by ghigo
On the basis of Robert Collins and John Arbash Meinel |
140 |
out = "\nSupported URL prefix\n--------------------\n" + \ |
141 |
''.join(protl) |
|
142 |
||
143 |
if len(decl): |
|
144 |
out += "\nSupported modifiers\n-------------------\n" + \ |
|
145 |
''.join(decl) |
|
2241.2.5
by ghigo
add the topics transport |
146 |
|
147 |
return out |
|
148 |
||
2023.1.2
by ghigo
add help topics module |
149 |
|
150 |
_basic_help= \ |
|
151 |
"""Bazaar -- a free distributed version-control tool
|
|
152 |
http://bazaar-vcs.org/
|
|
153 |
||
154 |
Basic commands:
|
|
155 |
bzr init makes this directory a versioned branch
|
|
156 |
bzr branch make a copy of another branch
|
|
157 |
||
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
|
|
161 |
||
162 |
bzr status summarize changes in working copy
|
|
163 |
bzr diff show detailed diffs
|
|
164 |
||
165 |
bzr merge pull in changes from another branch
|
|
166 |
bzr commit save some or all changes
|
|
167 |
||
168 |
bzr log show history of changes
|
|
169 |
bzr check validate storage
|
|
170 |
||
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
|
|
174 |
"""
|
|
175 |
||
176 |
||
1551.9.32
by Aaron Bentley
Add global option help |
177 |
_global_options =\ |
178 |
"""Global Options
|
|
179 |
||
180 |
These options may be used with any command, and may appear in front of any
|
|
181 |
command. (e.g. "bzr --quiet help").
|
|
182 |
||
183 |
--quiet Suppress informational output; only print errors and warnings
|
|
184 |
--version Print the version number
|
|
185 |
||
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
|
|
190 |
||
2247.1.1
by John Arbash Meinel
fix --Derror => -Derror (trivial) |
191 |
-Derror Instead of normal error handling, always print a traceback on
|
1551.9.32
by Aaron Bentley
Add global option help |
192 |
error.
|
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
|
|
2493.2.7
by Aaron Bentley
Add info to --lsprof-file entry in global options |
196 |
results to a specified file. If the filename ends with ".txt",
|
197 |
text format will be used. If the filename ends with
|
|
198 |
".callgrind", output will be formatted for use with KCacheGrind.
|
|
199 |
Otherwise, the output will be a pickle.
|
|
200 |
||
201 |
See doc/developers/profiling.txt for more information on profiling.
|
|
1551.9.32
by Aaron Bentley
Add global option help |
202 |
|
203 |
Note: --version must be supplied before any command.
|
|
204 |
"""
|
|
205 |
||
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
206 |
_checkouts = \ |
207 |
"""Checkouts
|
|
208 |
||
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
209 |
Checkouts are source trees that are connected to a branch, so that when
|
210 |
you commit in the source tree, the commit goes into that branch. They
|
|
211 |
allow you to use a simpler, more centralized workflow, ignoring some of
|
|
212 |
Bazaar's decentralized features until you want them. Using checkouts
|
|
213 |
with shared repositories is very similar to working with SVN or CVS, but
|
|
214 |
doesn't have the same restrictions. And using checkouts still allows
|
|
215 |
others working on the project to use whatever workflow they like.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
216 |
|
217 |
A checkout is created with the bzr checkout command (see "help checkout").
|
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
218 |
You pass it a reference to another branch, and it will create a local copy
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
219 |
for you that still contains a reference to the branch you created the
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
220 |
checkout from (the master branch). Then if you make any commits they will be
|
221 |
made on the other branch first. This creates an instant mirror of your work, or
|
|
222 |
facilitates lockstep development, where each developer is working together,
|
|
223 |
continuously integrating the changes of others.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
224 |
|
225 |
However the checkout is still a first class branch in Bazaar terms, so that
|
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
226 |
you have the full history locally. As you have a first class branch you can
|
227 |
also commit locally if you want, for instance due to the temporary loss af a
|
|
228 |
network connection. Use the --local option to commit to do this. All the local
|
|
229 |
commits will then be made on the master branch the next time you do a non-local
|
|
230 |
commit.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
231 |
|
232 |
If you are using a checkout from a shared branch you will periodically want to
|
|
233 |
pull in all the changes made by others. This is done using the "update"
|
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
234 |
command. The changes need to be applied before any non-local commit, but
|
235 |
Bazaar will tell you if there are any changes and suggest that you use this
|
|
236 |
command when needed.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
237 |
|
238 |
It is also possible to create a "lightweight" checkout by passing the
|
|
239 |
--lightweight flag to checkout. A lightweight checkout is even closer to an
|
|
240 |
SVN checkout in that it is not a first class branch, it mainly consists of the
|
|
241 |
working tree. This means that any history operations must query the master
|
|
242 |
branch, which could be slow if a network connection is involved. Also, as you
|
|
243 |
don't have a local branch, then you cannot commit locally.
|
|
244 |
||
2374.1.1
by Ian Clatworthy
Help and man page fixes |
245 |
Lightweight checkouts work best when you have fast reliable access to the
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
246 |
master branch. This means that if the master branch is on the same disk or LAN
|
247 |
a lightweight checkout will be faster than a heavyweight one for any commands
|
|
248 |
that modify the revision history (as only one copy branch needs to be updated).
|
|
249 |
Heavyweight checkouts will generally be faster for any command that uses the
|
|
250 |
history but does not change it, but if the master branch is on the same disk
|
|
251 |
then there wont be a noticeable difference.
|
|
252 |
||
253 |
Another possible use for a checkout is to use it with a treeless repository
|
|
2370.1.2
by Ian Clatworthy
Minor fixes to help on checkouts |
254 |
containing your branches, where you maintain only one working tree by
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
255 |
switching the master branch that the checkout points to when you want to
|
256 |
work on a different branch.
|
|
257 |
||
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
258 |
Obviously to commit on a checkout you need to be able to write to the master
|
2370.1.2
by Ian Clatworthy
Minor fixes to help on checkouts |
259 |
branch. This means that the master branch must be accessible over a writeable
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
260 |
protocol , such as sftp://, and that you have write permissions at the other
|
261 |
end. Checkouts also work on the local file system, so that all that matters is
|
|
262 |
file permissions.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
263 |
|
264 |
You can change the master of a checkout by using the "bind" command (see "help
|
|
265 |
bind"). This will change the location that the commits are sent to. The bind
|
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
266 |
command can also be used to turn a branch into a heavy checkout. If you
|
267 |
would like to convert your heavy checkout into a normal branch so that every
|
|
268 |
commit is local, you can use the "unbind" command.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
269 |
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
270 |
Related commands:
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
271 |
|
272 |
checkout Create a checkout. Pass --lightweight to get a lightweight
|
|
273 |
checkout
|
|
274 |
update Pull any changes in the master branch in to your checkout
|
|
275 |
commit Make a commit that is sent to the master branch. If you have
|
|
276 |
a heavy checkout then the --local option will commit to the
|
|
277 |
checkout without sending the commit to the master
|
|
278 |
bind Change the master branch that the commits in the checkout will
|
|
279 |
be sent to
|
|
280 |
unbind Turn a heavy checkout into a standalone branch so that any
|
|
281 |
commits are only made locally
|
|
282 |
"""
|
|
283 |
||
2401.2.1
by James Westby
Add a help topic for repositories. |
284 |
_repositories = \ |
285 |
"""Repositories
|
|
286 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
287 |
Repositories in Bazaar are where committed information is stored. It is
|
288 |
possible to create a shared repository which allows multiple branches to
|
|
289 |
share their information in the same location. When a new branch is
|
|
290 |
created it will first look to see if there is a containing repository it
|
|
291 |
can share.
|
|
292 |
||
293 |
When two branches of the same project share a repository, there is
|
|
294 |
generally a large space saving. For some operations (e.g. branching
|
|
295 |
within the repository) this translates in to a large time saving.
|
|
2401.2.1
by James Westby
Add a help topic for repositories. |
296 |
|
297 |
To create a shared repository use the init-repository command (or the alias
|
|
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
298 |
init-repo). This command takes the location of the repository to create. This
|
299 |
means that 'bzr init-repository repo' will create a directory named 'repo',
|
|
300 |
which contains a shared repository. Any new branches that are created in this
|
|
301 |
directory will then use it for storage.
|
|
2401.2.1
by James Westby
Add a help topic for repositories. |
302 |
|
303 |
It is a good idea to create a repository whenever you might create more
|
|
304 |
than one branch of a project. This is true for both working areas where you
|
|
305 |
are doing the development, and any server areas that you use for hosting
|
|
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
306 |
projects. In the latter case, it is common to want branches without working
|
307 |
trees. Since the files in the branch will not be edited directly there is no
|
|
308 |
need to use up disk space for a working tree. To create a repository in which
|
|
309 |
the branches will not have working trees pass the '--no-trees' option to
|
|
310 |
'init-repository'.
|
|
2401.2.1
by James Westby
Add a help topic for repositories. |
311 |
|
312 |
Related commands:
|
|
313 |
||
314 |
init-repository Create a shared repository. Use --no-trees to create one
|
|
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
315 |
in which new branches won't get a working tree.
|
2401.2.1
by James Westby
Add a help topic for repositories. |
316 |
"""
|
317 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
318 |
|
2401.2.2
by James Westby
Add a working-trees help topic. |
319 |
_working_trees = \ |
320 |
"""Working Trees
|
|
321 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
322 |
A working tree is the contents of a branch placed on disk so that you can
|
2401.2.2
by James Westby
Add a working-trees help topic. |
323 |
see the files and edit them. The working tree is where you make changes to a
|
324 |
branch, and when you commit the current state of the working tree is the
|
|
325 |
snapshot that is recorded in the commit.
|
|
326 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
327 |
When you push a branch to a remote system, a working tree will not be
|
328 |
created. If one is already present the files will not be updated. The
|
|
329 |
branch information will be updated and the working tree will be marked
|
|
330 |
as out-of-date. Updating a working tree remotely is difficult, as there
|
|
331 |
may be uncommitted changes or the update may cause content conflicts that are
|
|
332 |
difficult to deal with remotely.
|
|
2401.2.2
by James Westby
Add a working-trees help topic. |
333 |
|
334 |
If you have a branch with no working tree you can use the 'checkout' command
|
|
335 |
to create a working tree. If you run 'bzr checkout .' from the branch it will
|
|
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
336 |
create the working tree. If the branch is updated remotely, you can update the
|
337 |
working tree by running 'bzr update' in that directory.
|
|
2401.2.2
by James Westby
Add a working-trees help topic. |
338 |
|
339 |
If you have a branch with a working tree that you do not want the 'remove-tree'
|
|
340 |
command will remove the tree if it is safe. This can be done to avoid the
|
|
341 |
warning about the remote working tree not being updated when pushing to the
|
|
342 |
branch. It can also be useful when working with a '--no-trees' repository
|
|
343 |
(see 'bzr help repositories').
|
|
344 |
||
345 |
If you want to have a working tree on a remote machine that you push to you
|
|
346 |
can either run 'bzr update' in the remote branch after each push, or use some
|
|
347 |
other method to update the tree during the push. There is an 'rspush' plugin
|
|
348 |
that will update the working tree using rsync as well as doing a push. There
|
|
349 |
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
|
|
350 |
after each push.
|
|
351 |
||
352 |
Useful commands:
|
|
353 |
||
354 |
checkout Create a working tree when a branch does not have one.
|
|
355 |
remove-tree Removes the working tree from a branch when it is safe to do so.
|
|
356 |
update When a working tree is out of sync with it's associated branch
|
|
357 |
this will update the tree to match the branch.
|
|
358 |
"""
|
|
359 |
||
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
360 |
_status_flags = \ |
361 |
"""Status Flags
|
|
362 |
||
363 |
Status flags are used to summarise changes to the working tree in a concise
|
|
364 |
manner. They are in the form:
|
|
365 |
xxx <filename>
|
|
366 |
where the columns' meanings are as follows.
|
|
367 |
||
368 |
Column 1: versioning / renames
|
|
369 |
+ File versioned
|
|
370 |
- File unversioned
|
|
371 |
R File renamed
|
|
372 |
? File unknown
|
|
373 |
C File has conflicts
|
|
374 |
P Entry for a pending merge (not a file)
|
|
375 |
||
376 |
Column 2: Contents
|
|
377 |
N File created
|
|
378 |
D File deleted
|
|
379 |
K File kind changed
|
|
380 |
M File modified
|
|
381 |
||
382 |
Column 3: Execute
|
|
383 |
* The execute bit was changed
|
|
384 |
"""
|
|
385 |
||
1551.9.32
by Aaron Bentley
Add global option help |
386 |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
387 |
topic_registry.register("revisionspec", _help_on_revisionspec, |
388 |
"Explain how to use --revision") |
|
389 |
topic_registry.register('basic', _basic_help, "Basic commands") |
|
390 |
topic_registry.register('topics', _help_on_topics, "Topics list") |
|
2204.4.1
by Aaron Bentley
Add 'formats' help topic |
391 |
def get_format_topic(topic): |
2204.4.7
by Aaron Bentley
restore register_lazy, remove register_factory, other updates |
392 |
from bzrlib import bzrdir |
2204.4.1
by Aaron Bentley
Add 'formats' help topic |
393 |
return bzrdir.format_registry.help_topic(topic) |
2204.4.10
by Aaron Bentley
Capitalize 'D' in 'directory formats' |
394 |
topic_registry.register('formats', get_format_topic, 'Directory formats') |
1551.9.34
by Aaron Bentley
Fix NEWS and whitespace |
395 |
topic_registry.register('global-options', _global_options, |
1551.9.32
by Aaron Bentley
Add global option help |
396 |
'Options that can be used with any command') |
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
397 |
topic_registry.register('checkouts', _checkouts, |
398 |
'Information on what a checkout is') |
|
2241.2.8
by ghigo
- rename transport urlspec |
399 |
topic_registry.register('urlspec', _help_on_transport, |
2241.2.5
by ghigo
add the topics transport |
400 |
"Supported transport protocols") |
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
401 |
topic_registry.register('status-flags', _status_flags, |
402 |
"Help on status flags") |
|
2376.4.36
by Jonathan Lange
Provide really basic help topic for our bug tracker support. |
403 |
def get_bugs_topic(topic): |
404 |
from bzrlib import bugtracker |
|
405 |
return bugtracker.tracker_registry.help_topic(topic) |
|
406 |
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support') |
|
2401.2.1
by James Westby
Add a help topic for repositories. |
407 |
topic_registry.register('repositories', _repositories, |
408 |
'Basic information on shared repositories.') |
|
2401.2.2
by James Westby
Add a working-trees help topic. |
409 |
topic_registry.register('working-trees', _working_trees, |
410 |
'Information on working trees') |
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
411 |
|
2432.1.1
by Robert Collins
Add a HelpTopicContext object. |
412 |
|
2432.1.15
by Robert Collins
Rename Context (in bzrlib.help) to Index, for a clearer name. |
413 |
class HelpTopicIndex(object): |
414 |
"""A index for bzr help that returns topics."""
|
|
2432.1.8
by Robert Collins
HelpTopicContext now returns RegisteredTopic objects for get_topics calls. |
415 |
|
2432.1.17
by Robert Collins
Add prefixes to HelpIndexes. |
416 |
def __init__(self): |
417 |
self.prefix = '' |
|
418 |
||
2432.1.8
by Robert Collins
HelpTopicContext now returns RegisteredTopic objects for get_topics calls. |
419 |
def get_topics(self, topic): |
420 |
"""Search for topic in the HelpTopicRegistry.
|
|
421 |
||
422 |
:param topic: A topic to search for. None is treated as 'basic'.
|
|
423 |
:return: A list which is either empty or contains a single
|
|
424 |
RegisteredTopic entry.
|
|
425 |
"""
|
|
426 |
if topic is None: |
|
427 |
topic = 'basic' |
|
428 |
if topic in topic_registry: |
|
429 |
return [RegisteredTopic(topic)] |
|
430 |
else: |
|
431 |
return [] |
|
432 |
||
433 |
||
434 |
class RegisteredTopic(object): |
|
435 |
"""A help topic which has been registered in the HelpTopicRegistry.
|
|
436 |
||
437 |
These topics consist of nothing more than the name of the topic - all
|
|
438 |
data is retrieved on demand from the registry.
|
|
439 |
"""
|
|
440 |
||
441 |
def __init__(self, topic): |
|
442 |
"""Constructor.
|
|
443 |
||
444 |
:param topic: The name of the topic that this represents.
|
|
445 |
"""
|
|
446 |
self.topic = topic |
|
2432.1.10
by Robert Collins
Add get_help_text() to RegisteredTopic to get the help as a string. |
447 |
|
2432.1.22
by Robert Collins
Teach RegisteredTopic to support the additional_see_also list of related help terms. |
448 |
def get_help_text(self, additional_see_also=None): |
449 |
"""Return a string with the help for this topic.
|
|
450 |
||
451 |
:param additional_see_also: Additional help topics to be
|
|
452 |
cross-referenced.
|
|
453 |
"""
|
|
454 |
result = topic_registry.get_detail(self.topic) |
|
2432.1.25
by Robert Collins
Return plugin module docstrings for 'bzr help plugin'. |
455 |
# there is code duplicated here and in bzrlib/plugin.py's
|
456 |
# matching Topic code. This should probably be factored in
|
|
457 |
# to a helper function and a common base class.
|
|
2432.1.22
by Robert Collins
Teach RegisteredTopic to support the additional_see_also list of related help terms. |
458 |
if additional_see_also is not None: |
459 |
see_also = sorted(set(additional_see_also)) |
|
460 |
else: |
|
461 |
see_also = None |
|
462 |
if see_also: |
|
463 |
result += '\nSee also: ' |
|
464 |
result += ', '.join(see_also) |
|
465 |
result += '\n' |
|
466 |
return result |
|
2432.1.27
by Robert Collins
Add a get_help_topic method to RegisteredTopic. |
467 |
|
468 |
def get_help_topic(self): |
|
469 |
"""Return the help topic this can be found under."""
|
|
470 |
return self.topic |
|
2485.1.1
by James Westby
Update the help topics to the latest bzr.dev. |
471 |