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.
36
from __future__ import absolute_import
47
# Section identifiers (map topics to the right place in the manual)
48
SECT_COMMAND = "command"
49
SECT_CONCEPT = "concept"
50
SECT_HIDDEN = "hidden"
52
SECT_PLUGIN = "plugin"
23
from bzrlib import registry
55
26
class HelpTopicRegistry(registry.Registry):
56
27
"""A Registry customized for handling help topics."""
58
def register(self, topic, detail, summary, section=SECT_LIST):
29
def register(self, topic, detail, summary):
59
30
"""Register a new help topic.
61
32
:param topic: Name of documentation entry
62
33
:param detail: Function or string object providing detailed
63
34
documentation for topic. Function interface is detail(topic).
64
35
This should return a text string of the detailed information.
65
See the module documentation for details on help text formatting.
66
36
:param summary: String providing single-line documentation for topic.
67
:param section: Section in reference manual - see SECT_* identifiers.
69
# The detail is stored as the 'object' and the metadata as the info
70
info = (summary, section)
71
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)
73
def register_lazy(self, topic, module_name, member_name, summary,
41
def register_lazy(self, topic, module_name, member_name, summary):
75
42
"""Register a new help topic, and import the details on demand.
77
44
:param topic: Name of documentation entry
78
45
:param module_name: The module to find the detailed help.
79
46
:param member_name: The member of the module to use for detailed help.
80
47
:param summary: String providing single-line documentation for topic.
81
:param section: Section in reference manual - see SECT_* identifiers.
83
# The detail is stored as the 'object' and the metadata as the info
84
info = (summary, section)
85
49
super(HelpTopicRegistry, self).register_lazy(topic, module_name,
86
member_name, info=info)
50
member_name, info=summary)
88
52
def get_detail(self, topic):
89
53
"""Get the detailed help on a given topic."""
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)
95
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
98
out.append(" %s %s\n\n" % (i.prefix, doc))
211
103
def _help_on_transport(name):
515
344
is also a 'push-and-update' plugin that automates running 'bzr update' via SSH
520
349
checkout Create a working tree when a branch does not have one.
521
350
remove-tree Removes the working tree from a branch when it is safe to do so.
522
update When a working tree is out of sync with its associated branch
351
update When a working tree is out of sync with it's associated branch
523
352
this will update the tree to match the branch.
530
A branch consists of the state of a project, including all of its
531
history. All branches have a repository associated (which is where the
532
branch history is stored), but multiple branches may share the same
533
repository (a shared repository). Branches can be copied and merged.
535
In addition, one branch may be bound to another one. Binding to another
536
branch indicates that commits which happen in this branch must also
537
happen in the other branch. Bazaar ensures consistency by not allowing
538
commits when the two branches are out of date. In order for a commit
539
to succeed, it may be necessary to update the current branch using
544
init Change a directory into a versioned branch.
545
branch Create a new branch that is a copy of an existing branch.
546
merge Perform a three-way merge.
547
bind Bind a branch to another one.
551
_standalone_trees = \
554
A standalone tree is a working tree with an associated repository. It
555
is an independently usable branch, with no dependencies on any other.
556
Creating a standalone tree (via bzr init) is the quickest way to put
557
an existing project under version control.
561
init Make a directory into a versioned branch.
568
Status flags are used to summarise changes to the working tree in a concise
569
manner. They are in the form::
573
where the columns' meanings are as follows.
575
Column 1 - versioning/renames::
581
X File nonexistent (and unknown to bzr)
583
P Entry for a pending merge (not a file)
585
Column 2 - contents::
594
* The execute bit was changed
599
"""Environment Variables
601
=================== ===========================================================
602
BZRPATH Path where bzr is to look for shell plugin external
604
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
605
EMAIL E-Mail address of the user.
606
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
607
EDITOR Editor for editing commit messages.
608
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
609
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
610
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
611
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
612
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and
614
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
615
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp,
617
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
618
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
619
BZR_COLUMNS Override implicit terminal width.
620
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest)
621
BZR_PROGRESS_BAR Override the progress display. Values are 'none' or 'text'.
622
BZR_PDB Control whether to launch a debugger on error.
623
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a
625
BZR_TEXTUI_INPUT Force console input mode for prompts to line-based (instead
627
=================== ===========================================================
634
:On Unix: ~/.bazaar/bazaar.conf
635
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
637
Contains the user's default configuration. The section ``[DEFAULT]`` is
638
used to define general configuration that will be applied everywhere.
639
The section ``[ALIASES]`` can be used to create command aliases for
640
commonly used options.
642
A typical config file might look something like::
645
email=John Doe <jdoe@isp.com>
648
commit = commit --strict
649
log10 = log --short -r -10..-1
655
A criss-cross in the branch history can cause the default merge technique
656
to emit more conflicts than would normally be expected.
658
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
659
better results. You may wish to ``bzr revert`` the working tree and merge
660
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
662
Criss-crosses occur in a branch's history if two branches merge the same thing
663
and then merge one another, or if two branches merge one another at the same
664
time. They can be avoided by having each branch only merge from or into a
665
designated central branch (a "star topology").
667
Criss-crosses cause problems because of the way merge works. Bazaar's default
668
merge is a three-way merger; in order to merge OTHER into THIS, it must
669
find a basis for comparison, BASE. Using BASE, it can determine whether
670
differences between THIS and OTHER are due to one side adding lines, or
671
from another side removing lines.
673
Criss-crosses mean there is no good choice for a base. Selecting the recent
674
merge points could cause one side's changes to be silently discarded.
675
Selecting older merge points (which Bazaar does) mean that extra conflicts
678
The ``weave`` merge type is not affected by this problem because it uses
679
line-origin detection instead of a basis revision to determine the cause of
683
_branches_out_of_sync = """Branches Out of Sync
685
When reconfiguring a checkout, tree or branch into a lightweight checkout,
686
a local branch must be destroyed. (For checkouts, this is the local branch
687
that serves primarily as a cache.) If the branch-to-be-destroyed does not
688
have the same last revision as the new reference branch for the lightweight
689
checkout, data could be lost, so Bazaar refuses.
691
How you deal with this depends on *why* the branches are out of sync.
693
If you have a checkout and have done local commits, you can get back in sync
694
by running "bzr update" (and possibly "bzr commit").
696
If you have a branch and the remote branch is out-of-date, you can push
697
the local changes using "bzr push". If the local branch is out of date, you
698
can do "bzr pull". If both branches have had changes, you can merge, commit
699
and then push your changes. If you decide that some of the changes aren't
700
useful, you can "push --overwrite" or "pull --overwrite" instead.
707
To ensure that older clients do not access data incorrectly,
708
Bazaar's policy is to introduce a new storage format whenever
709
new features requiring new metadata are added. New storage
710
formats may also be introduced to improve performance and
713
The newest format, 2a, is highly recommended. If your
714
project is not using 2a, then you should suggest to the
715
project owner to upgrade.
720
Some of the older formats have two variants:
721
a plain one and a rich-root one. The latter include an additional
722
field about the root of the tree. There is no performance cost
723
for using a rich-root format but you cannot easily merge changes
724
from a rich-root format into a plain format. As a consequence,
725
moving a project to a rich-root format takes some co-ordination
726
in that all contributors need to upgrade their repositories
727
around the same time. 2a and all future formats will be
728
implicitly rich-root.
730
See :doc:`current-formats-help` for the complete list of
731
currently supported formats. See :doc:`other-formats-help` for
732
descriptions of any available experimental and deprecated formats.
736
# Register help topics
737
356
topic_registry.register("revisionspec", _help_on_revisionspec,
738
357
"Explain how to use --revision")
739
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
740
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
741
def get_current_formats_topic(topic):
742
from bzrlib import bzrdir
743
return "Current Storage Formats\n\n" + \
744
bzrdir.format_registry.help_topic(topic)
745
def get_other_formats_topic(topic):
746
from bzrlib import bzrdir
747
return "Other Storage Formats\n\n" + \
748
bzrdir.format_registry.help_topic(topic)
749
topic_registry.register('current-formats', get_current_formats_topic,
750
'Current storage formats')
751
topic_registry.register('other-formats', get_other_formats_topic,
752
'Experimental and deprecated storage formats')
753
topic_registry.register('standard-options', _standard_options,
358
topic_registry.register('basic', _basic_help, "Basic commands")
359
topic_registry.register('topics', _help_on_topics, "Topics list")
360
def get_format_topic(topic):
361
from bzrlib import bzrdir
362
return bzrdir.format_registry.help_topic(topic)
363
topic_registry.register('formats', get_format_topic, 'Directory formats')
364
topic_registry.register('global-options', _global_options,
754
365
'Options that can be used with any command')
755
topic_registry.register('global-options', _global_options,
756
'Options that control how Bazaar runs')
366
topic_registry.register('checkouts', _checkouts,
367
'Information on what a checkout is')
757
368
topic_registry.register('urlspec', _help_on_transport,
758
369
"Supported transport protocols")
759
topic_registry.register('status-flags', _status_flags,
760
"Help on status flags")
761
370
def get_bugs_topic(topic):
762
371
from bzrlib import bugtracker
763
return ("Bug Tracker Settings\n\n" +
764
bugtracker.tracker_registry.help_topic(topic))
765
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
766
topic_registry.register('env-variables', _env_variables,
767
'Environment variable names and values')
768
topic_registry.register('files', _files,
769
'Information on configuration and log files')
770
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
771
'Points at which custom processing can be added')
772
topic_registry.register_lazy('location-alias', 'bzrlib.directory_service',
773
'AliasDirectory.help_text',
774
'Aliases for remembered locations')
776
# Load some of the help topics from files. Note that topics which reproduce API
777
# details will tend to skew (quickly usually!) so please seek other solutions
779
topic_registry.register('authentication', _load_from_file,
780
'Information on configuring authentication')
781
topic_registry.register('configuration', _load_from_file,
782
'Details on the configuration settings available')
783
topic_registry.register('conflict-types', _load_from_file,
784
'Types of conflicts and what to do about them')
785
topic_registry.register('debug-flags', _load_from_file,
786
'Options to show or record debug information')
787
topic_registry.register('log-formats', _load_from_file,
788
'Details on the logging formats available')
789
topic_registry.register('url-special-chars', _load_from_file,
790
'Special character handling in URLs')
793
# Register concept topics.
794
# Note that we might choose to remove these from the online help in the
795
# future or implement them via loading content from files. In the meantime,
796
# please keep them concise.
797
topic_registry.register('branches', _branches,
798
'Information on what a branch is', SECT_CONCEPT)
799
topic_registry.register('checkouts', _checkouts,
800
'Information on what a checkout is', SECT_CONCEPT)
801
topic_registry.register('content-filters', _load_from_file,
802
'Conversion of content into/from working trees',
804
topic_registry.register('diverged-branches', _load_from_file,
805
'How to fix diverged branches',
807
topic_registry.register('eol', _load_from_file,
808
'Information on end-of-line handling',
810
topic_registry.register('formats', _storage_formats,
811
'Information on choosing a storage format',
813
topic_registry.register('patterns', _load_from_file,
814
'Information on the pattern syntax',
372
return bugtracker.tracker_registry.help_topic(topic)
373
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
816
374
topic_registry.register('repositories', _repositories,
817
'Basic information on shared repositories.',
819
topic_registry.register('rules', _load_from_file,
820
'Information on defining rule-based preferences',
822
topic_registry.register('standalone-trees', _standalone_trees,
823
'Information on what a standalone tree is',
375
'Basic information on shared repositories.')
825
376
topic_registry.register('working-trees', _working_trees,
826
'Information on working trees', SECT_CONCEPT)
827
topic_registry.register('criss-cross', _criss_cross,
828
'Information on criss-cross merging', SECT_CONCEPT)
829
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
830
'Steps to resolve "out-of-sync" when reconfiguring',
377
'Information on working trees')
834
380
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
