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.
19
19
Help topics are meant to be help for items that aren't commands, but will
20
20
help bzr become fully learnable without referring to a tutorial.
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:
28
1. A '::' appearing on the end of a line is replaced with ':'.
29
2. Lines starting with a ':' have it stripped.
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.
45
# Section identifiers (map topics to the right place in the manual)
46
SECT_COMMAND = "command"
47
SECT_CONCEPT = "concept"
48
SECT_HIDDEN = "hidden"
50
SECT_PLUGIN = "plugin"
23
from bzrlib import registry
53
26
class HelpTopicRegistry(registry.Registry):
54
27
"""A Registry customized for handling help topics."""
56
def register(self, topic, detail, summary, section=SECT_LIST):
29
def register(self, topic, detail, summary):
57
30
"""Register a new help topic.
59
32
:param topic: Name of documentation entry
60
33
:param detail: Function or string object providing detailed
61
34
documentation for topic. Function interface is detail(topic).
62
35
This should return a text string of the detailed information.
63
See the module documentation for details on help text formatting.
64
36
:param summary: String providing single-line documentation for topic.
65
:param section: Section in reference manual - see SECT_* identifiers.
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)
38
# The detail is stored as the 'object' and the
39
super(HelpTopicRegistry, self).register(topic, detail, info=summary)
71
def register_lazy(self, topic, module_name, member_name, summary,
41
def register_lazy(self, topic, module_name, member_name, summary):
73
42
"""Register a new help topic, and import the details on demand.
75
44
:param topic: Name of documentation entry
76
45
:param module_name: The module to find the detailed help.
77
46
:param member_name: The member of the module to use for detailed help.
78
47
:param summary: String providing single-line documentation for topic.
79
:param section: Section in reference manual - see SECT_* identifiers.
81
# The detail is stored as the 'object' and the metadata as the info
82
info=(summary,section)
83
49
super(HelpTopicRegistry, self).register_lazy(topic, module_name,
84
member_name, info=info)
50
member_name, info=summary)
86
52
def get_detail(self, topic):
87
53
"""Get the detailed help on a given topic."""
406
256
end. Checkouts also work on the local file system, so that all that matters is
407
257
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.
259
You can change the master of a checkout by using the "bind" command (see "help
260
bind"). This will change the location that the commits are sent to. The bind
261
command can also be used to turn a branch into a heavy checkout. If you
262
would like to convert your heavy checkout into a normal branch so that every
263
commit is local, you can use the "unbind" command.
419
267
checkout Create a checkout. Pass --lightweight to get a lightweight
421
269
update Pull any changes in the master branch in to your checkout
422
270
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
271
a heavy checkout then the --local option will commit to the
424
272
checkout without sending the commit to the master
425
switch Change the master branch that the commits in the checkout will
273
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
275
unbind Turn a heavy checkout into a standalone branch so that any
430
276
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
438
Repositories in Bazaar are where committed information is stored. There is
439
a repository associated with every branch.
441
Repositories are a form of database. Bzr will usually maintain this for
442
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
444
optimise the database indices. This can be done by the 'bzr pack' command.
446
By default just running 'bzr init' will create a repository within the new
447
branch but it is possible to create a shared repository which allows multiple
448
branches to share their information in the same location. When a new branch is
449
created it will first look to see if there is a containing shared repository it
452
When two branches of the same project share a repository, there is
453
generally a large space saving. For some operations (e.g. branching
454
within the repository) this translates in to a large time saving.
456
To create a shared repository use the init-repository command (or the alias
457
init-repo). This command takes the location of the repository to create. This
458
means that 'bzr init-repository repo' will create a directory named 'repo',
459
which contains a shared repository. Any new branches that are created in this
460
directory will then use it for storage.
462
It is a good idea to create a repository whenever you might create more
463
than one branch of a project. This is true for both working areas where you
464
are doing the development, and any server areas that you use for hosting
465
projects. In the latter case, it is common to want branches without working
466
trees. Since the files in the branch will not be edited directly there is no
467
need to use up disk space for a working tree. To create a repository in which
468
the branches will not have working trees pass the '--no-trees' option to
473
init-repository Create a shared repository. Use --no-trees to create one
474
in which new branches won't get a working tree.
481
A working tree is the contents of a branch placed on disk so that you can
482
see the files and edit them. The working tree is where you make changes to a
483
branch, and when you commit the current state of the working tree is the
484
snapshot that is recorded in the commit.
486
When you push a branch to a remote system, a working tree will not be
487
created. If one is already present the files will not be updated. The
488
branch information will be updated and the working tree will be marked
489
as out-of-date. Updating a working tree remotely is difficult, as there
490
may be uncommitted changes or the update may cause content conflicts that are
491
difficult to deal with remotely.
493
If you have a branch with no working tree you can use the 'checkout' command
494
to create a working tree. If you run 'bzr checkout .' from the branch it will
495
create the working tree. If the branch is updated remotely, you can update the
496
working tree by running 'bzr update' in that directory.
498
If you have a branch with a working tree that you do not want the 'remove-tree'
499
command will remove the tree if it is safe. This can be done to avoid the
500
warning about the remote working tree not being updated when pushing to the
501
branch. It can also be useful when working with a '--no-trees' repository
502
(see 'bzr help repositories').
504
If you want to have a working tree on a remote machine that you push to you
505
can either run 'bzr update' in the remote branch after each push, or use some
506
other method to update the tree during the push. There is an 'rspush' plugin
507
that will update the working tree using rsync as well as doing a push. There
508
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
513
checkout Create a working tree when a branch does not have one.
514
remove-tree Removes the working tree from a branch when it is safe to do so.
515
update When a working tree is out of sync with it's associated branch
516
this will update the tree to match the branch.
523
A branch consists of the state of a project, including all of its
524
history. All branches have a repository associated (which is where the
525
branch history is stored), but multiple branches may share the same
526
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
537
init Change a directory into a versioned branch.
538
branch Create a new branch that is a copy of an existing branch.
539
merge Perform a three-way merge.
540
bind Bind a branch to another one.
544
_standalone_trees = \
547
A standalone tree is a working tree with an associated repository. It
548
is an independently usable branch, with no dependencies on any other.
549
Creating a standalone tree (via bzr init) is the quickest way to put
550
an existing project under version control.
554
init Make a directory into a versioned branch.
561
Status flags are used to summarise changes to the working tree in a concise
562
manner. They are in the form::
566
where the columns' meanings are as follows.
568
Column 1 - versioning/renames::
574
X File nonexistent (and unknown to bzr)
576
P Entry for a pending merge (not a file)
578
Column 2 - contents::
587
* The execute bit was changed
592
"""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
=================== =======================================================================
621
:On Unix: ~/.bazaar/bazaar.conf
622
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
624
Contains the user's default configuration. The section ``[DEFAULT]`` is
625
used to define general configuration that will be applied everywhere.
626
The section ``[ALIASES]`` can be used to create command aliases for
627
commonly used options.
629
A typical config file might look something like::
632
email=John Doe <jdoe@isp.com>
635
commit = commit --strict
636
log10 = log --short -r -10..-1
642
A criss-cross in the branch history can cause the default merge technique
643
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.
649
Criss-crosses occur in a branch's history if two branches merge the same thing
650
and then merge one another, or if two branches merge one another at the same
651
time. They can be avoided by having each branch only merge from or into a
652
designated central branch (a "star topology").
654
Criss-crosses cause problems because of the way merge works. Bazaar's default
655
merge is a three-way merger; in order to merge OTHER into THIS, it must
656
find a basis for comparison, BASE. Using BASE, it can determine whether
657
differences between THIS and OTHER are due to one side adding lines, or
658
from another side removing lines.
660
Criss-crosses mean there is no good choice for a base. Selecting the recent
661
merge points could cause one side's changes to be silently discarded.
662
Selecting older merge points (which Bazaar does) mean that extra conflicts
665
The ``weave`` merge type is not affected by this problem because it uses
666
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
# Register help topics
724
280
topic_registry.register("revisionspec", _help_on_revisionspec,
725
281
"Explain how to use --revision")
726
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
727
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')
740
topic_registry.register('standard-options', _standard_options,
282
topic_registry.register('basic', _basic_help, "Basic commands")
283
topic_registry.register('topics', _help_on_topics, "Topics list")
284
def get_format_topic(topic):
285
from bzrlib import bzrdir
286
return bzrdir.format_registry.help_topic(topic)
287
topic_registry.register('formats', get_format_topic, 'Directory formats')
288
topic_registry.register('global-options', _global_options,
741
289
'Options that can be used with any command')
742
topic_registry.register('global-options', _global_options,
743
'Options that control how Bazaar runs')
290
topic_registry.register('checkouts', _checkouts,
291
'Information on what a checkout is')
744
292
topic_registry.register('urlspec', _help_on_transport,
745
293
"Supported transport protocols")
746
topic_registry.register('status-flags', _status_flags,
747
"Help on status flags")
748
294
def get_bugs_topic(topic):
749
295
from bzrlib import bugtracker
750
return ("Bug Tracker Settings\n\n" +
751
bugtracker.tracker_registry.help_topic(topic))
752
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
753
topic_registry.register('env-variables', _env_variables,
754
'Environment variable names and values')
755
topic_registry.register('files', _files,
756
'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
# Register concept topics.
778
# Note that we might choose to remove these from the online help in the
779
# future or implement them via loading content from files. In the meantime,
780
# please keep them concise.
781
topic_registry.register('branches', _branches,
782
'Information on what a branch is', SECT_CONCEPT)
783
topic_registry.register('checkouts', _checkouts,
784
'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
topic_registry.register('repositories', _repositories,
801
'Basic information on shared repositories.',
803
topic_registry.register('rules', _load_from_file,
804
'Information on defining rule-based preferences',
806
topic_registry.register('standalone-trees', _standalone_trees,
807
'Information on what a standalone tree is',
809
topic_registry.register('working-trees', _working_trees,
810
'Information on working trees', SECT_CONCEPT)
811
topic_registry.register('criss-cross', _criss_cross,
812
'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',
296
return bugtracker.tracker_registry.help_topic(topic)
297
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
818
300
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
