13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
"""A collection of extra help information for using bzr.
134
128
return ''.join(out)
137
def _load_from_file(topic_name):
138
"""Load help from a file.
140
Topics are expected to be txt files in bzrlib.help_topics.
142
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
143
return osutils.resource_string('bzrlib.help_topics', resource_name)
146
131
def _help_on_revisionspec(name):
147
132
"""Generate the help for revision specs."""
149
134
import bzrlib.revisionspec
153
"""Revision Identifiers
155
A revision identifier refers to a specific state of a branch's history. It
156
can be expressed in several ways. It can begin with a keyword to
157
unambiguously specify a given lookup type; some examples are 'last:1',
158
'before:yesterday' and 'submit:'.
160
Alternately, it can be given without a keyword, in which case it will be
161
checked as a revision number, a tag, a revision id, a date specification, or a
162
branch specification, in that order. For example, 'date:today' could be
163
written as simply 'today', though if you have a tag called 'today' that will
166
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
167
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
168
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
169
spaces around the '..').
171
Ranges are interpreted differently by different commands. To the "log" command,
172
a range is a sequence of log messages, but to the "diff" command, the range
173
denotes a change between revisions (and not a sequence of changes). In
174
addition, "log" considers a closed range whereas "diff" and "merge" consider it
175
to be open-ended, that is, they include one end but not the other. For example:
176
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
177
while "bzr diff -r 3647..3649" includes the changes done in revisions 3648 and
180
The keywords used as revision selection methods are the following:
137
out.append("Revision Identifiers\n")
138
out.append("A revision, or a range bound, can be one of the following.\n")
183
details.append("\nIn addition, plugins can provide other keywords.")
184
details.append("\nA detailed description of each keyword is given below.\n")
140
details.append("\nFurther details are given below.\n")
186
142
# The help text is indented 4 spaces - this re cleans that up below
187
143
indent_re = re.compile(r'^ ', re.MULTILINE)
188
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
144
for i in bzrlib.revisionspec.SPEC_TYPES:
190
146
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
215
171
def add_string(proto, help, maxl, prefix_width=20):
216
help_lines = textwrap.wrap(help, maxl - prefix_width,
217
break_long_words=False)
172
help_lines = textwrap.wrap(help, maxl - prefix_width)
218
173
line_with_indent = '\n' + ' ' * prefix_width
219
174
help_text = line_with_indent.join(help_lines)
220
175
return "%-20s%s\n" % (proto, help_text)
251
206
out += "\nSupported modifiers::\n\n " + \
255
\nBazaar supports all of the standard parts within the URL::
257
<protocol>://[user[:password]@]host[:port]/[path]
259
allowing URLs such as::
261
http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
263
For bzr+ssh:// and sftp:// URLs, Bazaar also supports paths that begin
264
with '~' as meaning that the rest of the path should be interpreted
265
relative to the remote user's home directory. For example if the user
266
``remote`` has a home directory of ``/home/remote`` on the server
267
shell.example.com, then::
269
bzr+ssh://remote@shell.example.com/~/myproject/trunk
271
would refer to ``/home/remote/myproject/trunk``.
273
Many commands that accept URLs also accept location aliases too. See
274
::doc:`location-alias-help`.
281
"""Bazaar %s -- a free distributed version-control tool
282
http://www.bazaar.canonical.com/
213
"""Bazaar -- a free distributed version-control tool
214
http://bazaar-vcs.org/
285
217
bzr init makes this directory a versioned branch
302
233
bzr help init more help on e.g. init command
303
234
bzr help commands list all commands
304
235
bzr help topics list all help topics
305
""" % bzrlib.__version__
308
239
_global_options = \
309
240
"""Global Options
311
242
These options may be used with any command, and may appear in front of any
312
command. (e.g. ``bzr --profile help``).
243
command. (e.g. "bzr --profile help").
314
245
--version Print the version number. Must be supplied before the command.
315
246
--no-aliases Do not process command aliases when running this command.
316
247
--builtin Use the built-in version of a command, not the plugin version.
317
248
This does not suppress other plugin effects.
318
249
--no-plugins Do not process any plugins.
319
--concurrency Number of processes that can be run concurrently (selftest).
321
251
--profile Profile execution using the hotshot profiler.
322
252
--lsprof Profile execution using the lsprof profiler.
326
256
"callgrind.out" or end with ".callgrind", the output will be
327
257
formatted for use with KCacheGrind. Otherwise, the output
328
258
will be a pickle.
329
--coverage Generate line coverage report in the specified directory.
331
See http://doc.bazaar.canonical.com/developers/profiling.html for more
332
information on profiling.
260
See doc/developers/profiling.txt for more information on profiling.
334
261
A number of debug flags are also available to assist troubleshooting and
335
development. See :doc:`debug-flags-help`.
264
-Dauth Trace authentication sections used.
265
-Derror Instead of normal error handling, always print a traceback on
267
-Devil Capture call sites that do expensive or badly-scaling
269
-Dhashcache Log every time a working file is read to determine its hash.
270
-Dhooks Trace hook execution.
271
-Dhttp Trace http connections, requests and responses
272
-Dhpss Trace smart protocol requests and responses.
273
-Dindex Trace major index operations.
274
-Dlock Trace when lockdir locks are taken or released.
275
-Dmerge Emit information for debugging merges.
338
278
_standard_options = \
339
279
"""Standard Options
341
281
Standard options are legal for all commands.
343
283
--help, -h Show help message.
344
284
--verbose, -v Display more information.
345
285
--quiet, -q Only display errors and warnings.
390
330
Lightweight checkouts work best when you have fast reliable access to the
391
331
master branch. This means that if the master branch is on the same disk or LAN
392
332
a lightweight checkout will be faster than a heavyweight one for any commands
393
that modify the revision history (as only one copy of the branch needs to
394
be updated). Heavyweight checkouts will generally be faster for any command
395
that uses the history but does not change it, but if the master branch is on
396
the same disk then there won't be a noticeable difference.
333
that modify the revision history (as only one copy branch needs to be updated).
334
Heavyweight checkouts will generally be faster for any command that uses the
335
history but does not change it, but if the master branch is on the same disk
336
then there wont be a noticeable difference.
398
338
Another possible use for a checkout is to use it with a treeless repository
399
339
containing your branches, where you maintain only one working tree by
400
switching the master branch that the checkout points to when you want to
340
switching the master branch that the checkout points to when you want to
401
341
work on a different branch.
403
343
Obviously to commit on a checkout you need to be able to write to the master
406
346
end. Checkouts also work on the local file system, so that all that matters is
407
347
file permissions.
409
You can change the master of a checkout by using the "switch" command (see
410
"help switch"). This will change the location that the commits are sent to.
411
The "bind" command can also be used to turn a normal branch into a heavy
412
checkout. If you would like to convert your heavy checkout into a normal
413
branch so that every commit is local, you can use the "unbind" command. To see
414
whether or not a branch is bound or not you can use the "info" command. If the
415
branch is bound it will tell you the location of the bound branch.
349
You can change the master of a checkout by using the "bind" command (see "help
350
bind"). This will change the location that the commits are sent to. The bind
351
command can also be used to turn a branch into a heavy checkout. If you
352
would like to convert your heavy checkout into a normal branch so that every
353
commit is local, you can use the "unbind" command.
417
355
Related commands::
421
359
update Pull any changes in the master branch in to your checkout
422
360
commit Make a commit that is sent to the master branch. If you have
423
a heavy checkout then the --local option will commit to the
361
a heavy checkout then the --local option will commit to the
424
362
checkout without sending the commit to the master
425
switch Change the master branch that the commits in the checkout will
363
bind Change the master branch that the commits in the checkout will
427
bind Turn a standalone branch into a heavy checkout so that any
428
commits will be sent to the master branch
429
365
unbind Turn a heavy checkout into a standalone branch so that any
430
366
commits are only made locally
431
info Displays whether a branch is bound or unbound. If the branch is
432
bound, then it will also display the location of the bound branch
435
369
_repositories = \
441
375
Repositories are a form of database. Bzr will usually maintain this for
442
376
good performance automatically, but in some situations (e.g. when doing
443
very many commits in a short time period) you may want to ask bzr to
377
very many commits in a short time period) you may want to ask bzr to
444
378
optimise the database indices. This can be done by the 'bzr pack' command.
446
380
By default just running 'bzr init' will create a repository within the new
525
459
branch history is stored), but multiple branches may share the same
526
460
repository (a shared repository). Branches can be copied and merged.
528
In addition, one branch may be bound to another one. Binding to another
529
branch indicates that commits which happen in this branch must also
530
happen in the other branch. Bazaar ensures consistency by not allowing
531
commits when the two branches are out of date. In order for a commit
532
to succeed, it may be necessary to update the current branch using
535
462
Related commands::
537
init Change a directory into a versioned branch.
538
branch Create a new branch that is a copy of an existing branch.
464
init Make a directory into a versioned branch.
465
branch Create a new copy of a branch.
539
466
merge Perform a three-way merge.
540
bind Bind a branch to another one.
591
516
_env_variables = \
592
517
"""Environment Variables
594
=================== =======================================================================
595
BZRPATH Path where bzr is to look for shell plugin external commands.
596
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
597
EMAIL E-Mail address of the user.
598
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
599
EDITOR Editor for editing commit messages.
600
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
601
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
602
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
603
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
604
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
605
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
606
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
607
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
608
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
609
BZR_COLUMNS Override implicit terminal width.
610
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest).
611
BZR_PROGRESS_BAR Override the progress display. Values are 'none', 'dots', or 'tty'.
612
BZR_PDB Control whether to launch a debugger on error.
613
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a breakin debugger.
614
=================== =======================================================================
519
================ =================================================================
520
BZRPATH Path where bzr is to look for shell plugin external commands.
521
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
522
EMAIL E-Mail address of the user.
523
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
524
EDITOR Editor for editing commit messages.
525
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
526
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
527
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
528
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
529
================ =================================================================
642
557
A criss-cross in the branch history can cause the default merge technique
643
558
to emit more conflicts than would normally be expected.
645
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
646
better results. You may wish to ``bzr revert`` the working tree and merge
647
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
560
If you encounter criss-crosses, you can use merge --weave instead, which
561
should provide a much better result.
649
563
Criss-crosses occur in a branch's history if two branches merge the same thing
650
564
and then merge one another, or if two branches merge one another at the same
665
579
The ``weave`` merge type is not affected by this problem because it uses
666
580
line-origin detection instead of a basis revision to determine the cause of
670
_branches_out_of_sync = """Branches Out of Sync
672
When reconfiguring a checkout, tree or branch into a lightweight checkout,
673
a local branch must be destroyed. (For checkouts, this is the local branch
674
that serves primarily as a cache.) If the branch-to-be-destroyed does not
675
have the same last revision as the new reference branch for the lightweight
676
checkout, data could be lost, so Bazaar refuses.
678
How you deal with this depends on *why* the branches are out of sync.
680
If you have a checkout and have done local commits, you can get back in sync
681
by running "bzr update" (and possibly "bzr commit").
683
If you have a branch and the remote branch is out-of-date, you can push
684
the local changes using "bzr push". If the local branch is out of date, you
685
can do "bzr pull". If both branches have had changes, you can merge, commit
686
and then push your changes. If you decide that some of the changes aren't
687
useful, you can "push --overwrite" or "pull --overwrite" instead.
694
To ensure that older clients do not access data incorrectly,
695
Bazaar's policy is to introduce a new storage format whenever
696
new features requiring new metadata are added. New storage
697
formats may also be introduced to improve performance and
700
The newest format, 2a, is highly recommended. If your
701
project is not using 2a, then you should suggest to the
702
project owner to upgrade.
707
Some of the older formats have two variants:
708
a plain one and a rich-root one. The latter include an additional
709
field about the root of the tree. There is no performance cost
710
for using a rich-root format but you cannot easily merge changes
711
from a rich-root format into a plain format. As a consequence,
712
moving a project to a rich-root format takes some co-ordination
713
in that all contributors need to upgrade their repositories
714
around the same time. 2a and all future formats will be
715
implicitly rich-root.
717
See :doc:`current-formats-help` for the complete list of
718
currently supported formats. See :doc:`other-formats-help` for
719
descriptions of any available experimental and deprecated formats.
723
584
# Register help topics
725
586
"Explain how to use --revision")
726
587
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
727
588
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
728
def get_current_formats_topic(topic):
729
from bzrlib import bzrdir
730
return "Current Storage Formats\n\n" + \
731
bzrdir.format_registry.help_topic(topic)
732
def get_other_formats_topic(topic):
733
from bzrlib import bzrdir
734
return "Other Storage Formats\n\n" + \
735
bzrdir.format_registry.help_topic(topic)
736
topic_registry.register('current-formats', get_current_formats_topic,
737
'Current storage formats')
738
topic_registry.register('other-formats', get_other_formats_topic,
739
'Experimental and deprecated storage formats')
589
def get_format_topic(topic):
590
from bzrlib import bzrdir
591
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
592
topic_registry.register('formats', get_format_topic, 'Directory formats')
740
593
topic_registry.register('standard-options', _standard_options,
741
594
'Options that can be used with any command')
742
595
topic_registry.register('global-options', _global_options,
747
600
"Help on status flags")
748
601
def get_bugs_topic(topic):
749
602
from bzrlib import bugtracker
750
return ("Bug Tracker Settings\n\n" +
751
bugtracker.tracker_registry.help_topic(topic))
603
return "Bug Tracker Settings\n\n" + \
604
bugtracker.tracker_registry.help_topic(topic)
752
605
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
753
606
topic_registry.register('env-variables', _env_variables,
754
607
'Environment variable names and values')
755
608
topic_registry.register('files', _files,
756
609
'Information on configuration and log files')
757
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
758
'Points at which custom processing can be added')
760
# Load some of the help topics from files. Note that topics which reproduce API
761
# details will tend to skew (quickly usually!) so please seek other solutions
763
topic_registry.register('authentication', _load_from_file,
764
'Information on configuring authentication')
765
topic_registry.register('configuration', _load_from_file,
766
'Details on the configuration settings available')
767
topic_registry.register('conflict-types', _load_from_file,
768
'Types of conflicts and what to do about them')
769
topic_registry.register('debug-flags', _load_from_file,
770
'Options to show or record debug information')
771
topic_registry.register('location-alias', _load_from_file,
772
'Aliases for remembered locations')
773
topic_registry.register('log-formats', _load_from_file,
774
'Details on the logging formats available')
777
612
# Register concept topics.
782
617
'Information on what a branch is', SECT_CONCEPT)
783
618
topic_registry.register('checkouts', _checkouts,
784
619
'Information on what a checkout is', SECT_CONCEPT)
785
topic_registry.register('content-filters', _load_from_file,
786
'Conversion of content into/from working trees',
788
topic_registry.register('diverged-branches', _load_from_file,
789
'How to fix diverged branches',
791
topic_registry.register('eol', _load_from_file,
792
'Information on end-of-line handling',
794
topic_registry.register('formats', _storage_formats,
795
'Information on choosing a storage format',
797
topic_registry.register('patterns', _load_from_file,
798
'Information on the pattern syntax',
800
620
topic_registry.register('repositories', _repositories,
801
621
'Basic information on shared repositories.',
803
topic_registry.register('rules', _load_from_file,
804
'Information on defining rule-based preferences',
806
623
topic_registry.register('standalone-trees', _standalone_trees,
807
624
'Information on what a standalone tree is',
810
627
'Information on working trees', SECT_CONCEPT)
811
628
topic_registry.register('criss-cross', _criss_cross,
812
629
'Information on criss-cross merging', SECT_CONCEPT)
813
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
814
'Steps to resolve "out-of-sync" when reconfiguring',
818
632
class HelpTopicIndex(object):
859
673
returned instead of plain text.
861
675
result = topic_registry.get_detail(self.topic)
862
# there is code duplicated here and in bzrlib/plugin.py's
676
# there is code duplicated here and in bzrlib/plugin.py's
863
677
# matching Topic code. This should probably be factored in
864
678
# to a helper function and a common base class.
865
679
if additional_see_also is not None:
added
removed
bzrlib/help_topics.py
