4110.2.24
by Martin Pool
merge trunk |
1 |
# Copyright (C) 2006, 2009 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
|
|
4183.7.1
by Sabin Iacob
update FSF mailing address |
15 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
2023.1.2
by ghigo
add help topics module |
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.
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
21 |
|
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:
|
|
27 |
||
28 |
1. A '::' appearing on the end of a line is replaced with ':'.
|
|
29 |
2. Lines starting with a ':' have it stripped.
|
|
30 |
||
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.
|
|
2023.1.2
by ghigo
add help topics module |
34 |
"""
|
35 |
||
3087.2.4
by Alexander Belchenko
Help topics can now be loaded from files (based on Ian's patch, adapted to proper support various windows installers). |
36 |
import sys |
37 |
||
38 |
import bzrlib |
|
39 |
from bzrlib import ( |
|
40 |
osutils, |
|
41 |
registry, |
|
42 |
)
|
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
43 |
|
44 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
45 |
# Section identifiers (map topics to the right place in the manual)
|
46 |
SECT_COMMAND = "command" |
|
47 |
SECT_CONCEPT = "concept" |
|
48 |
SECT_HIDDEN = "hidden" |
|
49 |
SECT_LIST = "list" |
|
50 |
SECT_PLUGIN = "plugin" |
|
51 |
||
52 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
53 |
class HelpTopicRegistry(registry.Registry): |
2070.4.15
by John Arbash Meinel
Fixes from Martin |
54 |
"""A Registry customized for handling help topics."""
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
55 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
56 |
def register(self, topic, detail, summary, section=SECT_LIST): |
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
57 |
"""Register a new help topic.
|
58 |
||
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.
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
63 |
See the module documentation for details on help text formatting.
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
64 |
:param summary: String providing single-line documentation for topic.
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
65 |
:param section: Section in reference manual - see SECT_* identifiers.
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
66 |
"""
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
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) |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
70 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
71 |
def register_lazy(self, topic, module_name, member_name, summary, |
72 |
section=SECT_LIST): |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
73 |
"""Register a new help topic, and import the details on demand.
|
74 |
||
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.
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
79 |
:param section: Section in reference manual - see SECT_* identifiers.
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
80 |
"""
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
81 |
# The detail is stored as the 'object' and the metadata as the info
|
82 |
info=(summary,section) |
|
2070.4.15
by John Arbash Meinel
Fixes from Martin |
83 |
super(HelpTopicRegistry, self).register_lazy(topic, module_name, |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
84 |
member_name, info=info) |
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
85 |
|
86 |
def get_detail(self, topic): |
|
87 |
"""Get the detailed help on a given topic."""
|
|
88 |
obj = self.get(topic) |
|
89 |
if callable(obj): |
|
90 |
return obj(topic) |
|
91 |
else: |
|
92 |
return obj |
|
93 |
||
94 |
def get_summary(self, topic): |
|
95 |
"""Get the single line summary for the topic."""
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
96 |
info = self.get_info(topic) |
97 |
if info is None: |
|
98 |
return None |
|
99 |
else: |
|
100 |
return info[0] |
|
101 |
||
102 |
def get_section(self, topic): |
|
103 |
"""Get the section for the topic."""
|
|
104 |
info = self.get_info(topic) |
|
105 |
if info is None: |
|
106 |
return None |
|
107 |
else: |
|
108 |
return info[1] |
|
109 |
||
110 |
def get_topics_for_section(self, section): |
|
111 |
"""Get the set of topics in a section."""
|
|
112 |
result = set() |
|
113 |
for topic in self.keys(): |
|
114 |
if section == self.get_section(topic): |
|
115 |
result.add(topic) |
|
116 |
return result |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
117 |
|
118 |
||
119 |
topic_registry = HelpTopicRegistry() |
|
2023.1.2
by ghigo
add help topics module |
120 |
|
121 |
||
122 |
#----------------------------------------------------
|
|
123 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
124 |
def _help_on_topics(dummy): |
2023.1.2
by ghigo
add help topics module |
125 |
"""Write out the help for topics to outfile"""
|
126 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
127 |
topics = topic_registry.keys() |
2070.4.2
by John Arbash Meinel
cleanup help_topics.py |
128 |
lmax = max(len(topic) for topic in topics) |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
129 |
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
130 |
out = [] |
2023.1.2
by ghigo
add help topics module |
131 |
for topic in topics: |
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
132 |
summary = topic_registry.get_summary(topic) |
133 |
out.append("%-*s %s\n" % (lmax, topic, summary)) |
|
134 |
return ''.join(out) |
|
135 |
||
136 |
||
3089.3.1
by Ian Clatworthy
move reference material out of User Guide into User Reference |
137 |
def _load_from_file(topic_name): |
138 |
"""Load help from a file.
|
|
139 |
||
3089.3.8
by Ian Clatworthy
move resource loading into a reusable function |
140 |
Topics are expected to be txt files in bzrlib.help_topics.
|
3089.3.1
by Ian Clatworthy
move reference material out of User Guide into User Reference |
141 |
"""
|
3089.3.10
by Ian Clatworthy
more feedback from Alex - make help_topics a real package |
142 |
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,)) |
3089.3.8
by Ian Clatworthy
move resource loading into a reusable function |
143 |
return osutils.resource_string('bzrlib.help_topics', resource_name) |
3089.3.1
by Ian Clatworthy
move reference material out of User Guide into User Reference |
144 |
|
145 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
146 |
def _help_on_revisionspec(name): |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
147 |
"""Generate the help for revision specs."""
|
148 |
import re |
|
2023.1.2
by ghigo
add help topics module |
149 |
import bzrlib.revisionspec |
150 |
||
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
151 |
out = [] |
3651.2.2
by Daniel Clemente
Explained the syntax for revision and range identifiers |
152 |
out.append( |
153 |
"""Revision Identifiers
|
|
154 |
||
155 |
A revision identifier refers to a specific state of a branch's history. It can
|
|
156 |
be a revision number, or a keyword followed by ':' and often other
|
|
157 |
parameters. Some examples of identifiers are '3', 'last:1', 'before:yesterday'
|
|
158 |
and 'submit:'.
|
|
159 |
||
160 |
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
|
|
161 |
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
|
|
162 |
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
|
|
3651.2.3
by Daniel Clemente
Explained more about range interpretations. Removed sentence about REV1..REV2..REV3 because it's unimplemented |
163 |
spaces around the '..').
|
164 |
||
165 |
Ranges are interpreted differently by different commands. To the "log" command,
|
|
166 |
a range is a sequence of log messages, but to the "diff" command, the range
|
|
167 |
denotes a change between revisions (and not a sequence of changes). In
|
|
168 |
addition, "log" considers a closed range whereas "diff" and "merge" consider it
|
|
169 |
to be open-ended, that is, they include one end but not the other. For example:
|
|
170 |
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
|
|
3946.1.2
by Ian Clatworthy
Correct incorrect wording in revisionspec help (Matthew Fuller) |
171 |
while "bzr diff -r 3647..3649" includes the changes done in revisions 3648 and
|
172 |
3649, but not 3647.
|
|
3651.2.2
by Daniel Clemente
Explained the syntax for revision and range identifiers |
173 |
|
174 |
The keywords used as revision selection methods are the following:
|
|
175 |
""") |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
176 |
details = [] |
3651.2.2
by Daniel Clemente
Explained the syntax for revision and range identifiers |
177 |
details.append("\nIn addition, plugins can provide other keywords.") |
178 |
details.append("\nA detailed description of each keyword is given below.\n") |
|
2023.1.2
by ghigo
add help topics module |
179 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
180 |
# The help text is indented 4 spaces - this re cleans that up below
|
181 |
indent_re = re.compile(r'^ ', re.MULTILINE) |
|
3966.2.1
by Jelmer Vernooij
Register revision specifiers in a registry. |
182 |
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems(): |
2070.4.14
by John Arbash Meinel
Switch revisionspec to use the help defined as help_txt rather than the doc string |
183 |
doc = i.help_txt |
184 |
if doc == bzrlib.revisionspec.RevisionSpec.help_txt: |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
185 |
summary = "N/A" |
186 |
doc = summary + "\n" |
|
187 |
else: |
|
188 |
# Extract out the top line summary from the body and
|
|
189 |
# clean-up the unwanted whitespace
|
|
190 |
summary,doc = doc.split("\n", 1) |
|
191 |
#doc = indent_re.sub('', doc)
|
|
192 |
while (doc[-2:] == '\n\n' or doc[-1:] == ' '): |
|
193 |
doc = doc[:-1] |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
194 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
195 |
# Note: The leading : here are HACKs to get reStructuredText
|
196 |
# 'field' formatting - we know that the prefix ends in a ':'.
|
|
197 |
out.append(":%s\n\t%s" % (i.prefix, summary)) |
|
198 |
details.append(":%s\n%s" % (i.prefix, doc)) |
|
199 |
||
200 |
return '\n'.join(out + details) |
|
2023.1.2
by ghigo
add help topics module |
201 |
|
2241.2.11
by ghigo
On the basis of Robert Collins and John Arbash Meinel |
202 |
|
2241.2.5
by ghigo
add the topics transport |
203 |
def _help_on_transport(name): |
204 |
from bzrlib.transport import ( |
|
205 |
transport_list_registry, |
|
206 |
)
|
|
207 |
import textwrap |
|
208 |
||
209 |
def add_string(proto, help, maxl, prefix_width=20): |
|
210 |
help_lines = textwrap.wrap(help, maxl - prefix_width) |
|
211 |
line_with_indent = '\n' + ' ' * prefix_width |
|
212 |
help_text = line_with_indent.join(help_lines) |
|
213 |
return "%-20s%s\n" % (proto, help_text) |
|
214 |
||
2241.2.8
by ghigo
- rename transport urlspec |
215 |
def sort_func(a,b): |
216 |
a1 = a[:a.rfind("://")] |
|
217 |
b1 = b[:b.rfind("://")] |
|
218 |
if a1>b1: |
|
219 |
return +1 |
|
220 |
elif a1<b1: |
|
221 |
return -1 |
|
222 |
else: |
|
223 |
return 0 |
|
224 |
||
2241.2.5
by ghigo
add the topics transport |
225 |
protl = [] |
226 |
decl = [] |
|
227 |
protos = transport_list_registry.keys( ) |
|
2241.2.8
by ghigo
- rename transport urlspec |
228 |
protos.sort(sort_func) |
2241.2.5
by ghigo
add the topics transport |
229 |
for proto in protos: |
230 |
shorthelp = transport_list_registry.get_help(proto) |
|
231 |
if not shorthelp: |
|
232 |
continue
|
|
233 |
if proto.endswith("://"): |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
234 |
protl.append(add_string(proto, shorthelp, 79)) |
2241.2.5
by ghigo
add the topics transport |
235 |
else: |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
236 |
decl.append(add_string(proto, shorthelp, 79)) |
237 |
||
238 |
||
239 |
out = "URL Identifiers\n\n" + \ |
|
240 |
"Supported URL prefixes::\n\n " + \ |
|
241 |
' '.join(protl) |
|
2241.2.11
by ghigo
On the basis of Robert Collins and John Arbash Meinel |
242 |
|
243 |
if len(decl): |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
244 |
out += "\nSupported modifiers::\n\n " + \ |
245 |
' '.join(decl) |
|
2241.2.5
by ghigo
add the topics transport |
246 |
|
247 |
return out |
|
248 |
||
2023.1.2
by ghigo
add help topics module |
249 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
250 |
_basic_help = \ |
2023.1.2
by ghigo
add help topics module |
251 |
"""Bazaar -- a free distributed version-control tool
|
252 |
http://bazaar-vcs.org/
|
|
253 |
||
254 |
Basic commands:
|
|
255 |
bzr init makes this directory a versioned branch
|
|
256 |
bzr branch make a copy of another branch
|
|
257 |
||
258 |
bzr add make files or directories versioned
|
|
259 |
bzr ignore ignore a file or pattern
|
|
260 |
bzr mv move or rename a versioned file
|
|
261 |
||
262 |
bzr status summarize changes in working copy
|
|
263 |
bzr diff show detailed diffs
|
|
264 |
||
265 |
bzr merge pull in changes from another branch
|
|
266 |
bzr commit save some or all changes
|
|
3696.7.2
by Jelmer Vernooij
Mention changes are sent via email. |
267 |
bzr send send changes via email
|
2023.1.2
by ghigo
add help topics module |
268 |
|
269 |
bzr log show history of changes
|
|
270 |
bzr check validate storage
|
|
271 |
||
272 |
bzr help init more help on e.g. init command
|
|
273 |
bzr help commands list all commands
|
|
274 |
bzr help topics list all help topics
|
|
275 |
"""
|
|
276 |
||
277 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
278 |
_global_options = \ |
1551.9.32
by Aaron Bentley
Add global option help |
279 |
"""Global Options
|
280 |
||
281 |
These options may be used with any command, and may appear in front of any
|
|
2768.1.1
by Ian Clatworthy
Document standard options |
282 |
command. (e.g. "bzr --profile help").
|
1551.9.32
by Aaron Bentley
Add global option help |
283 |
|
2768.1.14
by Ian Clatworthy
Incorporate feedback from poolie |
284 |
--version Print the version number. Must be supplied before the command.
|
2748.1.1
by Ian Clatworthy
(Daniel Watkins) help global-options now lists all debug flags |
285 |
--no-aliases Do not process command aliases when running this command.
|
1551.9.32
by Aaron Bentley
Add global option help |
286 |
--builtin Use the built-in version of a command, not the plugin version.
|
2748.1.1
by Ian Clatworthy
(Daniel Watkins) help global-options now lists all debug flags |
287 |
This does not suppress other plugin effects.
|
288 |
--no-plugins Do not process any plugins.
|
|
1551.9.32
by Aaron Bentley
Add global option help |
289 |
|
2748.1.1
by Ian Clatworthy
(Daniel Watkins) help global-options now lists all debug flags |
290 |
--profile Profile execution using the hotshot profiler.
|
291 |
--lsprof Profile execution using the lsprof profiler.
|
|
1551.9.32
by Aaron Bentley
Add global option help |
292 |
--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 |
293 |
results to a specified file. If the filename ends with ".txt",
|
2654.2.1
by Ian Clatworthy
Dump profiling data for KCacheGrind if the filename starts with callgrind.out |
294 |
text format will be used. If the filename either starts with
|
295 |
"callgrind.out" or end with ".callgrind", the output will be
|
|
296 |
formatted for use with KCacheGrind. Otherwise, the output
|
|
297 |
will be a pickle.
|
|
3169.3.1
by Andrew Bennetts
Make --coverage a global option. |
298 |
--coverage Generate line coverage report in the specified directory.
|
2493.2.7
by Aaron Bentley
Add info to --lsprof-file entry in global options |
299 |
|
300 |
See doc/developers/profiling.txt for more information on profiling.
|
|
2768.1.14
by Ian Clatworthy
Incorporate feedback from poolie |
301 |
A number of debug flags are also available to assist troubleshooting and
|
4110.2.7
by Martin Pool
Split debug flags into their own help topic |
302 |
development. See `bzr help debug-flags`.
|
1551.9.32
by Aaron Bentley
Add global option help |
303 |
"""
|
304 |
||
2768.1.1
by Ian Clatworthy
Document standard options |
305 |
_standard_options = \ |
306 |
"""Standard Options
|
|
307 |
||
308 |
Standard options are legal for all commands.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
309 |
|
2768.1.1
by Ian Clatworthy
Document standard options |
310 |
--help, -h Show help message.
|
2768.1.13
by Ian Clatworthy
Minor fixes to help |
311 |
--verbose, -v Display more information.
|
312 |
--quiet, -q Only display errors and warnings.
|
|
2768.1.1
by Ian Clatworthy
Document standard options |
313 |
|
2768.1.14
by Ian Clatworthy
Incorporate feedback from poolie |
314 |
Unlike global options, standard options can be used in aliases.
|
2768.1.1
by Ian Clatworthy
Document standard options |
315 |
"""
|
316 |
||
317 |
||
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
318 |
_checkouts = \ |
319 |
"""Checkouts
|
|
320 |
||
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
321 |
Checkouts are source trees that are connected to a branch, so that when
|
322 |
you commit in the source tree, the commit goes into that branch. They
|
|
323 |
allow you to use a simpler, more centralized workflow, ignoring some of
|
|
324 |
Bazaar's decentralized features until you want them. Using checkouts
|
|
325 |
with shared repositories is very similar to working with SVN or CVS, but
|
|
326 |
doesn't have the same restrictions. And using checkouts still allows
|
|
327 |
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. |
328 |
|
329 |
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. |
330 |
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. |
331 |
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. |
332 |
checkout from (the master branch). Then if you make any commits they will be
|
333 |
made on the other branch first. This creates an instant mirror of your work, or
|
|
334 |
facilitates lockstep development, where each developer is working together,
|
|
335 |
continuously integrating the changes of others.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
336 |
|
337 |
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. |
338 |
you have the full history locally. As you have a first class branch you can
|
339 |
also commit locally if you want, for instance due to the temporary loss af a
|
|
340 |
network connection. Use the --local option to commit to do this. All the local
|
|
341 |
commits will then be made on the master branch the next time you do a non-local
|
|
342 |
commit.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
343 |
|
344 |
If you are using a checkout from a shared branch you will periodically want to
|
|
345 |
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. |
346 |
command. The changes need to be applied before any non-local commit, but
|
347 |
Bazaar will tell you if there are any changes and suggest that you use this
|
|
348 |
command when needed.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
349 |
|
350 |
It is also possible to create a "lightweight" checkout by passing the
|
|
351 |
--lightweight flag to checkout. A lightweight checkout is even closer to an
|
|
352 |
SVN checkout in that it is not a first class branch, it mainly consists of the
|
|
353 |
working tree. This means that any history operations must query the master
|
|
354 |
branch, which could be slow if a network connection is involved. Also, as you
|
|
355 |
don't have a local branch, then you cannot commit locally.
|
|
356 |
||
2374.1.1
by Ian Clatworthy
Help and man page fixes |
357 |
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. |
358 |
master branch. This means that if the master branch is on the same disk or LAN
|
359 |
a lightweight checkout will be faster than a heavyweight one for any commands
|
|
3310.2.1
by James Westby
Fix wording in the checkouts help topic. |
360 |
that modify the revision history (as only one copy of the branch needs to
|
361 |
be updated). Heavyweight checkouts will generally be faster for any command
|
|
362 |
that uses the history but does not change it, but if the master branch is on
|
|
363 |
the same disk then there won't be a noticeable difference.
|
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
364 |
|
365 |
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 |
366 |
containing your branches, where you maintain only one working tree by
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
367 |
switching the master branch that the checkout points to when you want to
|
2245.7.2
by James Westby
Update the checkouts help topic with the comments from Aaron. |
368 |
work on a different branch.
|
369 |
||
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
370 |
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 |
371 |
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. |
372 |
protocol , such as sftp://, and that you have write permissions at the other
|
373 |
end. Checkouts also work on the local file system, so that all that matters is
|
|
374 |
file permissions.
|
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
375 |
|
376 |
You can change the master of a checkout by using the "bind" command (see "help
|
|
377 |
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. |
378 |
command can also be used to turn a branch into a heavy checkout. If you
|
379 |
would like to convert your heavy checkout into a normal branch so that every
|
|
380 |
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. |
381 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
382 |
Related commands::
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
383 |
|
384 |
checkout Create a checkout. Pass --lightweight to get a lightweight
|
|
385 |
checkout
|
|
386 |
update Pull any changes in the master branch in to your checkout
|
|
387 |
commit Make a commit that is sent to the master branch. If you have
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
388 |
a heavy checkout then the --local option will commit to the
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
389 |
checkout without sending the commit to the master
|
390 |
bind Change the master branch that the commits in the checkout will
|
|
391 |
be sent to
|
|
392 |
unbind Turn a heavy checkout into a standalone branch so that any
|
|
393 |
commits are only made locally
|
|
394 |
"""
|
|
395 |
||
2401.2.1
by James Westby
Add a help topic for repositories. |
396 |
_repositories = \ |
397 |
"""Repositories
|
|
398 |
||
2604.2.1
by Robert Collins
(robertc) Introduce a pack command. |
399 |
Repositories in Bazaar are where committed information is stored. There is
|
400 |
a repository associated with every branch.
|
|
401 |
||
402 |
Repositories are a form of database. Bzr will usually maintain this for
|
|
403 |
good performance automatically, but in some situations (e.g. when doing
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
404 |
very many commits in a short time period) you may want to ask bzr to
|
2604.2.1
by Robert Collins
(robertc) Introduce a pack command. |
405 |
optimise the database indices. This can be done by the 'bzr pack' command.
|
406 |
||
407 |
By default just running 'bzr init' will create a repository within the new
|
|
408 |
branch but it is possible to create a shared repository which allows multiple
|
|
409 |
branches to share their information in the same location. When a new branch is
|
|
410 |
created it will first look to see if there is a containing shared repository it
|
|
411 |
can use.
|
|
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
412 |
|
413 |
When two branches of the same project share a repository, there is
|
|
414 |
generally a large space saving. For some operations (e.g. branching
|
|
415 |
within the repository) this translates in to a large time saving.
|
|
2401.2.1
by James Westby
Add a help topic for repositories. |
416 |
|
417 |
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. |
418 |
init-repo). This command takes the location of the repository to create. This
|
419 |
means that 'bzr init-repository repo' will create a directory named 'repo',
|
|
420 |
which contains a shared repository. Any new branches that are created in this
|
|
421 |
directory will then use it for storage.
|
|
2401.2.1
by James Westby
Add a help topic for repositories. |
422 |
|
423 |
It is a good idea to create a repository whenever you might create more
|
|
424 |
than one branch of a project. This is true for both working areas where you
|
|
425 |
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. |
426 |
projects. In the latter case, it is common to want branches without working
|
427 |
trees. Since the files in the branch will not be edited directly there is no
|
|
428 |
need to use up disk space for a working tree. To create a repository in which
|
|
429 |
the branches will not have working trees pass the '--no-trees' option to
|
|
430 |
'init-repository'.
|
|
2401.2.1
by James Westby
Add a help topic for repositories. |
431 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
432 |
Related commands::
|
2401.2.1
by James Westby
Add a help topic for repositories. |
433 |
|
434 |
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. |
435 |
in which new branches won't get a working tree.
|
2401.2.1
by James Westby
Add a help topic for repositories. |
436 |
"""
|
437 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
438 |
|
2401.2.2
by James Westby
Add a working-trees help topic. |
439 |
_working_trees = \ |
440 |
"""Working Trees
|
|
441 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
442 |
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. |
443 |
see the files and edit them. The working tree is where you make changes to a
|
444 |
branch, and when you commit the current state of the working tree is the
|
|
445 |
snapshot that is recorded in the commit.
|
|
446 |
||
2485.1.2
by James Westby
Update with comments from review, thanks to John and Aaron. |
447 |
When you push a branch to a remote system, a working tree will not be
|
448 |
created. If one is already present the files will not be updated. The
|
|
449 |
branch information will be updated and the working tree will be marked
|
|
450 |
as out-of-date. Updating a working tree remotely is difficult, as there
|
|
451 |
may be uncommitted changes or the update may cause content conflicts that are
|
|
452 |
difficult to deal with remotely.
|
|
2401.2.2
by James Westby
Add a working-trees help topic. |
453 |
|
454 |
If you have a branch with no working tree you can use the 'checkout' command
|
|
455 |
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. |
456 |
create the working tree. If the branch is updated remotely, you can update the
|
457 |
working tree by running 'bzr update' in that directory.
|
|
2401.2.2
by James Westby
Add a working-trees help topic. |
458 |
|
459 |
If you have a branch with a working tree that you do not want the 'remove-tree'
|
|
460 |
command will remove the tree if it is safe. This can be done to avoid the
|
|
461 |
warning about the remote working tree not being updated when pushing to the
|
|
462 |
branch. It can also be useful when working with a '--no-trees' repository
|
|
463 |
(see 'bzr help repositories').
|
|
464 |
||
465 |
If you want to have a working tree on a remote machine that you push to you
|
|
466 |
can either run 'bzr update' in the remote branch after each push, or use some
|
|
467 |
other method to update the tree during the push. There is an 'rspush' plugin
|
|
468 |
that will update the working tree using rsync as well as doing a push. There
|
|
469 |
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
|
|
470 |
after each push.
|
|
471 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
472 |
Useful commands::
|
2401.2.2
by James Westby
Add a working-trees help topic. |
473 |
|
474 |
checkout Create a working tree when a branch does not have one.
|
|
475 |
remove-tree Removes the working tree from a branch when it is safe to do so.
|
|
476 |
update When a working tree is out of sync with it's associated branch
|
|
477 |
this will update the tree to match the branch.
|
|
478 |
"""
|
|
479 |
||
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
480 |
|
481 |
_branches = \ |
|
482 |
"""Branches
|
|
483 |
||
484 |
A branch consists of the state of a project, including all of its
|
|
485 |
history. All branches have a repository associated (which is where the
|
|
486 |
branch history is stored), but multiple branches may share the same
|
|
487 |
repository (a shared repository). Branches can be copied and merged.
|
|
488 |
||
489 |
Related commands::
|
|
490 |
||
3535.4.2
by Marius Kruger
Update branches help topic to avoid ambiguity. |
491 |
init Change a directory into a versioned branch.
|
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
492 |
branch Create a new copy of a branch.
|
493 |
merge Perform a three-way merge.
|
|
494 |
"""
|
|
495 |
||
496 |
||
497 |
_standalone_trees = \ |
|
498 |
"""Standalone Trees
|
|
499 |
||
500 |
A standalone tree is a working tree with an associated repository. It
|
|
501 |
is an independently usable branch, with no dependencies on any other.
|
|
502 |
Creating a standalone tree (via bzr init) is the quickest way to put
|
|
503 |
an existing project under version control.
|
|
504 |
||
505 |
Related Commands::
|
|
506 |
||
507 |
init Make a directory into a versioned branch.
|
|
508 |
"""
|
|
509 |
||
510 |
||
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
511 |
_status_flags = \ |
512 |
"""Status Flags
|
|
513 |
||
514 |
Status flags are used to summarise changes to the working tree in a concise
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
515 |
manner. They are in the form::
|
516 |
||
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
517 |
xxx <filename>
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
518 |
|
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
519 |
where the columns' meanings are as follows.
|
520 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
521 |
Column 1 - versioning/renames::
|
522 |
||
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
523 |
+ File versioned
|
524 |
- File unversioned
|
|
525 |
R File renamed
|
|
526 |
? File unknown
|
|
3930.2.10
by Karl Fogel
Two followup changes related to the fix for bug #306394: |
527 |
X File nonexistent (and unknown to bzr)
|
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
528 |
C File has conflicts
|
529 |
P Entry for a pending merge (not a file)
|
|
530 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
531 |
Column 2 - contents::
|
532 |
||
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
533 |
N File created
|
534 |
D File deleted
|
|
535 |
K File kind changed
|
|
536 |
M File modified
|
|
537 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
538 |
Column 3 - execute::
|
539 |
||
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
540 |
* The execute bit was changed
|
541 |
"""
|
|
542 |
||
1551.9.32
by Aaron Bentley
Add global option help |
543 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
544 |
_env_variables = \ |
545 |
"""Environment Variables
|
|
546 |
||
2666.1.5
by Ian Clatworthy
Incorporate feedback from Alex B. & James W. |
547 |
================ =================================================================
|
548 |
BZRPATH Path where bzr is to look for shell plugin external commands.
|
|
549 |
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
|
|
550 |
EMAIL E-Mail address of the user.
|
|
551 |
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
|
|
552 |
EDITOR Editor for editing commit messages.
|
|
553 |
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
|
|
554 |
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
|
|
555 |
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
|
|
2967.2.1
by Rob Weir
Document BZR_REMOTE_PATH in 'bzr help env-variables' |
556 |
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
|
3193.4.1
by Alexander Belchenko
List possible values for BZR_SSH environment variable in env-variables help topic. (#181842) |
557 |
BZR_SSH SSH client: paramiko (default), openssh, ssh, plink.
|
3193.6.5
by Alexander Belchenko
help topic on $BZR_LOG differentiate between *nix and Win32 |
558 |
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
|
559 |
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
|
|
2666.1.5
by Ian Clatworthy
Incorporate feedback from Alex B. & James W. |
560 |
================ =================================================================
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
561 |
"""
|
562 |
||
563 |
||
564 |
_files = \ |
|
2666.1.5
by Ian Clatworthy
Incorporate feedback from Alex B. & James W. |
565 |
r"""Files |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
566 |
|
567 |
:On Linux: ~/.bazaar/bazaar.conf
|
|
568 |
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
|
|
569 |
||
570 |
Contains the user's default configuration. The section ``[DEFAULT]`` is
|
|
571 |
used to define general configuration that will be applied everywhere.
|
|
572 |
The section ``[ALIASES]`` can be used to create command aliases for
|
|
573 |
commonly used options.
|
|
574 |
||
575 |
A typical config file might look something like::
|
|
576 |
||
577 |
[DEFAULT]
|
|
578 |
email=John Doe <jdoe@isp.com>
|
|
579 |
||
580 |
[ALIASES]
|
|
581 |
commit = commit --strict
|
|
582 |
log10 = log --short -r -10..-1
|
|
583 |
"""
|
|
584 |
||
1551.19.11
by Aaron Bentley
Add criss-cross help topic |
585 |
_criss_cross = \ |
3079.1.1
by Alexander Belchenko
topic for criss-cross should have title, otherwise autogenerated bzr_man has problems. |
586 |
"""Criss-Cross
|
587 |
||
1551.19.11
by Aaron Bentley
Add criss-cross help topic |
588 |
A criss-cross in the branch history can cause the default merge technique
|
589 |
to emit more conflicts than would normally be expected.
|
|
590 |
||
3324.3.2
by Martin Pool
criss-cross help: suggest revert/merge |
591 |
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
|
592 |
better results. You may wish to ``bzr revert`` the working tree and merge
|
|
593 |
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
|
|
1551.19.11
by Aaron Bentley
Add criss-cross help topic |
594 |
|
595 |
Criss-crosses occur in a branch's history if two branches merge the same thing
|
|
596 |
and then merge one another, or if two branches merge one another at the same
|
|
597 |
time. They can be avoided by having each branch only merge from or into a
|
|
598 |
designated central branch (a "star topology").
|
|
599 |
||
600 |
Criss-crosses cause problems because of the way merge works. Bazaar's default
|
|
601 |
merge is a three-way merger; in order to merge OTHER into THIS, it must
|
|
602 |
find a basis for comparison, BASE. Using BASE, it can determine whether
|
|
603 |
differences between THIS and OTHER are due to one side adding lines, or
|
|
604 |
from another side removing lines.
|
|
605 |
||
606 |
Criss-crosses mean there is no good choice for a base. Selecting the recent
|
|
607 |
merge points could cause one side's changes to be silently discarded.
|
|
608 |
Selecting older merge points (which Bazaar does) mean that extra conflicts
|
|
609 |
are emitted.
|
|
610 |
||
611 |
The ``weave`` merge type is not affected by this problem because it uses
|
|
1551.19.13
by Aaron Bentley
Update assuming --weave is cheap |
612 |
line-origin detection instead of a basis revision to determine the cause of
|
3324.3.1
by Martin Pool
help criss-cross should suggest using remerge |
613 |
differences.
|
3324.3.2
by Martin Pool
criss-cross help: suggest revert/merge |
614 |
"""
|
1551.19.11
by Aaron Bentley
Add criss-cross help topic |
615 |
|
3338.1.4
by Aaron Bentley
Add sync-for-reconfigure help topic |
616 |
_branches_out_of_sync = """Branches out of sync |
617 |
||
618 |
When reconfiguring a checkout, tree or branch into a lightweight checkout,
|
|
619 |
a local branch must be destroyed. (For checkouts, this is the local branch
|
|
620 |
that serves primarily as a cache.) If the branch-to-be-destroyed does not
|
|
621 |
have the same last revision as the new reference branch for the lightweight
|
|
622 |
checkout, data could be lost, so Bazaar refuses.
|
|
623 |
||
624 |
How you deal with this depends on *why* the branches are out of sync.
|
|
625 |
||
626 |
If you have a checkout and have done local commits, you can get back in sync
|
|
627 |
by running "bzr update" (and possibly "bzr commit").
|
|
628 |
||
629 |
If you have a branch and the remote branch is out-of-date, you can push
|
|
630 |
the local changes using "bzr push". If the local branch is out of date, you
|
|
631 |
can do "bzr pull". If both branches have had changes, you can merge, commit
|
|
632 |
and then push your changes. If you decide that some of the changes aren't
|
|
633 |
useful, you can "push --overwrite" or "pull --overwrite" instead.
|
|
634 |
"""
|
|
635 |
||
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
636 |
|
3892.1.2
by Ian Clatworthy
split formats topic into multiple topics |
637 |
_storage_formats = \ |
638 |
"""Storage Formats
|
|
639 |
||
640 |
To ensure that older clients do not access data incorrectly,
|
|
641 |
Bazaar's policy is to introduce a new storage format whenever
|
|
642 |
new features requiring new metadata are added. New storage
|
|
643 |
formats may also be introduced to improve performance and
|
|
644 |
scalability.
|
|
645 |
||
646 |
Use the following guidelines to select a format (stopping
|
|
647 |
as soon as a condition is true):
|
|
648 |
||
649 |
* If you are working on an existing project, use whatever
|
|
650 |
format that project is using. (Bazaar will do this for you
|
|
651 |
by default).
|
|
652 |
||
653 |
* If you are using bzr-svn to interoperate with a Subversion
|
|
654 |
repository, use 1.9-rich-root.
|
|
655 |
||
656 |
* If you are working on a project with big trees (5000+ paths)
|
|
657 |
or deep history (5000+ revisions), use 1.9.
|
|
658 |
||
659 |
* Otherwise, use the default format - it is good enough for
|
|
660 |
most projects.
|
|
661 |
||
3892.1.4
by Ian Clatworthy
rich-root explanation and improved help for 1.6 and 1.9 formats |
662 |
If some of your developers are unable to use the most recent
|
3892.1.6
by Ian Clatworthy
include feedback from poolie |
663 |
version of Bazaar (due to distro package availability say), be
|
664 |
sure to adjust the guidelines above accordingly. For example,
|
|
665 |
you may need to select 1.6 instead of 1.9 if your project has
|
|
666 |
standardized on Bazaar 1.7.
|
|
3892.1.2
by Ian Clatworthy
split formats topic into multiple topics |
667 |
|
3892.1.4
by Ian Clatworthy
rich-root explanation and improved help for 1.6 and 1.9 formats |
668 |
Note: Many of the currently supported formats have two variants:
|
669 |
a plain one and a rich-root one. The latter include an additional
|
|
670 |
field about the root of the tree. There is no performance cost
|
|
671 |
for using a rich-root format but you cannot easily merge changes
|
|
672 |
from a rich-root format into a plain format. As a consequence,
|
|
673 |
moving a project to a rich-root format takes some co-ordination
|
|
674 |
in that all contributors need to upgrade their repositories
|
|
3892.1.5
by Ian Clatworthy
minor tweak to rich-root explanation |
675 |
around the same time. (It is for this reason that we have delayed
|
3892.1.4
by Ian Clatworthy
rich-root explanation and improved help for 1.6 and 1.9 formats |
676 |
making a rich-root format the default so far, though we will do
|
3892.1.5
by Ian Clatworthy
minor tweak to rich-root explanation |
677 |
so at some appropriate time in the future.)
|
3892.1.4
by Ian Clatworthy
rich-root explanation and improved help for 1.6 and 1.9 formats |
678 |
|
3892.1.2
by Ian Clatworthy
split formats topic into multiple topics |
679 |
See ``bzr help current-formats`` for the complete list of
|
680 |
currently supported formats. See ``bzr help other-formats`` for
|
|
681 |
descriptions of any available experimental and deprecated formats.
|
|
682 |
"""
|
|
683 |
||
684 |
||
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
685 |
# Register help topics
|
2070.4.13
by John Arbash Meinel
Switch help_topics to use a Registry. |
686 |
topic_registry.register("revisionspec", _help_on_revisionspec, |
687 |
"Explain how to use --revision") |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
688 |
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN) |
689 |
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN) |
|
3892.1.2
by Ian Clatworthy
split formats topic into multiple topics |
690 |
def get_current_formats_topic(topic): |
691 |
from bzrlib import bzrdir |
|
692 |
return "Current Storage Formats\n\n" + \ |
|
693 |
bzrdir.format_registry.help_topic(topic) |
|
694 |
def get_other_formats_topic(topic): |
|
695 |
from bzrlib import bzrdir |
|
696 |
return "Other Storage Formats\n\n" + \ |
|
697 |
bzrdir.format_registry.help_topic(topic) |
|
698 |
topic_registry.register('current-formats', get_current_formats_topic, |
|
699 |
'Current storage formats') |
|
700 |
topic_registry.register('other-formats', get_other_formats_topic, |
|
701 |
'Experimental and deprecated storage formats') |
|
2768.1.1
by Ian Clatworthy
Document standard options |
702 |
topic_registry.register('standard-options', _standard_options, |
703 |
'Options that can be used with any command') |
|
1551.9.34
by Aaron Bentley
Fix NEWS and whitespace |
704 |
topic_registry.register('global-options', _global_options, |
2768.1.14
by Ian Clatworthy
Incorporate feedback from poolie |
705 |
'Options that control how Bazaar runs') |
2241.2.8
by ghigo
- rename transport urlspec |
706 |
topic_registry.register('urlspec', _help_on_transport, |
2241.2.5
by ghigo
add the topics transport |
707 |
"Supported transport protocols") |
2520.1.1
by Daniel Watkins
Added 'help status-flags'. |
708 |
topic_registry.register('status-flags', _status_flags, |
709 |
"Help on status flags") |
|
2376.4.36
by Jonathan Lange
Provide really basic help topic for our bug tracker support. |
710 |
def get_bugs_topic(topic): |
711 |
from bzrlib import bugtracker |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
712 |
return ("Bug Tracker Settings\n\n" + |
3154.1.1
by Ian Clatworthy
Minor tweaks to bug tracker integration documentation |
713 |
bugtracker.tracker_registry.help_topic(topic)) |
3053.8.1
by Ian Clatworthy
Improve bug tracker integration documentation (Ian Clatworthy) |
714 |
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings') |
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
715 |
topic_registry.register('env-variables', _env_variables, |
716 |
'Environment variable names and values') |
|
717 |
topic_registry.register('files', _files, |
|
718 |
'Information on configuration and log files') |
|
4119.3.2
by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure. |
719 |
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text', |
720 |
'Points at which custom processing can be added') |
|
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
721 |
|
4119.3.2
by Robert Collins
Migrate existing hooks over to the new HookPoint infrastructure. |
722 |
# Load some of the help topics from files. Note that topics which reproduce API
|
723 |
# details will tend to skew (quickly usually!) so please seek other solutions
|
|
724 |
# for such things.
|
|
3089.3.1
by Ian Clatworthy
move reference material out of User Guide into User Reference |
725 |
topic_registry.register('authentication', _load_from_file, |
726 |
'Information on configuring authentication') |
|
727 |
topic_registry.register('configuration', _load_from_file, |
|
728 |
'Details on the configuration settings available') |
|
729 |
topic_registry.register('conflicts', _load_from_file, |
|
730 |
'Types of conflicts and what to do about them') |
|
4110.2.7
by Martin Pool
Split debug flags into their own help topic |
731 |
topic_registry.register('debug-flags', _load_from_file, |
732 |
'Options to show or record debug information') |
|
3974.1.4
by Ian Clatworthy
log-formats topic and explained range searching |
733 |
topic_registry.register('log-formats', _load_from_file, |
734 |
'Details on the logging formats available') |
|
3089.3.1
by Ian Clatworthy
move reference material out of User Guide into User Reference |
735 |
|
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
736 |
|
737 |
# Register concept topics.
|
|
738 |
# Note that we might choose to remove these from the online help in the
|
|
739 |
# future or implement them via loading content from files. In the meantime,
|
|
740 |
# please keep them concise.
|
|
741 |
topic_registry.register('branches', _branches, |
|
742 |
'Information on what a branch is', SECT_CONCEPT) |
|
743 |
topic_registry.register('checkouts', _checkouts, |
|
744 |
'Information on what a checkout is', SECT_CONCEPT) |
|
3368.2.17
by Ian Clatworthy
add content-filters help topic |
745 |
topic_registry.register('content-filters', _load_from_file, |
746 |
'Conversion of content into/from working trees', |
|
747 |
SECT_CONCEPT) |
|
3892.1.2
by Ian Clatworthy
split formats topic into multiple topics |
748 |
topic_registry.register('formats', _storage_formats, |
749 |
'Information on choosing a storage format', |
|
750 |
SECT_CONCEPT) |
|
3398.1.26
by Ian Clatworthy
jam feedback - make patterns a separate help topic |
751 |
topic_registry.register('patterns', _load_from_file, |
752 |
'Information on the pattern syntax', |
|
753 |
SECT_CONCEPT) |
|
2401.2.1
by James Westby
Add a help topic for repositories. |
754 |
topic_registry.register('repositories', _repositories, |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
755 |
'Basic information on shared repositories.', |
756 |
SECT_CONCEPT) |
|
3398.1.20
by Ian Clatworthy
add rules help topic |
757 |
topic_registry.register('rules', _load_from_file, |
758 |
'Information on defining rule-based preferences', |
|
759 |
SECT_CONCEPT) |
|
2804.2.1
by Ian Clatworthy
add branches and standalone-trees as help topics |
760 |
topic_registry.register('standalone-trees', _standalone_trees, |
761 |
'Information on what a standalone tree is', |
|
762 |
SECT_CONCEPT) |
|
2401.2.2
by James Westby
Add a working-trees help topic. |
763 |
topic_registry.register('working-trees', _working_trees, |
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
764 |
'Information on working trees', SECT_CONCEPT) |
1551.19.11
by Aaron Bentley
Add criss-cross help topic |
765 |
topic_registry.register('criss-cross', _criss_cross, |
766 |
'Information on criss-cross merging', SECT_CONCEPT) |
|
3338.1.4
by Aaron Bentley
Add sync-for-reconfigure help topic |
767 |
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync, |
3723.2.1
by John Arbash Meinel
Fix bug #270471 by updating the topic string for 'sync-for-reconfigure' |
768 |
'Steps to resolve "out-of-sync" when reconfiguring', |
769 |
SECT_CONCEPT) |
|
2245.7.1
by James Westby
Add a help topic describing checkouts and how they work. |
770 |
|
2432.1.1
by Robert Collins
Add a HelpTopicContext object. |
771 |
|
2432.1.15
by Robert Collins
Rename Context (in bzrlib.help) to Index, for a clearer name. |
772 |
class HelpTopicIndex(object): |
773 |
"""A index for bzr help that returns topics."""
|
|
2432.1.8
by Robert Collins
HelpTopicContext now returns RegisteredTopic objects for get_topics calls. |
774 |
|
2432.1.17
by Robert Collins
Add prefixes to HelpIndexes. |
775 |
def __init__(self): |
776 |
self.prefix = '' |
|
777 |
||
2432.1.8
by Robert Collins
HelpTopicContext now returns RegisteredTopic objects for get_topics calls. |
778 |
def get_topics(self, topic): |
779 |
"""Search for topic in the HelpTopicRegistry.
|
|
780 |
||
781 |
:param topic: A topic to search for. None is treated as 'basic'.
|
|
782 |
:return: A list which is either empty or contains a single
|
|
783 |
RegisteredTopic entry.
|
|
784 |
"""
|
|
785 |
if topic is None: |
|
786 |
topic = 'basic' |
|
787 |
if topic in topic_registry: |
|
788 |
return [RegisteredTopic(topic)] |
|
789 |
else: |
|
790 |
return [] |
|
791 |
||
792 |
||
793 |
class RegisteredTopic(object): |
|
794 |
"""A help topic which has been registered in the HelpTopicRegistry.
|
|
795 |
||
796 |
These topics consist of nothing more than the name of the topic - all
|
|
797 |
data is retrieved on demand from the registry.
|
|
798 |
"""
|
|
799 |
||
800 |
def __init__(self, topic): |
|
801 |
"""Constructor.
|
|
802 |
||
803 |
:param topic: The name of the topic that this represents.
|
|
804 |
"""
|
|
805 |
self.topic = topic |
|
2432.1.10
by Robert Collins
Add get_help_text() to RegisteredTopic to get the help as a string. |
806 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
807 |
def get_help_text(self, additional_see_also=None, plain=True): |
2432.1.22
by Robert Collins
Teach RegisteredTopic to support the additional_see_also list of related help terms. |
808 |
"""Return a string with the help for this topic.
|
809 |
||
810 |
:param additional_see_also: Additional help topics to be
|
|
811 |
cross-referenced.
|
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
812 |
:param plain: if False, raw help (reStructuredText) is
|
813 |
returned instead of plain text.
|
|
2432.1.22
by Robert Collins
Teach RegisteredTopic to support the additional_see_also list of related help terms. |
814 |
"""
|
815 |
result = topic_registry.get_detail(self.topic) |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
816 |
# there is code duplicated here and in bzrlib/plugin.py's
|
2432.1.25
by Robert Collins
Return plugin module docstrings for 'bzr help plugin'. |
817 |
# matching Topic code. This should probably be factored in
|
818 |
# 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. |
819 |
if additional_see_also is not None: |
820 |
see_also = sorted(set(additional_see_also)) |
|
821 |
else: |
|
822 |
see_also = None |
|
823 |
if see_also: |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
824 |
result += '\n:See also: ' |
2432.1.22
by Robert Collins
Teach RegisteredTopic to support the additional_see_also list of related help terms. |
825 |
result += ', '.join(see_also) |
826 |
result += '\n' |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
827 |
if plain: |
828 |
result = help_as_plain_text(result) |
|
2432.1.22
by Robert Collins
Teach RegisteredTopic to support the additional_see_also list of related help terms. |
829 |
return result |
2432.1.27
by Robert Collins
Add a get_help_topic method to RegisteredTopic. |
830 |
|
831 |
def get_help_topic(self): |
|
832 |
"""Return the help topic this can be found under."""
|
|
833 |
return self.topic |
|
2485.1.1
by James Westby
Update the help topics to the latest bzr.dev. |
834 |
|
2666.1.1
by Ian Clatworthy
Bazaar User Reference generated from online help |
835 |
|
836 |
def help_as_plain_text(text): |
|
837 |
"""Minimal converter of reStructuredText to plain text."""
|
|
838 |
lines = text.splitlines() |
|
839 |
result = [] |
|
840 |
for line in lines: |
|
841 |
if line.startswith(':'): |
|
842 |
line = line[1:] |
|
843 |
elif line.endswith('::'): |
|
844 |
line = line[:-1] |
|
845 |
result.append(line) |
|
846 |
return "\n".join(result) + "\n" |