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."""
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 can
156
be a revision number, or a keyword followed by ':' and often other
157
parameters. Some examples of identifiers are '3', 'last:1', 'before:yesterday'
160
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
161
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
162
'branch:/path/to/branch1/..branch:/branch2' (note that there are no quotes or
163
spaces around the '..').
165
Ranges are interpreted differently by different commands. To the "log" command,
166
a range is a sequence of log messages, but to the "diff" command, the range
167
denotes a change between revisions (and not a sequence of changes). In
168
addition, "log" considers a closed range whereas "diff" and "merge" consider it
169
to be open-ended, that is, they include one end but not the other. For example:
170
"bzr log -r 3647..3649" shows the messages of revisions 3647, 3648 and 3649,
171
while "bzr diff -r 3647..3649" includes the changes done in revisions 3648 and
174
The keywords used as revision selection methods are the following:
177
details.append("\nIn addition, plugins can provide other keywords.")
178
details.append("\nA detailed description of each keyword is given below.\n")
180
# The help text is indented 4 spaces - this re cleans that up below
181
indent_re = re.compile(r'^ ', re.MULTILINE)
182
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:
184
93
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
188
# Extract out the top line summary from the body and
189
# clean-up the unwanted whitespace
190
summary,doc = doc.split("\n", 1)
191
#doc = indent_re.sub('', doc)
192
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
195
# Note: The leading : here are HACKs to get reStructuredText
196
# 'field' formatting - we know that the prefix ends in a ':'.
197
out.append(":%s\n\t%s" % (i.prefix, summary))
198
details.append(":%s\n%s" % (i.prefix, doc))
200
return '\n'.join(out + details)
203
def _help_on_transport(name):
204
from bzrlib.transport import (
205
transport_list_registry,
209
def add_string(proto, help, maxl, prefix_width=20):
210
help_lines = textwrap.wrap(help, maxl - prefix_width)
211
line_with_indent = '\n' + ' ' * prefix_width
212
help_text = line_with_indent.join(help_lines)
213
return "%-20s%s\n" % (proto, help_text)
216
a1 = a[:a.rfind("://")]
217
b1 = b[:b.rfind("://")]
227
protos = transport_list_registry.keys( )
228
protos.sort(sort_func)
230
shorthelp = transport_list_registry.get_help(proto)
233
if proto.endswith("://"):
234
protl.append(add_string(proto, shorthelp, 79))
236
decl.append(add_string(proto, shorthelp, 79))
239
out = "URL Identifiers\n\n" + \
240
"Supported URL prefixes::\n\n " + \
244
out += "\nSupported modifiers::\n\n " + \
95
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
98
out.append(" %s %s\n\n" % (i.prefix, doc))
251
104
"""Bazaar -- a free distributed version-control tool
252
105
http://bazaar-vcs.org/
393
229
commits are only made locally
399
Repositories in Bazaar are where committed information is stored. There is
400
a repository associated with every branch.
402
Repositories are a form of database. Bzr will usually maintain this for
403
good performance automatically, but in some situations (e.g. when doing
404
very many commits in a short time period) you may want to ask bzr to
405
optimise the database indices. This can be done by the 'bzr pack' command.
407
By default just running 'bzr init' will create a repository within the new
408
branch but it is possible to create a shared repository which allows multiple
409
branches to share their information in the same location. When a new branch is
410
created it will first look to see if there is a containing shared repository it
413
When two branches of the same project share a repository, there is
414
generally a large space saving. For some operations (e.g. branching
415
within the repository) this translates in to a large time saving.
417
To create a shared repository use the init-repository command (or the alias
418
init-repo). This command takes the location of the repository to create. This
419
means that 'bzr init-repository repo' will create a directory named 'repo',
420
which contains a shared repository. Any new branches that are created in this
421
directory will then use it for storage.
423
It is a good idea to create a repository whenever you might create more
424
than one branch of a project. This is true for both working areas where you
425
are doing the development, and any server areas that you use for hosting
426
projects. In the latter case, it is common to want branches without working
427
trees. Since the files in the branch will not be edited directly there is no
428
need to use up disk space for a working tree. To create a repository in which
429
the branches will not have working trees pass the '--no-trees' option to
434
init-repository Create a shared repository. Use --no-trees to create one
435
in which new branches won't get a working tree.
442
A working tree is the contents of a branch placed on disk so that you can
443
see the files and edit them. The working tree is where you make changes to a
444
branch, and when you commit the current state of the working tree is the
445
snapshot that is recorded in the commit.
447
When you push a branch to a remote system, a working tree will not be
448
created. If one is already present the files will not be updated. The
449
branch information will be updated and the working tree will be marked
450
as out-of-date. Updating a working tree remotely is difficult, as there
451
may be uncommitted changes or the update may cause content conflicts that are
452
difficult to deal with remotely.
454
If you have a branch with no working tree you can use the 'checkout' command
455
to create a working tree. If you run 'bzr checkout .' from the branch it will
456
create the working tree. If the branch is updated remotely, you can update the
457
working tree by running 'bzr update' in that directory.
459
If you have a branch with a working tree that you do not want the 'remove-tree'
460
command will remove the tree if it is safe. This can be done to avoid the
461
warning about the remote working tree not being updated when pushing to the
462
branch. It can also be useful when working with a '--no-trees' repository
463
(see 'bzr help repositories').
465
If you want to have a working tree on a remote machine that you push to you
466
can either run 'bzr update' in the remote branch after each push, or use some
467
other method to update the tree during the push. There is an 'rspush' plugin
468
that will update the working tree using rsync as well as doing a push. There
469
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
474
checkout Create a working tree when a branch does not have one.
475
remove-tree Removes the working tree from a branch when it is safe to do so.
476
update When a working tree is out of sync with it's associated branch
477
this will update the tree to match the branch.
484
A branch consists of the state of a project, including all of its
485
history. All branches have a repository associated (which is where the
486
branch history is stored), but multiple branches may share the same
487
repository (a shared repository). Branches can be copied and merged.
491
init Change a directory into a versioned branch.
492
branch Create a new copy of a branch.
493
merge Perform a three-way merge.
497
_standalone_trees = \
500
A standalone tree is a working tree with an associated repository. It
501
is an independently usable branch, with no dependencies on any other.
502
Creating a standalone tree (via bzr init) is the quickest way to put
503
an existing project under version control.
507
init Make a directory into a versioned branch.
514
Status flags are used to summarise changes to the working tree in a concise
515
manner. They are in the form::
519
where the columns' meanings are as follows.
521
Column 1 - versioning/renames::
527
X File nonexistent (and unknown to bzr)
529
P Entry for a pending merge (not a file)
531
Column 2 - contents::
540
* The execute bit was changed
545
"""Environment Variables
547
================ =================================================================
548
BZRPATH Path where bzr is to look for shell plugin external commands.
549
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
550
EMAIL E-Mail address of the user.
551
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
552
EDITOR Editor for editing commit messages.
553
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
554
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
555
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
556
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
557
BZR_SSH SSH client: paramiko (default), openssh, ssh, plink.
558
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
559
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
560
================ =================================================================
567
:On Linux: ~/.bazaar/bazaar.conf
568
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
570
Contains the user's default configuration. The section ``[DEFAULT]`` is
571
used to define general configuration that will be applied everywhere.
572
The section ``[ALIASES]`` can be used to create command aliases for
573
commonly used options.
575
A typical config file might look something like::
578
email=John Doe <jdoe@isp.com>
581
commit = commit --strict
582
log10 = log --short -r -10..-1
588
A criss-cross in the branch history can cause the default merge technique
589
to emit more conflicts than would normally be expected.
591
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
592
better results. You may wish to ``bzr revert`` the working tree and merge
593
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
595
Criss-crosses occur in a branch's history if two branches merge the same thing
596
and then merge one another, or if two branches merge one another at the same
597
time. They can be avoided by having each branch only merge from or into a
598
designated central branch (a "star topology").
600
Criss-crosses cause problems because of the way merge works. Bazaar's default
601
merge is a three-way merger; in order to merge OTHER into THIS, it must
602
find a basis for comparison, BASE. Using BASE, it can determine whether
603
differences between THIS and OTHER are due to one side adding lines, or
604
from another side removing lines.
606
Criss-crosses mean there is no good choice for a base. Selecting the recent
607
merge points could cause one side's changes to be silently discarded.
608
Selecting older merge points (which Bazaar does) mean that extra conflicts
611
The ``weave`` merge type is not affected by this problem because it uses
612
line-origin detection instead of a basis revision to determine the cause of
616
_branches_out_of_sync = """Branches out of sync
618
When reconfiguring a checkout, tree or branch into a lightweight checkout,
619
a local branch must be destroyed. (For checkouts, this is the local branch
620
that serves primarily as a cache.) If the branch-to-be-destroyed does not
621
have the same last revision as the new reference branch for the lightweight
622
checkout, data could be lost, so Bazaar refuses.
624
How you deal with this depends on *why* the branches are out of sync.
626
If you have a checkout and have done local commits, you can get back in sync
627
by running "bzr update" (and possibly "bzr commit").
629
If you have a branch and the remote branch is out-of-date, you can push
630
the local changes using "bzr push". If the local branch is out of date, you
631
can do "bzr pull". If both branches have had changes, you can merge, commit
632
and then push your changes. If you decide that some of the changes aren't
633
useful, you can "push --overwrite" or "pull --overwrite" instead.
640
To ensure that older clients do not access data incorrectly,
641
Bazaar's policy is to introduce a new storage format whenever
642
new features requiring new metadata are added. New storage
643
formats may also be introduced to improve performance and
646
Use the following guidelines to select a format (stopping
647
as soon as a condition is true):
649
* If you are working on an existing project, use whatever
650
format that project is using. (Bazaar will do this for you
653
* If you are using bzr-svn to interoperate with a Subversion
654
repository, use 1.14-rich-root.
656
* If you are working on a project with big trees (5000+ paths)
657
or deep history (5000+ revisions), use 1.14.
659
* Otherwise, use the default format - it is good enough for
662
If some of your developers are unable to use the most recent
663
version of Bazaar (due to distro package availability say), be
664
sure to adjust the guidelines above accordingly. For example,
665
you may need to select 1.9 instead of 1.14 if your project has
666
standardized on Bazaar 1.13.1 say.
668
Note: Many of the currently supported formats have two variants:
669
a plain one and a rich-root one. The latter include an additional
670
field about the root of the tree. There is no performance cost
671
for using a rich-root format but you cannot easily merge changes
672
from a rich-root format into a plain format. As a consequence,
673
moving a project to a rich-root format takes some co-ordination
674
in that all contributors need to upgrade their repositories
675
around the same time. (It is for this reason that we have delayed
676
making a rich-root format the default so far, though we will do
677
so at some appropriate time in the future.)
679
See ``bzr help current-formats`` for the complete list of
680
currently supported formats. See ``bzr help other-formats`` for
681
descriptions of any available experimental and deprecated formats.
685
# Register help topics
686
233
topic_registry.register("revisionspec", _help_on_revisionspec,
687
234
"Explain how to use --revision")
688
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
689
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
690
def get_current_formats_topic(topic):
691
from bzrlib import bzrdir
692
return "Current Storage Formats\n\n" + \
693
bzrdir.format_registry.help_topic(topic)
694
def get_other_formats_topic(topic):
695
from bzrlib import bzrdir
696
return "Other Storage Formats\n\n" + \
697
bzrdir.format_registry.help_topic(topic)
698
topic_registry.register('current-formats', get_current_formats_topic,
699
'Current storage formats')
700
topic_registry.register('other-formats', get_other_formats_topic,
701
'Experimental and deprecated storage formats')
702
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,
703
242
'Options that can be used with any command')
704
topic_registry.register('global-options', _global_options,
705
'Options that control how Bazaar runs')
706
topic_registry.register('urlspec', _help_on_transport,
707
"Supported transport protocols")
708
topic_registry.register('status-flags', _status_flags,
709
"Help on status flags")
710
def get_bugs_topic(topic):
711
from bzrlib import bugtracker
712
return ("Bug Tracker Settings\n\n" +
713
bugtracker.tracker_registry.help_topic(topic))
714
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
715
topic_registry.register('env-variables', _env_variables,
716
'Environment variable names and values')
717
topic_registry.register('files', _files,
718
'Information on configuration and log files')
719
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
720
'Points at which custom processing can be added')
722
# Load some of the help topics from files. Note that topics which reproduce API
723
# details will tend to skew (quickly usually!) so please seek other solutions
725
topic_registry.register('authentication', _load_from_file,
726
'Information on configuring authentication')
727
topic_registry.register('configuration', _load_from_file,
728
'Details on the configuration settings available')
729
topic_registry.register('conflicts', _load_from_file,
730
'Types of conflicts and what to do about them')
731
topic_registry.register('debug-flags', _load_from_file,
732
'Options to show or record debug information')
733
topic_registry.register('log-formats', _load_from_file,
734
'Details on the logging formats available')
737
# Register concept topics.
738
# Note that we might choose to remove these from the online help in the
739
# future or implement them via loading content from files. In the meantime,
740
# please keep them concise.
741
topic_registry.register('branches', _branches,
742
'Information on what a branch is', SECT_CONCEPT)
743
243
topic_registry.register('checkouts', _checkouts,
744
'Information on what a checkout is', SECT_CONCEPT)
745
topic_registry.register('content-filters', _load_from_file,
746
'Conversion of content into/from working trees',
748
topic_registry.register('eol', _load_from_file,
749
'Information on end-of-line handling',
751
topic_registry.register('formats', _storage_formats,
752
'Information on choosing a storage format',
754
topic_registry.register('patterns', _load_from_file,
755
'Information on the pattern syntax',
757
topic_registry.register('repositories', _repositories,
758
'Basic information on shared repositories.',
760
topic_registry.register('rules', _load_from_file,
761
'Information on defining rule-based preferences',
763
topic_registry.register('standalone-trees', _standalone_trees,
764
'Information on what a standalone tree is',
766
topic_registry.register('working-trees', _working_trees,
767
'Information on working trees', SECT_CONCEPT)
768
topic_registry.register('criss-cross', _criss_cross,
769
'Information on criss-cross merging', SECT_CONCEPT)
770
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
771
'Steps to resolve "out-of-sync" when reconfiguring',
775
class HelpTopicIndex(object):
776
"""A index for bzr help that returns topics."""
781
def get_topics(self, topic):
782
"""Search for topic in the HelpTopicRegistry.
784
:param topic: A topic to search for. None is treated as 'basic'.
785
:return: A list which is either empty or contains a single
786
RegisteredTopic entry.
790
if topic in topic_registry:
791
return [RegisteredTopic(topic)]
796
class RegisteredTopic(object):
797
"""A help topic which has been registered in the HelpTopicRegistry.
799
These topics consist of nothing more than the name of the topic - all
800
data is retrieved on demand from the registry.
803
def __init__(self, topic):
806
:param topic: The name of the topic that this represents.
810
def get_help_text(self, additional_see_also=None, plain=True):
811
"""Return a string with the help for this topic.
813
:param additional_see_also: Additional help topics to be
815
:param plain: if False, raw help (reStructuredText) is
816
returned instead of plain text.
818
result = topic_registry.get_detail(self.topic)
819
# there is code duplicated here and in bzrlib/plugin.py's
820
# matching Topic code. This should probably be factored in
821
# to a helper function and a common base class.
822
if additional_see_also is not None:
823
see_also = sorted(set(additional_see_also))
827
result += '\n:See also: '
828
result += ', '.join(see_also)
831
result = help_as_plain_text(result)
834
def get_help_topic(self):
835
"""Return the help topic this can be found under."""
839
def help_as_plain_text(text):
840
"""Minimal converter of reStructuredText to plain text."""
841
lines = text.splitlines()
844
if line.startswith(':'):
846
elif line.endswith('::'):
849
return "\n".join(result) + "\n"
244
'Information on what a checkout is')
added
removed
bzrlib/help_topics.py
