134
80
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
83
def _help_on_revisionspec(name):
147
"""Generate the help for revision specs."""
84
""""Write the summary help for all documented topics to outfile."""
149
85
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:
183
details.append("\nIn addition, plugins can provide other keywords.")
184
details.append("\nA detailed description of each keyword is given below.\n")
186
# The help text is indented 4 spaces - this re cleans that up below
187
indent_re = re.compile(r'^ ', re.MULTILINE)
188
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:
190
93
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
194
# Extract out the top line summary from the body and
195
# clean-up the unwanted whitespace
196
summary,doc = doc.split("\n", 1)
197
#doc = indent_re.sub('', doc)
198
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
201
# Note: The leading : here are HACKs to get reStructuredText
202
# 'field' formatting - we know that the prefix ends in a ':'.
203
out.append(":%s\n\t%s" % (i.prefix, summary))
204
details.append(":%s\n%s" % (i.prefix, doc))
206
return '\n'.join(out + details)
209
def _help_on_transport(name):
210
from bzrlib.transport import (
211
transport_list_registry,
215
def add_string(proto, help, maxl, prefix_width=20):
216
help_lines = textwrap.wrap(help, maxl - prefix_width,
217
break_long_words=False)
218
line_with_indent = '\n' + ' ' * prefix_width
219
help_text = line_with_indent.join(help_lines)
220
return "%-20s%s\n" % (proto, help_text)
223
a1 = a[:a.rfind("://")]
224
b1 = b[:b.rfind("://")]
234
protos = transport_list_registry.keys( )
235
protos.sort(sort_func)
237
shorthelp = transport_list_registry.get_help(proto)
240
if proto.endswith("://"):
241
protl.append(add_string(proto, shorthelp, 79))
243
decl.append(add_string(proto, shorthelp, 79))
246
out = "URL Identifiers\n\n" + \
247
"Supported URL prefixes::\n\n " + \
251
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://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/
285
108
bzr init makes this directory a versioned branch
407
209
end. Checkouts also work on the local file system, so that all that matters is
408
210
file permissions.
410
You can change the master of a checkout by using the "switch" command (see
411
"help switch"). This will change the location that the commits are sent to.
412
The "bind" command can also be used to turn a normal branch into a heavy
413
checkout. If you would like to convert your heavy checkout into a normal
414
branch so that every commit is local, you can use the "unbind" command. To see
415
whether or not a branch is bound or not you can use the "info" command. If the
416
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.
420
220
checkout Create a checkout. Pass --lightweight to get a lightweight
422
222
update Pull any changes in the master branch in to your checkout
423
223
commit Make a commit that is sent to the master branch. If you have
424
a heavy checkout then the --local option will commit to the
224
a heavy checkout then the --local option will commit to the
425
225
checkout without sending the commit to the master
426
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
428
bind Turn a standalone branch into a heavy checkout so that any
429
commits will be sent to the master branch
430
228
unbind Turn a heavy checkout into a standalone branch so that any
431
229
commits are only made locally
432
info Displays whether a branch is bound or unbound. If the branch is
433
bound, then it will also display the location of the bound branch
439
Repositories in Bazaar are where committed information is stored. There is
440
a repository associated with every branch.
442
Repositories are a form of database. Bzr will usually maintain this for
443
good performance automatically, but in some situations (e.g. when doing
444
very many commits in a short time period) you may want to ask bzr to
445
optimise the database indices. This can be done by the 'bzr pack' command.
447
By default just running 'bzr init' will create a repository within the new
448
branch but it is possible to create a shared repository which allows multiple
449
branches to share their information in the same location. When a new branch is
450
created it will first look to see if there is a containing shared repository it
453
When two branches of the same project share a repository, there is
454
generally a large space saving. For some operations (e.g. branching
455
within the repository) this translates in to a large time saving.
457
To create a shared repository use the init-repository command (or the alias
458
init-repo). This command takes the location of the repository to create. This
459
means that 'bzr init-repository repo' will create a directory named 'repo',
460
which contains a shared repository. Any new branches that are created in this
461
directory will then use it for storage.
463
It is a good idea to create a repository whenever you might create more
464
than one branch of a project. This is true for both working areas where you
465
are doing the development, and any server areas that you use for hosting
466
projects. In the latter case, it is common to want branches without working
467
trees. Since the files in the branch will not be edited directly there is no
468
need to use up disk space for a working tree. To create a repository in which
469
the branches will not have working trees pass the '--no-trees' option to
474
init-repository Create a shared repository. Use --no-trees to create one
475
in which new branches won't get a working tree.
482
A working tree is the contents of a branch placed on disk so that you can
483
see the files and edit them. The working tree is where you make changes to a
484
branch, and when you commit the current state of the working tree is the
485
snapshot that is recorded in the commit.
487
When you push a branch to a remote system, a working tree will not be
488
created. If one is already present the files will not be updated. The
489
branch information will be updated and the working tree will be marked
490
as out-of-date. Updating a working tree remotely is difficult, as there
491
may be uncommitted changes or the update may cause content conflicts that are
492
difficult to deal with remotely.
494
If you have a branch with no working tree you can use the 'checkout' command
495
to create a working tree. If you run 'bzr checkout .' from the branch it will
496
create the working tree. If the branch is updated remotely, you can update the
497
working tree by running 'bzr update' in that directory.
499
If you have a branch with a working tree that you do not want the 'remove-tree'
500
command will remove the tree if it is safe. This can be done to avoid the
501
warning about the remote working tree not being updated when pushing to the
502
branch. It can also be useful when working with a '--no-trees' repository
503
(see 'bzr help repositories').
505
If you want to have a working tree on a remote machine that you push to you
506
can either run 'bzr update' in the remote branch after each push, or use some
507
other method to update the tree during the push. There is an 'rspush' plugin
508
that will update the working tree using rsync as well as doing a push. There
509
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
514
checkout Create a working tree when a branch does not have one.
515
remove-tree Removes the working tree from a branch when it is safe to do so.
516
update When a working tree is out of sync with its associated branch
517
this will update the tree to match the branch.
524
A branch consists of the state of a project, including all of its
525
history. All branches have a repository associated (which is where the
526
branch history is stored), but multiple branches may share the same
527
repository (a shared repository). Branches can be copied and merged.
529
In addition, one branch may be bound to another one. Binding to another
530
branch indicates that commits which happen in this branch must also
531
happen in the other branch. Bazaar ensures consistency by not allowing
532
commits when the two branches are out of date. In order for a commit
533
to succeed, it may be necessary to update the current branch using
538
init Change a directory into a versioned branch.
539
branch Create a new branch that is a copy of an existing branch.
540
merge Perform a three-way merge.
541
bind Bind a branch to another one.
545
_standalone_trees = \
548
A standalone tree is a working tree with an associated repository. It
549
is an independently usable branch, with no dependencies on any other.
550
Creating a standalone tree (via bzr init) is the quickest way to put
551
an existing project under version control.
555
init Make a directory into a versioned branch.
562
Status flags are used to summarise changes to the working tree in a concise
563
manner. They are in the form::
567
where the columns' meanings are as follows.
569
Column 1 - versioning/renames::
575
X File nonexistent (and unknown to bzr)
577
P Entry for a pending merge (not a file)
579
Column 2 - contents::
588
* The execute bit was changed
593
"""Environment Variables
595
=================== ===========================================================
596
BZRPATH Path where bzr is to look for shell plugin external
598
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
599
EMAIL E-Mail address of the user.
600
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
601
EDITOR Editor for editing commit messages.
602
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
603
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
604
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
605
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
606
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and
608
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
609
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp,
611
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
612
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
613
BZR_COLUMNS Override implicit terminal width.
614
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest)
615
BZR_PROGRESS_BAR Override the progress display. Values are 'none', 'dots',
617
BZR_PDB Control whether to launch a debugger on error.
618
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a
620
=================== ===========================================================
627
:On Unix: ~/.bazaar/bazaar.conf
628
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
630
Contains the user's default configuration. The section ``[DEFAULT]`` is
631
used to define general configuration that will be applied everywhere.
632
The section ``[ALIASES]`` can be used to create command aliases for
633
commonly used options.
635
A typical config file might look something like::
638
email=John Doe <jdoe@isp.com>
641
commit = commit --strict
642
log10 = log --short -r -10..-1
648
A criss-cross in the branch history can cause the default merge technique
649
to emit more conflicts than would normally be expected.
651
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
652
better results. You may wish to ``bzr revert`` the working tree and merge
653
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
655
Criss-crosses occur in a branch's history if two branches merge the same thing
656
and then merge one another, or if two branches merge one another at the same
657
time. They can be avoided by having each branch only merge from or into a
658
designated central branch (a "star topology").
660
Criss-crosses cause problems because of the way merge works. Bazaar's default
661
merge is a three-way merger; in order to merge OTHER into THIS, it must
662
find a basis for comparison, BASE. Using BASE, it can determine whether
663
differences between THIS and OTHER are due to one side adding lines, or
664
from another side removing lines.
666
Criss-crosses mean there is no good choice for a base. Selecting the recent
667
merge points could cause one side's changes to be silently discarded.
668
Selecting older merge points (which Bazaar does) mean that extra conflicts
671
The ``weave`` merge type is not affected by this problem because it uses
672
line-origin detection instead of a basis revision to determine the cause of
676
_branches_out_of_sync = """Branches Out of Sync
678
When reconfiguring a checkout, tree or branch into a lightweight checkout,
679
a local branch must be destroyed. (For checkouts, this is the local branch
680
that serves primarily as a cache.) If the branch-to-be-destroyed does not
681
have the same last revision as the new reference branch for the lightweight
682
checkout, data could be lost, so Bazaar refuses.
684
How you deal with this depends on *why* the branches are out of sync.
686
If you have a checkout and have done local commits, you can get back in sync
687
by running "bzr update" (and possibly "bzr commit").
689
If you have a branch and the remote branch is out-of-date, you can push
690
the local changes using "bzr push". If the local branch is out of date, you
691
can do "bzr pull". If both branches have had changes, you can merge, commit
692
and then push your changes. If you decide that some of the changes aren't
693
useful, you can "push --overwrite" or "pull --overwrite" instead.
700
To ensure that older clients do not access data incorrectly,
701
Bazaar's policy is to introduce a new storage format whenever
702
new features requiring new metadata are added. New storage
703
formats may also be introduced to improve performance and
706
The newest format, 2a, is highly recommended. If your
707
project is not using 2a, then you should suggest to the
708
project owner to upgrade.
713
Some of the older formats have two variants:
714
a plain one and a rich-root one. The latter include an additional
715
field about the root of the tree. There is no performance cost
716
for using a rich-root format but you cannot easily merge changes
717
from a rich-root format into a plain format. As a consequence,
718
moving a project to a rich-root format takes some co-ordination
719
in that all contributors need to upgrade their repositories
720
around the same time. 2a and all future formats will be
721
implicitly rich-root.
723
See :doc:`current-formats-help` for the complete list of
724
currently supported formats. See :doc:`other-formats-help` for
725
descriptions of any available experimental and deprecated formats.
729
# Register help topics
730
233
topic_registry.register("revisionspec", _help_on_revisionspec,
731
234
"Explain how to use --revision")
732
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
733
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
734
def get_current_formats_topic(topic):
735
from bzrlib import bzrdir
736
return "Current Storage Formats\n\n" + \
737
bzrdir.format_registry.help_topic(topic)
738
def get_other_formats_topic(topic):
739
from bzrlib import bzrdir
740
return "Other Storage Formats\n\n" + \
741
bzrdir.format_registry.help_topic(topic)
742
topic_registry.register('current-formats', get_current_formats_topic,
743
'Current storage formats')
744
topic_registry.register('other-formats', get_other_formats_topic,
745
'Experimental and deprecated storage formats')
746
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,
747
242
'Options that can be used with any command')
748
topic_registry.register('global-options', _global_options,
749
'Options that control how Bazaar runs')
750
topic_registry.register('urlspec', _help_on_transport,
751
"Supported transport protocols")
752
topic_registry.register('status-flags', _status_flags,
753
"Help on status flags")
754
def get_bugs_topic(topic):
755
from bzrlib import bugtracker
756
return ("Bug Tracker Settings\n\n" +
757
bugtracker.tracker_registry.help_topic(topic))
758
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
759
topic_registry.register('env-variables', _env_variables,
760
'Environment variable names and values')
761
topic_registry.register('files', _files,
762
'Information on configuration and log files')
763
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
764
'Points at which custom processing can be added')
766
# Load some of the help topics from files. Note that topics which reproduce API
767
# details will tend to skew (quickly usually!) so please seek other solutions
769
topic_registry.register('authentication', _load_from_file,
770
'Information on configuring authentication')
771
topic_registry.register('configuration', _load_from_file,
772
'Details on the configuration settings available')
773
topic_registry.register('conflict-types', _load_from_file,
774
'Types of conflicts and what to do about them')
775
topic_registry.register('debug-flags', _load_from_file,
776
'Options to show or record debug information')
777
topic_registry.register('location-alias', _load_from_file,
778
'Aliases for remembered locations')
779
topic_registry.register('log-formats', _load_from_file,
780
'Details on the logging formats available')
783
# Register concept topics.
784
# Note that we might choose to remove these from the online help in the
785
# future or implement them via loading content from files. In the meantime,
786
# please keep them concise.
787
topic_registry.register('branches', _branches,
788
'Information on what a branch is', SECT_CONCEPT)
789
243
topic_registry.register('checkouts', _checkouts,
790
'Information on what a checkout is', SECT_CONCEPT)
791
topic_registry.register('content-filters', _load_from_file,
792
'Conversion of content into/from working trees',
794
topic_registry.register('diverged-branches', _load_from_file,
795
'How to fix diverged branches',
797
topic_registry.register('eol', _load_from_file,
798
'Information on end-of-line handling',
800
topic_registry.register('formats', _storage_formats,
801
'Information on choosing a storage format',
803
topic_registry.register('patterns', _load_from_file,
804
'Information on the pattern syntax',
806
topic_registry.register('repositories', _repositories,
807
'Basic information on shared repositories.',
809
topic_registry.register('rules', _load_from_file,
810
'Information on defining rule-based preferences',
812
topic_registry.register('standalone-trees', _standalone_trees,
813
'Information on what a standalone tree is',
815
topic_registry.register('working-trees', _working_trees,
816
'Information on working trees', SECT_CONCEPT)
817
topic_registry.register('criss-cross', _criss_cross,
818
'Information on criss-cross merging', SECT_CONCEPT)
819
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
820
'Steps to resolve "out-of-sync" when reconfiguring',
824
class HelpTopicIndex(object):
825
"""A index for bzr help that returns topics."""
830
def get_topics(self, topic):
831
"""Search for topic in the HelpTopicRegistry.
833
:param topic: A topic to search for. None is treated as 'basic'.
834
:return: A list which is either empty or contains a single
835
RegisteredTopic entry.
839
if topic in topic_registry:
840
return [RegisteredTopic(topic)]
845
class RegisteredTopic(object):
846
"""A help topic which has been registered in the HelpTopicRegistry.
848
These topics consist of nothing more than the name of the topic - all
849
data is retrieved on demand from the registry.
852
def __init__(self, topic):
855
:param topic: The name of the topic that this represents.
859
def get_help_text(self, additional_see_also=None, plain=True):
860
"""Return a string with the help for this topic.
862
:param additional_see_also: Additional help topics to be
864
:param plain: if False, raw help (reStructuredText) is
865
returned instead of plain text.
867
result = topic_registry.get_detail(self.topic)
868
# there is code duplicated here and in bzrlib/plugin.py's
869
# matching Topic code. This should probably be factored in
870
# to a helper function and a common base class.
871
if additional_see_also is not None:
872
see_also = sorted(set(additional_see_also))
876
result += '\n:See also: '
877
result += ', '.join(see_also)
880
result = help_as_plain_text(result)
883
def get_help_topic(self):
884
"""Return the help topic this can be found under."""
888
def help_as_plain_text(text):
889
"""Minimal converter of reStructuredText to plain text."""
891
# Remove the standalone code block marker
892
text = re.sub(r"(?m)^\s*::\n\s*$", "", text)
893
lines = text.splitlines()
896
if line.startswith(':'):
898
elif line.endswith('::'):
900
# Map :doc:`xxx-help` to ``bzr help xxx``
901
line = re.sub(":doc:`(.+)-help`", r'``bzr help \1``', line)
903
return "\n".join(result) + "\n"
244
'Information on what a checkout is')
added
removed
bzrlib/help_topics.py
