255
131
"""Global Options
257
133
These options may be used with any command, and may appear in front of any
258
command. (e.g. "bzr --profile help").
260
--version Print the version number. Must be supplied before the command.
261
--no-aliases Do not process command aliases when running this command.
134
command. (e.g. "bzr --quiet help").
136
--quiet Suppress informational output; only print errors and warnings
137
--version Print the version number
139
--no-aliases Do not process command aliases when running this command
262
140
--builtin Use the built-in version of a command, not the plugin version.
263
This does not suppress other plugin effects.
264
--no-plugins Do not process any plugins.
141
This does not suppress other plugin effects
142
--no-plugins Do not process any plugins
266
--profile Profile execution using the hotshot profiler.
267
--lsprof Profile execution using the lsprof profiler.
144
--Derror Instead of normal error handling, always print a traceback on
146
--profile Profile execution using the hotshot profiler
147
--lsprof Profile execution using the lsprof profiler
268
148
--lsprof-file Profile execution using the lsprof profiler, and write the
269
results to a specified file. If the filename ends with ".txt",
270
text format will be used. If the filename either starts with
271
"callgrind.out" or end with ".callgrind", the output will be
272
formatted for use with KCacheGrind. Otherwise, the output
274
--coverage Generate line coverage report in the specified directory.
276
See doc/developers/profiling.txt for more information on profiling.
277
A number of debug flags are also available to assist troubleshooting and
280
-Dauth Trace authentication sections used.
281
-Derror Instead of normal error handling, always print a traceback on
283
-Devil Capture call sites that do expensive or badly-scaling
285
-Dfetch Trace history copying between repositories.
286
-Dhashcache Log every time a working file is read to determine its hash.
287
-Dhooks Trace hook execution.
288
-Dhpss Trace smart protocol requests and responses.
289
-Dhttp Trace http connections, requests and responses
290
-Dindex Trace major index operations.
291
-Dknit Trace knit operations.
292
-Dlock Trace when lockdir locks are taken or released.
293
-Dmerge Emit information for debugging merges.
294
-Dpack Emit information about pack operations.
297
_standard_options = \
300
Standard options are legal for all commands.
302
--help, -h Show help message.
303
--verbose, -v Display more information.
304
--quiet, -q Only display errors and warnings.
306
Unlike global options, standard options can be used in aliases.
313
Checkouts are source trees that are connected to a branch, so that when
314
you commit in the source tree, the commit goes into that branch. They
315
allow you to use a simpler, more centralized workflow, ignoring some of
316
Bazaar's decentralized features until you want them. Using checkouts
317
with shared repositories is very similar to working with SVN or CVS, but
318
doesn't have the same restrictions. And using checkouts still allows
319
others working on the project to use whatever workflow they like.
321
A checkout is created with the bzr checkout command (see "help checkout").
322
You pass it a reference to another branch, and it will create a local copy
323
for you that still contains a reference to the branch you created the
324
checkout from (the master branch). Then if you make any commits they will be
325
made on the other branch first. This creates an instant mirror of your work, or
326
facilitates lockstep development, where each developer is working together,
327
continuously integrating the changes of others.
329
However the checkout is still a first class branch in Bazaar terms, so that
330
you have the full history locally. As you have a first class branch you can
331
also commit locally if you want, for instance due to the temporary loss af a
332
network connection. Use the --local option to commit to do this. All the local
333
commits will then be made on the master branch the next time you do a non-local
336
If you are using a checkout from a shared branch you will periodically want to
337
pull in all the changes made by others. This is done using the "update"
338
command. The changes need to be applied before any non-local commit, but
339
Bazaar will tell you if there are any changes and suggest that you use this
342
It is also possible to create a "lightweight" checkout by passing the
343
--lightweight flag to checkout. A lightweight checkout is even closer to an
344
SVN checkout in that it is not a first class branch, it mainly consists of the
345
working tree. This means that any history operations must query the master
346
branch, which could be slow if a network connection is involved. Also, as you
347
don't have a local branch, then you cannot commit locally.
349
Lightweight checkouts work best when you have fast reliable access to the
350
master branch. This means that if the master branch is on the same disk or LAN
351
a lightweight checkout will be faster than a heavyweight one for any commands
352
that modify the revision history (as only one copy branch needs to be updated).
353
Heavyweight checkouts will generally be faster for any command that uses the
354
history but does not change it, but if the master branch is on the same disk
355
then there wont be a noticeable difference.
357
Another possible use for a checkout is to use it with a treeless repository
358
containing your branches, where you maintain only one working tree by
359
switching the master branch that the checkout points to when you want to
360
work on a different branch.
362
Obviously to commit on a checkout you need to be able to write to the master
363
branch. This means that the master branch must be accessible over a writeable
364
protocol , such as sftp://, and that you have write permissions at the other
365
end. Checkouts also work on the local file system, so that all that matters is
368
You can change the master of a checkout by using the "bind" command (see "help
369
bind"). This will change the location that the commits are sent to. The bind
370
command can also be used to turn a branch into a heavy checkout. If you
371
would like to convert your heavy checkout into a normal branch so that every
372
commit is local, you can use the "unbind" command.
376
checkout Create a checkout. Pass --lightweight to get a lightweight
378
update Pull any changes in the master branch in to your checkout
379
commit Make a commit that is sent to the master branch. If you have
380
a heavy checkout then the --local option will commit to the
381
checkout without sending the commit to the master
382
bind Change the master branch that the commits in the checkout will
384
unbind Turn a heavy checkout into a standalone branch so that any
385
commits are only made locally
391
Repositories in Bazaar are where committed information is stored. There is
392
a repository associated with every branch.
394
Repositories are a form of database. Bzr will usually maintain this for
395
good performance automatically, but in some situations (e.g. when doing
396
very many commits in a short time period) you may want to ask bzr to
397
optimise the database indices. This can be done by the 'bzr pack' command.
399
By default just running 'bzr init' will create a repository within the new
400
branch but it is possible to create a shared repository which allows multiple
401
branches to share their information in the same location. When a new branch is
402
created it will first look to see if there is a containing shared repository it
405
When two branches of the same project share a repository, there is
406
generally a large space saving. For some operations (e.g. branching
407
within the repository) this translates in to a large time saving.
409
To create a shared repository use the init-repository command (or the alias
410
init-repo). This command takes the location of the repository to create. This
411
means that 'bzr init-repository repo' will create a directory named 'repo',
412
which contains a shared repository. Any new branches that are created in this
413
directory will then use it for storage.
415
It is a good idea to create a repository whenever you might create more
416
than one branch of a project. This is true for both working areas where you
417
are doing the development, and any server areas that you use for hosting
418
projects. In the latter case, it is common to want branches without working
419
trees. Since the files in the branch will not be edited directly there is no
420
need to use up disk space for a working tree. To create a repository in which
421
the branches will not have working trees pass the '--no-trees' option to
426
init-repository Create a shared repository. Use --no-trees to create one
427
in which new branches won't get a working tree.
434
A working tree is the contents of a branch placed on disk so that you can
435
see the files and edit them. The working tree is where you make changes to a
436
branch, and when you commit the current state of the working tree is the
437
snapshot that is recorded in the commit.
439
When you push a branch to a remote system, a working tree will not be
440
created. If one is already present the files will not be updated. The
441
branch information will be updated and the working tree will be marked
442
as out-of-date. Updating a working tree remotely is difficult, as there
443
may be uncommitted changes or the update may cause content conflicts that are
444
difficult to deal with remotely.
446
If you have a branch with no working tree you can use the 'checkout' command
447
to create a working tree. If you run 'bzr checkout .' from the branch it will
448
create the working tree. If the branch is updated remotely, you can update the
449
working tree by running 'bzr update' in that directory.
451
If you have a branch with a working tree that you do not want the 'remove-tree'
452
command will remove the tree if it is safe. This can be done to avoid the
453
warning about the remote working tree not being updated when pushing to the
454
branch. It can also be useful when working with a '--no-trees' repository
455
(see 'bzr help repositories').
457
If you want to have a working tree on a remote machine that you push to you
458
can either run 'bzr update' in the remote branch after each push, or use some
459
other method to update the tree during the push. There is an 'rspush' plugin
460
that will update the working tree using rsync as well as doing a push. There
461
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
466
checkout Create a working tree when a branch does not have one.
467
remove-tree Removes the working tree from a branch when it is safe to do so.
468
update When a working tree is out of sync with it's associated branch
469
this will update the tree to match the branch.
476
A branch consists of the state of a project, including all of its
477
history. All branches have a repository associated (which is where the
478
branch history is stored), but multiple branches may share the same
479
repository (a shared repository). Branches can be copied and merged.
483
init Make a directory into a versioned branch.
484
branch Create a new copy of a branch.
485
merge Perform a three-way merge.
489
_standalone_trees = \
492
A standalone tree is a working tree with an associated repository. It
493
is an independently usable branch, with no dependencies on any other.
494
Creating a standalone tree (via bzr init) is the quickest way to put
495
an existing project under version control.
499
init Make a directory into a versioned branch.
506
Status flags are used to summarise changes to the working tree in a concise
507
manner. They are in the form::
511
where the columns' meanings are as follows.
513
Column 1 - versioning/renames::
520
P Entry for a pending merge (not a file)
522
Column 2 - contents::
531
* The execute bit was changed
536
"""Environment Variables
538
================ =================================================================
539
BZRPATH Path where bzr is to look for shell plugin external commands.
540
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
541
EMAIL E-Mail address of the user.
542
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
543
EDITOR Editor for editing commit messages.
544
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
545
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
546
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
547
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
548
BZR_SSH SSH client: paramiko (default), openssh, ssh, plink.
549
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
550
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
551
================ =================================================================
558
:On Linux: ~/.bazaar/bazaar.conf
559
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
561
Contains the user's default configuration. The section ``[DEFAULT]`` is
562
used to define general configuration that will be applied everywhere.
563
The section ``[ALIASES]`` can be used to create command aliases for
564
commonly used options.
566
A typical config file might look something like::
569
email=John Doe <jdoe@isp.com>
572
commit = commit --strict
573
log10 = log --short -r -10..-1
579
A criss-cross in the branch history can cause the default merge technique
580
to emit more conflicts than would normally be expected.
582
If you encounter criss-crosses, you can use merge --weave instead, which
583
should provide a much better result.
585
Criss-crosses occur in a branch's history if two branches merge the same thing
586
and then merge one another, or if two branches merge one another at the same
587
time. They can be avoided by having each branch only merge from or into a
588
designated central branch (a "star topology").
590
Criss-crosses cause problems because of the way merge works. Bazaar's default
591
merge is a three-way merger; in order to merge OTHER into THIS, it must
592
find a basis for comparison, BASE. Using BASE, it can determine whether
593
differences between THIS and OTHER are due to one side adding lines, or
594
from another side removing lines.
596
Criss-crosses mean there is no good choice for a base. Selecting the recent
597
merge points could cause one side's changes to be silently discarded.
598
Selecting older merge points (which Bazaar does) mean that extra conflicts
601
The ``weave`` merge type is not affected by this problem because it uses
602
line-origin detection instead of a basis revision to determine the cause of
606
# Register help topics
149
results to a specified file.
151
Note: --version must be supplied before any command.
607
155
topic_registry.register("revisionspec", _help_on_revisionspec,
608
156
"Explain how to use --revision")
609
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
610
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
157
topic_registry.register('basic', _basic_help, "Basic commands")
158
topic_registry.register('topics', _help_on_topics, "Topics list")
611
159
def get_format_topic(topic):
612
160
from bzrlib import bzrdir
613
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
161
return bzrdir.format_registry.help_topic(topic)
614
162
topic_registry.register('formats', get_format_topic, 'Directory formats')
615
topic_registry.register('standard-options', _standard_options,
163
topic_registry.register('global-options', _global_options,
616
164
'Options that can be used with any command')
617
topic_registry.register('global-options', _global_options,
618
'Options that control how Bazaar runs')
619
topic_registry.register('urlspec', _help_on_transport,
620
"Supported transport protocols")
621
topic_registry.register('status-flags', _status_flags,
622
"Help on status flags")
623
def get_bugs_topic(topic):
624
from bzrlib import bugtracker
625
return ("Bug Tracker Settings\n\n" +
626
bugtracker.tracker_registry.help_topic(topic))
627
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
628
topic_registry.register('env-variables', _env_variables,
629
'Environment variable names and values')
630
topic_registry.register('files', _files,
631
'Information on configuration and log files')
633
# Load some of the help topics from files
634
topic_registry.register('authentication', _load_from_file,
635
'Information on configuring authentication')
636
topic_registry.register('configuration', _load_from_file,
637
'Details on the configuration settings available')
638
topic_registry.register('conflicts', _load_from_file,
639
'Types of conflicts and what to do about them')
640
topic_registry.register('hooks', _load_from_file,
641
'Points at which custom processing can be added')
644
# Register concept topics.
645
# Note that we might choose to remove these from the online help in the
646
# future or implement them via loading content from files. In the meantime,
647
# please keep them concise.
648
topic_registry.register('branches', _branches,
649
'Information on what a branch is', SECT_CONCEPT)
650
topic_registry.register('checkouts', _checkouts,
651
'Information on what a checkout is', SECT_CONCEPT)
652
topic_registry.register('repositories', _repositories,
653
'Basic information on shared repositories.',
655
topic_registry.register('standalone-trees', _standalone_trees,
656
'Information on what a standalone tree is',
658
topic_registry.register('working-trees', _working_trees,
659
'Information on working trees', SECT_CONCEPT)
660
topic_registry.register('criss-cross', _criss_cross,
661
'Information on criss-cross merging', SECT_CONCEPT)
664
class HelpTopicIndex(object):
665
"""A index for bzr help that returns topics."""
670
def get_topics(self, topic):
671
"""Search for topic in the HelpTopicRegistry.
673
:param topic: A topic to search for. None is treated as 'basic'.
674
:return: A list which is either empty or contains a single
675
RegisteredTopic entry.
679
if topic in topic_registry:
680
return [RegisteredTopic(topic)]
685
class RegisteredTopic(object):
686
"""A help topic which has been registered in the HelpTopicRegistry.
688
These topics consist of nothing more than the name of the topic - all
689
data is retrieved on demand from the registry.
692
def __init__(self, topic):
695
:param topic: The name of the topic that this represents.
699
def get_help_text(self, additional_see_also=None, plain=True):
700
"""Return a string with the help for this topic.
702
:param additional_see_also: Additional help topics to be
704
:param plain: if False, raw help (reStructuredText) is
705
returned instead of plain text.
707
result = topic_registry.get_detail(self.topic)
708
# there is code duplicated here and in bzrlib/plugin.py's
709
# matching Topic code. This should probably be factored in
710
# to a helper function and a common base class.
711
if additional_see_also is not None:
712
see_also = sorted(set(additional_see_also))
716
result += '\n:See also: '
717
result += ', '.join(see_also)
720
result = help_as_plain_text(result)
723
def get_help_topic(self):
724
"""Return the help topic this can be found under."""
728
def help_as_plain_text(text):
729
"""Minimal converter of reStructuredText to plain text."""
730
lines = text.splitlines()
733
if line.startswith(':'):
735
elif line.endswith('::'):
738
return "\n".join(result) + "\n"
added
removed
bzrlib/help_topics.py
