136
80
return ''.join(out)
139
def _load_from_file(topic_name):
140
"""Load help from a file.
142
Topics are expected to be txt files in bzrlib.help_topics.
144
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
145
return osutils.resource_string('bzrlib.help_topics', resource_name)
148
83
def _help_on_revisionspec(name):
149
"""Generate the help for revision specs."""
84
""""Write the summary help for all documented topics to outfile."""
151
85
import bzrlib.revisionspec
155
"""Revision Identifiers
157
A revision identifier refers to a specific state of a branch's history. It
158
can be expressed in several ways. It can begin with a keyword to
159
unambiguously specify a given lookup type; some examples are 'last:1',
160
'before:yesterday' and 'submit:'.
162
Alternately, it can be given without a keyword, in which case it will be
163
checked as a revision number, a tag, a revision id, a date specification, or a
164
branch specification, in that order. For example, 'date:today' could be
165
written as simply 'today', though if you have a tag called 'today' that will
168
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
169
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
170
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
171
spaces around the '..').
173
Ranges are interpreted differently by different commands. To the "log" command,
174
a range is a sequence of log messages, but to the "diff" command, the range
175
denotes a change between revisions (and not a sequence of changes). In
176
addition, "log" considers a closed range whereas "diff" and "merge" consider it
177
to be open-ended, that is, they include one end but not the other. For example:
178
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
179
while "bzr diff -r 3647..3649" includes the changes done in revisions 3648 and
182
The keywords used as revision selection methods are the following:
185
details.append("\nIn addition, plugins can provide other keywords.")
186
details.append("\nA detailed description of each keyword is given below.\n")
188
# The help text is indented 4 spaces - this re cleans that up below
189
indent_re = re.compile(r'^ ', re.MULTILINE)
190
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
88
out.append("\nRevision prefix specifier:"
89
"\n--------------------------\n")
91
for i in bzrlib.revisionspec.SPEC_TYPES:
192
93
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
196
# Extract out the top line summary from the body and
197
# clean-up the unwanted whitespace
198
summary,doc = doc.split("\n", 1)
199
#doc = indent_re.sub('', doc)
200
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
203
# Note: The leading : here are HACKs to get reStructuredText
204
# 'field' formatting - we know that the prefix ends in a ':'.
205
out.append(":%s\n\t%s" % (i.prefix, summary))
206
details.append(":%s\n%s" % (i.prefix, doc))
208
return '\n'.join(out + details)
211
def _help_on_transport(name):
212
from bzrlib.transport import (
213
transport_list_registry,
217
def add_string(proto, help, maxl, prefix_width=20):
218
help_lines = textwrap.wrap(help, maxl - prefix_width,
219
break_long_words=False)
220
line_with_indent = '\n' + ' ' * prefix_width
221
help_text = line_with_indent.join(help_lines)
222
return "%-20s%s\n" % (proto, help_text)
225
a1 = a[:a.rfind("://")]
226
b1 = b[:b.rfind("://")]
236
protos = transport_list_registry.keys( )
237
protos.sort(sort_func)
239
shorthelp = transport_list_registry.get_help(proto)
242
if proto.endswith("://"):
243
protl.append(add_string(proto, shorthelp, 79))
245
decl.append(add_string(proto, shorthelp, 79))
248
out = "URL Identifiers\n\n" + \
249
"Supported URL prefixes::\n\n " + \
253
out += "\nSupported modifiers::\n\n " + \
257
\nBazaar supports all of the standard parts within the URL::
259
<protocol>://[user[:password]@]host[:port]/[path]
261
allowing URLs such as::
263
http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
265
For bzr+ssh:// and sftp:// URLs, Bazaar also supports paths that begin
266
with '~' as meaning that the rest of the path should be interpreted
267
relative to the remote user's home directory. For example if the user
268
``remote`` has a home directory of ``/home/remote`` on the server
269
shell.example.com, then::
271
bzr+ssh://remote@shell.example.com/~/myproject/trunk
273
would refer to ``/home/remote/myproject/trunk``.
275
Many commands that accept URLs also accept location aliases too.
276
See :doc:`location-alias-help` and :doc:`url-special-chars-help`.
283
"""Bazaar %s -- a free distributed version-control tool
284
http://bazaar.canonical.com/
95
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
98
out.append(" %s %s\n\n" % (i.prefix, doc))
104
"""Bazaar -- a free distributed version-control tool
105
http://bazaar-vcs.org/
287
108
bzr init makes this directory a versioned branch
409
209
end. Checkouts also work on the local file system, so that all that matters is
410
210
file permissions.
412
You can change the master of a checkout by using the "switch" command (see
413
"help switch"). This will change the location that the commits are sent to.
414
The "bind" command can also be used to turn a normal branch into a heavy
415
checkout. If you would like to convert your heavy checkout into a normal
416
branch so that every commit is local, you can use the "unbind" command. To see
417
whether or not a branch is bound or not you can use the "info" command. If the
418
branch is bound it will tell you the location of the bound branch.
212
You can change the master of a checkout by using the "bind" command (see "help
213
bind"). This will change the location that the commits are sent to. The bind
214
command can also be used to turn a branch into a heavy checkout. If you
215
would like to convert your heavy checkout into a normal branch so that every
216
commit is local, you can use the "unbind" command.
422
220
checkout Create a checkout. Pass --lightweight to get a lightweight
424
222
update Pull any changes in the master branch in to your checkout
425
223
commit Make a commit that is sent to the master branch. If you have
426
a heavy checkout then the --local option will commit to the
224
a heavy checkout then the --local option will commit to the
427
225
checkout without sending the commit to the master
428
switch Change the master branch that the commits in the checkout will
226
bind Change the master branch that the commits in the checkout will
430
bind Turn a standalone branch into a heavy checkout so that any
431
commits will be sent to the master branch
432
228
unbind Turn a heavy checkout into a standalone branch so that any
433
229
commits are only made locally
434
info Displays whether a branch is bound or unbound. If the branch is
435
bound, then it will also display the location of the bound branch
441
Repositories in Bazaar are where committed information is stored. There is
442
a repository associated with every branch.
444
Repositories are a form of database. Bzr will usually maintain this for
445
good performance automatically, but in some situations (e.g. when doing
446
very many commits in a short time period) you may want to ask bzr to
447
optimise the database indices. This can be done by the 'bzr pack' command.
449
By default just running 'bzr init' will create a repository within the new
450
branch but it is possible to create a shared repository which allows multiple
451
branches to share their information in the same location. When a new branch is
452
created it will first look to see if there is a containing shared repository it
455
When two branches of the same project share a repository, there is
456
generally a large space saving. For some operations (e.g. branching
457
within the repository) this translates in to a large time saving.
459
To create a shared repository use the init-repository command (or the alias
460
init-repo). This command takes the location of the repository to create. This
461
means that 'bzr init-repository repo' will create a directory named 'repo',
462
which contains a shared repository. Any new branches that are created in this
463
directory will then use it for storage.
465
It is a good idea to create a repository whenever you might create more
466
than one branch of a project. This is true for both working areas where you
467
are doing the development, and any server areas that you use for hosting
468
projects. In the latter case, it is common to want branches without working
469
trees. Since the files in the branch will not be edited directly there is no
470
need to use up disk space for a working tree. To create a repository in which
471
the branches will not have working trees pass the '--no-trees' option to
476
init-repository Create a shared repository. Use --no-trees to create one
477
in which new branches won't get a working tree.
484
A working tree is the contents of a branch placed on disk so that you can
485
see the files and edit them. The working tree is where you make changes to a
486
branch, and when you commit the current state of the working tree is the
487
snapshot that is recorded in the commit.
489
When you push a branch to a remote system, a working tree will not be
490
created. If one is already present the files will not be updated. The
491
branch information will be updated and the working tree will be marked
492
as out-of-date. Updating a working tree remotely is difficult, as there
493
may be uncommitted changes or the update may cause content conflicts that are
494
difficult to deal with remotely.
496
If you have a branch with no working tree you can use the 'checkout' command
497
to create a working tree. If you run 'bzr checkout .' from the branch it will
498
create the working tree. If the branch is updated remotely, you can update the
499
working tree by running 'bzr update' in that directory.
501
If you have a branch with a working tree that you do not want the 'remove-tree'
502
command will remove the tree if it is safe. This can be done to avoid the
503
warning about the remote working tree not being updated when pushing to the
504
branch. It can also be useful when working with a '--no-trees' repository
505
(see 'bzr help repositories').
507
If you want to have a working tree on a remote machine that you push to you
508
can either run 'bzr update' in the remote branch after each push, or use some
509
other method to update the tree during the push. There is an 'rspush' plugin
510
that will update the working tree using rsync as well as doing a push. There
511
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
516
checkout Create a working tree when a branch does not have one.
517
remove-tree Removes the working tree from a branch when it is safe to do so.
518
update When a working tree is out of sync with its associated branch
519
this will update the tree to match the branch.
526
A branch consists of the state of a project, including all of its
527
history. All branches have a repository associated (which is where the
528
branch history is stored), but multiple branches may share the same
529
repository (a shared repository). Branches can be copied and merged.
531
In addition, one branch may be bound to another one. Binding to another
532
branch indicates that commits which happen in this branch must also
533
happen in the other branch. Bazaar ensures consistency by not allowing
534
commits when the two branches are out of date. In order for a commit
535
to succeed, it may be necessary to update the current branch using
540
init Change a directory into a versioned branch.
541
branch Create a new branch that is a copy of an existing branch.
542
merge Perform a three-way merge.
543
bind Bind a branch to another one.
547
_standalone_trees = \
550
A standalone tree is a working tree with an associated repository. It
551
is an independently usable branch, with no dependencies on any other.
552
Creating a standalone tree (via bzr init) is the quickest way to put
553
an existing project under version control.
557
init Make a directory into a versioned branch.
564
Status flags are used to summarise changes to the working tree in a concise
565
manner. They are in the form::
569
where the columns' meanings are as follows.
571
Column 1 - versioning/renames::
577
X File nonexistent (and unknown to bzr)
579
P Entry for a pending merge (not a file)
581
Column 2 - contents::
590
* The execute bit was changed
595
"""Environment Variables
597
=================== ===========================================================
598
BZRPATH Path where bzr is to look for shell plugin external
600
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
601
EMAIL E-Mail address of the user.
602
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
603
EDITOR Editor for editing commit messages.
604
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
605
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
606
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
607
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
608
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and
610
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
611
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp,
613
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
614
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
615
BZR_COLUMNS Override implicit terminal width.
616
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest)
617
BZR_PROGRESS_BAR Override the progress display. Values are 'none' or 'text'.
618
BZR_PDB Control whether to launch a debugger on error.
619
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a
621
=================== ===========================================================
628
:On Unix: ~/.bazaar/bazaar.conf
629
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
631
Contains the user's default configuration. The section ``[DEFAULT]`` is
632
used to define general configuration that will be applied everywhere.
633
The section ``[ALIASES]`` can be used to create command aliases for
634
commonly used options.
636
A typical config file might look something like::
639
email=John Doe <jdoe@isp.com>
642
commit = commit --strict
643
log10 = log --short -r -10..-1
649
A criss-cross in the branch history can cause the default merge technique
650
to emit more conflicts than would normally be expected.
652
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
653
better results. You may wish to ``bzr revert`` the working tree and merge
654
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
656
Criss-crosses occur in a branch's history if two branches merge the same thing
657
and then merge one another, or if two branches merge one another at the same
658
time. They can be avoided by having each branch only merge from or into a
659
designated central branch (a "star topology").
661
Criss-crosses cause problems because of the way merge works. Bazaar's default
662
merge is a three-way merger; in order to merge OTHER into THIS, it must
663
find a basis for comparison, BASE. Using BASE, it can determine whether
664
differences between THIS and OTHER are due to one side adding lines, or
665
from another side removing lines.
667
Criss-crosses mean there is no good choice for a base. Selecting the recent
668
merge points could cause one side's changes to be silently discarded.
669
Selecting older merge points (which Bazaar does) mean that extra conflicts
672
The ``weave`` merge type is not affected by this problem because it uses
673
line-origin detection instead of a basis revision to determine the cause of
677
_branches_out_of_sync = """Branches Out of Sync
679
When reconfiguring a checkout, tree or branch into a lightweight checkout,
680
a local branch must be destroyed. (For checkouts, this is the local branch
681
that serves primarily as a cache.) If the branch-to-be-destroyed does not
682
have the same last revision as the new reference branch for the lightweight
683
checkout, data could be lost, so Bazaar refuses.
685
How you deal with this depends on *why* the branches are out of sync.
687
If you have a checkout and have done local commits, you can get back in sync
688
by running "bzr update" (and possibly "bzr commit").
690
If you have a branch and the remote branch is out-of-date, you can push
691
the local changes using "bzr push". If the local branch is out of date, you
692
can do "bzr pull". If both branches have had changes, you can merge, commit
693
and then push your changes. If you decide that some of the changes aren't
694
useful, you can "push --overwrite" or "pull --overwrite" instead.
701
To ensure that older clients do not access data incorrectly,
702
Bazaar's policy is to introduce a new storage format whenever
703
new features requiring new metadata are added. New storage
704
formats may also be introduced to improve performance and
707
The newest format, 2a, is highly recommended. If your
708
project is not using 2a, then you should suggest to the
709
project owner to upgrade.
714
Some of the older formats have two variants:
715
a plain one and a rich-root one. The latter include an additional
716
field about the root of the tree. There is no performance cost
717
for using a rich-root format but you cannot easily merge changes
718
from a rich-root format into a plain format. As a consequence,
719
moving a project to a rich-root format takes some co-ordination
720
in that all contributors need to upgrade their repositories
721
around the same time. 2a and all future formats will be
722
implicitly rich-root.
724
See :doc:`current-formats-help` for the complete list of
725
currently supported formats. See :doc:`other-formats-help` for
726
descriptions of any available experimental and deprecated formats.
730
# Register help topics
731
233
topic_registry.register("revisionspec", _help_on_revisionspec,
732
234
"Explain how to use --revision")
733
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
734
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
735
def get_current_formats_topic(topic):
736
from bzrlib import bzrdir
737
return "Current Storage Formats\n\n" + \
738
bzrdir.format_registry.help_topic(topic)
739
def get_other_formats_topic(topic):
740
from bzrlib import bzrdir
741
return "Other Storage Formats\n\n" + \
742
bzrdir.format_registry.help_topic(topic)
743
topic_registry.register('current-formats', get_current_formats_topic,
744
'Current storage formats')
745
topic_registry.register('other-formats', get_other_formats_topic,
746
'Experimental and deprecated storage formats')
747
topic_registry.register('standard-options', _standard_options,
235
topic_registry.register('basic', _basic_help, "Basic commands")
236
topic_registry.register('topics', _help_on_topics, "Topics list")
237
def get_format_topic(topic):
238
from bzrlib import bzrdir
239
return bzrdir.format_registry.help_topic(topic)
240
topic_registry.register('formats', get_format_topic, 'Directory formats')
241
topic_registry.register('global-options', _global_options,
748
242
'Options that can be used with any command')
749
topic_registry.register('global-options', _global_options,
750
'Options that control how Bazaar runs')
751
topic_registry.register('urlspec', _help_on_transport,
752
"Supported transport protocols")
753
topic_registry.register('status-flags', _status_flags,
754
"Help on status flags")
755
def get_bugs_topic(topic):
756
from bzrlib import bugtracker
757
return ("Bug Tracker Settings\n\n" +
758
bugtracker.tracker_registry.help_topic(topic))
759
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
760
topic_registry.register('env-variables', _env_variables,
761
'Environment variable names and values')
762
topic_registry.register('files', _files,
763
'Information on configuration and log files')
764
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
765
'Points at which custom processing can be added')
767
# Load some of the help topics from files. Note that topics which reproduce API
768
# details will tend to skew (quickly usually!) so please seek other solutions
770
topic_registry.register('authentication', _load_from_file,
771
'Information on configuring authentication')
772
topic_registry.register('configuration', _load_from_file,
773
'Details on the configuration settings available')
774
topic_registry.register('conflict-types', _load_from_file,
775
'Types of conflicts and what to do about them')
776
topic_registry.register('debug-flags', _load_from_file,
777
'Options to show or record debug information')
778
topic_registry.register('location-alias', _load_from_file,
779
'Aliases for remembered locations')
780
topic_registry.register('log-formats', _load_from_file,
781
'Details on the logging formats available')
782
topic_registry.register('url-special-chars', _load_from_file,
783
'Special character handling in URLs')
786
# Register concept topics.
787
# Note that we might choose to remove these from the online help in the
788
# future or implement them via loading content from files. In the meantime,
789
# please keep them concise.
790
topic_registry.register('branches', _branches,
791
'Information on what a branch is', SECT_CONCEPT)
792
243
topic_registry.register('checkouts', _checkouts,
793
'Information on what a checkout is', SECT_CONCEPT)
794
topic_registry.register('content-filters', _load_from_file,
795
'Conversion of content into/from working trees',
797
topic_registry.register('diverged-branches', _load_from_file,
798
'How to fix diverged branches',
800
topic_registry.register('eol', _load_from_file,
801
'Information on end-of-line handling',
803
topic_registry.register('formats', _storage_formats,
804
'Information on choosing a storage format',
806
topic_registry.register('patterns', _load_from_file,
807
'Information on the pattern syntax',
809
topic_registry.register('repositories', _repositories,
810
'Basic information on shared repositories.',
812
topic_registry.register('rules', _load_from_file,
813
'Information on defining rule-based preferences',
815
topic_registry.register('standalone-trees', _standalone_trees,
816
'Information on what a standalone tree is',
818
topic_registry.register('working-trees', _working_trees,
819
'Information on working trees', SECT_CONCEPT)
820
topic_registry.register('criss-cross', _criss_cross,
821
'Information on criss-cross merging', SECT_CONCEPT)
822
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
823
'Steps to resolve "out-of-sync" when reconfiguring',
827
class HelpTopicIndex(object):
828
"""A index for bzr help that returns topics."""
833
def get_topics(self, topic):
834
"""Search for topic in the HelpTopicRegistry.
836
:param topic: A topic to search for. None is treated as 'basic'.
837
:return: A list which is either empty or contains a single
838
RegisteredTopic entry.
842
if topic in topic_registry:
843
return [RegisteredTopic(topic)]
848
def _format_see_also(see_also):
851
result += '\n:See also: '
852
result += ', '.join(sorted(set(see_also)))
857
class RegisteredTopic(object):
858
"""A help topic which has been registered in the HelpTopicRegistry.
860
These topics consist of nothing more than the name of the topic - all
861
data is retrieved on demand from the registry.
864
def __init__(self, topic):
867
:param topic: The name of the topic that this represents.
871
def get_help_text(self, additional_see_also=None, plain=True):
872
"""Return a string with the help for this topic.
874
:param additional_see_also: Additional help topics to be
876
:param plain: if False, raw help (reStructuredText) is
877
returned instead of plain text.
879
result = topic_registry.get_detail(self.topic)
880
result += _format_see_also(additional_see_also)
882
result = help_as_plain_text(result)
884
result = i18n.gettext_per_paragraph(result)
887
def get_help_topic(self):
888
"""Return the help topic this can be found under."""
892
def help_as_plain_text(text):
893
"""Minimal converter of reStructuredText to plain text."""
895
# Remove the standalone code block marker
896
text = re.sub(r"(?m)^\s*::\n\s*$", "", text)
897
lines = text.splitlines()
900
if line.startswith(':'):
902
elif line.endswith('::'):
904
# Map :doc:`xxx-help` to ``bzr help xxx``
905
line = re.sub(":doc:`(.+?)-help`", r'``bzr help \1``', line)
907
return "\n".join(result) + "\n"
910
class ConfigOptionHelpIndex(object):
911
"""A help index that returns help topics for config options."""
914
self.prefix = 'configuration/'
916
def get_topics(self, topic):
917
"""Search for topic in the registered config options.
919
:param topic: A topic to search for.
920
:return: A list which is either empty or contains a single
925
elif topic.startswith(self.prefix):
926
topic = topic[len(self.prefix):]
927
if topic in config.option_registry:
928
return [config.option_registry.get(topic)]
244
'Information on what a checkout is')
added
removed
bzrlib/help_topics.py
