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
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)
95
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
98
out.append(" %s %s\n\n" % (i.prefix, doc))
209
103
def _help_on_transport(name):
518
A branch consists of the state of a project, including all of its
519
history. All branches have a repository associated (which is where the
520
branch history is stored), but multiple branches may share the same
521
repository (a shared repository). Branches can be copied and merged.
523
In addition, one branch may be bound to another one. Binding to another
524
branch indicates that commits which happen in this branch must also
525
happen in the other branch. Bazaar ensures consistency by not allowing
526
commits when the two branches are out of date. In order for a commit
527
to succeed, it may be necessary to update the current branch using
532
init Change a directory into a versioned branch.
533
branch Create a new branch that is a copy of an existing branch.
534
merge Perform a three-way merge.
535
bind Bind a branch to another one.
539
_standalone_trees = \
542
A standalone tree is a working tree with an associated repository. It
543
is an independently usable branch, with no dependencies on any other.
544
Creating a standalone tree (via bzr init) is the quickest way to put
545
an existing project under version control.
549
init Make a directory into a versioned branch.
556
Status flags are used to summarise changes to the working tree in a concise
557
manner. They are in the form::
561
where the columns' meanings are as follows.
563
Column 1 - versioning/renames::
569
X File nonexistent (and unknown to bzr)
571
P Entry for a pending merge (not a file)
573
Column 2 - contents::
582
* The execute bit was changed
587
"""Environment Variables
589
================ =================================================================
590
BZRPATH Path where bzr is to look for shell plugin external commands.
591
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
592
EMAIL E-Mail address of the user.
593
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
594
EDITOR Editor for editing commit messages.
595
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
596
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
597
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
598
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
599
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
600
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
601
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
602
BZR_COLUMNS Override implicit terminal width.
603
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest).
604
================ =================================================================
611
:On Linux: ~/.bazaar/bazaar.conf
612
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
614
Contains the user's default configuration. The section ``[DEFAULT]`` is
615
used to define general configuration that will be applied everywhere.
616
The section ``[ALIASES]`` can be used to create command aliases for
617
commonly used options.
619
A typical config file might look something like::
622
email=John Doe <jdoe@isp.com>
625
commit = commit --strict
626
log10 = log --short -r -10..-1
632
A criss-cross in the branch history can cause the default merge technique
633
to emit more conflicts than would normally be expected.
635
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
636
better results. You may wish to ``bzr revert`` the working tree and merge
637
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
639
Criss-crosses occur in a branch's history if two branches merge the same thing
640
and then merge one another, or if two branches merge one another at the same
641
time. They can be avoided by having each branch only merge from or into a
642
designated central branch (a "star topology").
644
Criss-crosses cause problems because of the way merge works. Bazaar's default
645
merge is a three-way merger; in order to merge OTHER into THIS, it must
646
find a basis for comparison, BASE. Using BASE, it can determine whether
647
differences between THIS and OTHER are due to one side adding lines, or
648
from another side removing lines.
650
Criss-crosses mean there is no good choice for a base. Selecting the recent
651
merge points could cause one side's changes to be silently discarded.
652
Selecting older merge points (which Bazaar does) mean that extra conflicts
655
The ``weave`` merge type is not affected by this problem because it uses
656
line-origin detection instead of a basis revision to determine the cause of
660
_branches_out_of_sync = """Branches Out of Sync
662
When reconfiguring a checkout, tree or branch into a lightweight checkout,
663
a local branch must be destroyed. (For checkouts, this is the local branch
664
that serves primarily as a cache.) If the branch-to-be-destroyed does not
665
have the same last revision as the new reference branch for the lightweight
666
checkout, data could be lost, so Bazaar refuses.
668
How you deal with this depends on *why* the branches are out of sync.
670
If you have a checkout and have done local commits, you can get back in sync
671
by running "bzr update" (and possibly "bzr commit").
673
If you have a branch and the remote branch is out-of-date, you can push
674
the local changes using "bzr push". If the local branch is out of date, you
675
can do "bzr pull". If both branches have had changes, you can merge, commit
676
and then push your changes. If you decide that some of the changes aren't
677
useful, you can "push --overwrite" or "pull --overwrite" instead.
684
To ensure that older clients do not access data incorrectly,
685
Bazaar's policy is to introduce a new storage format whenever
686
new features requiring new metadata are added. New storage
687
formats may also be introduced to improve performance and
690
The newest format, 2a, is highly recommended. If your
691
project is not using 2a, then you should suggest to the
692
project owner to upgrade.
697
Some of the older formats have two variants:
698
a plain one and a rich-root one. The latter include an additional
699
field about the root of the tree. There is no performance cost
700
for using a rich-root format but you cannot easily merge changes
701
from a rich-root format into a plain format. As a consequence,
702
moving a project to a rich-root format takes some co-ordination
703
in that all contributors need to upgrade their repositories
704
around the same time. 2a and all future formats will be
705
implicitly rich-root.
707
See :doc:`current-formats-help` for the complete list of
708
currently supported formats. See :doc:`other-formats-help` for
709
descriptions of any available experimental and deprecated formats.
713
# Register help topics
714
361
topic_registry.register("revisionspec", _help_on_revisionspec,
715
362
"Explain how to use --revision")
716
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
717
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
718
def get_current_formats_topic(topic):
719
from bzrlib import bzrdir
720
return "Current Storage Formats\n\n" + \
721
bzrdir.format_registry.help_topic(topic)
722
def get_other_formats_topic(topic):
723
from bzrlib import bzrdir
724
return "Other Storage Formats\n\n" + \
725
bzrdir.format_registry.help_topic(topic)
726
topic_registry.register('current-formats', get_current_formats_topic,
727
'Current storage formats')
728
topic_registry.register('other-formats', get_other_formats_topic,
729
'Experimental and deprecated storage formats')
730
topic_registry.register('standard-options', _standard_options,
363
topic_registry.register('basic', _basic_help, "Basic commands")
364
topic_registry.register('topics', _help_on_topics, "Topics list")
365
def get_format_topic(topic):
366
from bzrlib import bzrdir
367
return bzrdir.format_registry.help_topic(topic)
368
topic_registry.register('formats', get_format_topic, 'Directory formats')
369
topic_registry.register('global-options', _global_options,
731
370
'Options that can be used with any command')
732
topic_registry.register('global-options', _global_options,
733
'Options that control how Bazaar runs')
371
topic_registry.register('checkouts', _checkouts,
372
'Information on what a checkout is')
734
373
topic_registry.register('urlspec', _help_on_transport,
735
374
"Supported transport protocols")
736
topic_registry.register('status-flags', _status_flags,
737
"Help on status flags")
738
375
def get_bugs_topic(topic):
739
376
from bzrlib import bugtracker
740
return ("Bug Tracker Settings\n\n" +
741
bugtracker.tracker_registry.help_topic(topic))
742
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
743
topic_registry.register('env-variables', _env_variables,
744
'Environment variable names and values')
745
topic_registry.register('files', _files,
746
'Information on configuration and log files')
747
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
748
'Points at which custom processing can be added')
750
# Load some of the help topics from files. Note that topics which reproduce API
751
# details will tend to skew (quickly usually!) so please seek other solutions
753
topic_registry.register('authentication', _load_from_file,
754
'Information on configuring authentication')
755
topic_registry.register('configuration', _load_from_file,
756
'Details on the configuration settings available')
757
topic_registry.register('conflict-types', _load_from_file,
758
'Types of conflicts and what to do about them')
759
topic_registry.register('debug-flags', _load_from_file,
760
'Options to show or record debug information')
761
topic_registry.register('log-formats', _load_from_file,
762
'Details on the logging formats available')
765
# Register concept topics.
766
# Note that we might choose to remove these from the online help in the
767
# future or implement them via loading content from files. In the meantime,
768
# please keep them concise.
769
topic_registry.register('branches', _branches,
770
'Information on what a branch is', SECT_CONCEPT)
771
topic_registry.register('checkouts', _checkouts,
772
'Information on what a checkout is', SECT_CONCEPT)
773
topic_registry.register('content-filters', _load_from_file,
774
'Conversion of content into/from working trees',
776
topic_registry.register('diverged-branches', _load_from_file,
777
'How to fix diverged branches',
779
topic_registry.register('eol', _load_from_file,
780
'Information on end-of-line handling',
782
topic_registry.register('formats', _storage_formats,
783
'Information on choosing a storage format',
785
topic_registry.register('patterns', _load_from_file,
786
'Information on the pattern syntax',
377
return bugtracker.tracker_registry.help_topic(topic)
378
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
788
379
topic_registry.register('repositories', _repositories,
789
'Basic information on shared repositories.',
791
topic_registry.register('rules', _load_from_file,
792
'Information on defining rule-based preferences',
794
topic_registry.register('standalone-trees', _standalone_trees,
795
'Information on what a standalone tree is',
380
'Basic information on shared repositories.')
797
381
topic_registry.register('working-trees', _working_trees,
798
'Information on working trees', SECT_CONCEPT)
799
topic_registry.register('criss-cross', _criss_cross,
800
'Information on criss-cross merging', SECT_CONCEPT)
801
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
802
'Steps to resolve "out-of-sync" when reconfiguring',
382
'Information on working trees')
806
385
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
