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):
516
366
this will update the tree to match the branch.
523
A branch consists of the state of a project, including all of its
524
history. All branches have a repository associated (which is where the
525
branch history is stored), but multiple branches may share the same
526
repository (a shared repository). Branches can be copied and merged.
528
In addition, one branch may be bound to another one. Binding to another
529
branch indicates that commits which happen in this branch must also
530
happen in the other branch. Bazaar ensures consistency by not allowing
531
commits when the two branches are out of date. In order for a commit
532
to succeed, it may be necessary to update the current branch using
537
init Change a directory into a versioned branch.
538
branch Create a new branch that is a copy of an existing branch.
539
merge Perform a three-way merge.
540
bind Bind a branch to another one.
544
_standalone_trees = \
547
A standalone tree is a working tree with an associated repository. It
548
is an independently usable branch, with no dependencies on any other.
549
Creating a standalone tree (via bzr init) is the quickest way to put
550
an existing project under version control.
554
init Make a directory into a versioned branch.
558
369
_status_flags = \
561
372
Status flags are used to summarise changes to the working tree in a concise
562
manner. They are in the form::
373
manner. They are in the form:
566
375
where the columns' meanings are as follows.
568
Column 1 - versioning/renames::
377
Column 1: versioning / renames
571
379
- File unversioned
574
X File nonexistent (and unknown to bzr)
575
382
C File has conflicts
576
383
P Entry for a pending merge (not a file)
578
Column 2 - contents::
582
388
K File kind changed
587
392
* The execute bit was changed
592
"""Environment Variables
594
================ =================================================================
595
BZRPATH Path where bzr is to look for shell plugin external commands.
596
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
597
EMAIL E-Mail address of the user.
598
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
599
EDITOR Editor for editing commit messages.
600
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
601
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
602
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
603
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
604
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
605
BZR_LOG Location of .bzr.log (use '/dev/null' to suppress log).
606
BZR_LOG (Win32) Location of .bzr.log (use 'NUL' to suppress log).
607
BZR_COLUMNS Override implicit terminal width.
608
BZR_CONCURRENCY Number of processes that can be run concurrently (selftest).
609
================ =================================================================
616
:On Linux: ~/.bazaar/bazaar.conf
617
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
619
Contains the user's default configuration. The section ``[DEFAULT]`` is
620
used to define general configuration that will be applied everywhere.
621
The section ``[ALIASES]`` can be used to create command aliases for
622
commonly used options.
624
A typical config file might look something like::
627
email=John Doe <jdoe@isp.com>
630
commit = commit --strict
631
log10 = log --short -r -10..-1
637
A criss-cross in the branch history can cause the default merge technique
638
to emit more conflicts than would normally be expected.
640
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
641
better results. You may wish to ``bzr revert`` the working tree and merge
642
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
644
Criss-crosses occur in a branch's history if two branches merge the same thing
645
and then merge one another, or if two branches merge one another at the same
646
time. They can be avoided by having each branch only merge from or into a
647
designated central branch (a "star topology").
649
Criss-crosses cause problems because of the way merge works. Bazaar's default
650
merge is a three-way merger; in order to merge OTHER into THIS, it must
651
find a basis for comparison, BASE. Using BASE, it can determine whether
652
differences between THIS and OTHER are due to one side adding lines, or
653
from another side removing lines.
655
Criss-crosses mean there is no good choice for a base. Selecting the recent
656
merge points could cause one side's changes to be silently discarded.
657
Selecting older merge points (which Bazaar does) mean that extra conflicts
660
The ``weave`` merge type is not affected by this problem because it uses
661
line-origin detection instead of a basis revision to determine the cause of
665
_branches_out_of_sync = """Branches Out of Sync
667
When reconfiguring a checkout, tree or branch into a lightweight checkout,
668
a local branch must be destroyed. (For checkouts, this is the local branch
669
that serves primarily as a cache.) If the branch-to-be-destroyed does not
670
have the same last revision as the new reference branch for the lightweight
671
checkout, data could be lost, so Bazaar refuses.
673
How you deal with this depends on *why* the branches are out of sync.
675
If you have a checkout and have done local commits, you can get back in sync
676
by running "bzr update" (and possibly "bzr commit").
678
If you have a branch and the remote branch is out-of-date, you can push
679
the local changes using "bzr push". If the local branch is out of date, you
680
can do "bzr pull". If both branches have had changes, you can merge, commit
681
and then push your changes. If you decide that some of the changes aren't
682
useful, you can "push --overwrite" or "pull --overwrite" instead.
689
To ensure that older clients do not access data incorrectly,
690
Bazaar's policy is to introduce a new storage format whenever
691
new features requiring new metadata are added. New storage
692
formats may also be introduced to improve performance and
695
The newest format, 2a, is highly recommended. If your
696
project is not using 2a, then you should suggest to the
697
project owner to upgrade.
702
Some of the older formats have two variants:
703
a plain one and a rich-root one. The latter include an additional
704
field about the root of the tree. There is no performance cost
705
for using a rich-root format but you cannot easily merge changes
706
from a rich-root format into a plain format. As a consequence,
707
moving a project to a rich-root format takes some co-ordination
708
in that all contributors need to upgrade their repositories
709
around the same time. 2a and all future formats will be
710
implicitly rich-root.
712
See :doc:`current-formats-help` for the complete list of
713
currently supported formats. See :doc:`other-formats-help` for
714
descriptions of any available experimental and deprecated formats.
718
# Register help topics
719
396
topic_registry.register("revisionspec", _help_on_revisionspec,
720
397
"Explain how to use --revision")
721
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
722
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
723
def get_current_formats_topic(topic):
724
from bzrlib import bzrdir
725
return "Current Storage Formats\n\n" + \
726
bzrdir.format_registry.help_topic(topic)
727
def get_other_formats_topic(topic):
728
from bzrlib import bzrdir
729
return "Other Storage Formats\n\n" + \
730
bzrdir.format_registry.help_topic(topic)
731
topic_registry.register('current-formats', get_current_formats_topic,
732
'Current storage formats')
733
topic_registry.register('other-formats', get_other_formats_topic,
734
'Experimental and deprecated storage formats')
735
topic_registry.register('standard-options', _standard_options,
398
topic_registry.register('basic', _basic_help, "Basic commands")
399
topic_registry.register('topics', _help_on_topics, "Topics list")
400
def get_format_topic(topic):
401
from bzrlib import bzrdir
402
return bzrdir.format_registry.help_topic(topic)
403
topic_registry.register('formats', get_format_topic, 'Directory formats')
404
topic_registry.register('global-options', _global_options,
736
405
'Options that can be used with any command')
737
topic_registry.register('global-options', _global_options,
738
'Options that control how Bazaar runs')
406
topic_registry.register('checkouts', _checkouts,
407
'Information on what a checkout is')
739
408
topic_registry.register('urlspec', _help_on_transport,
740
409
"Supported transport protocols")
741
410
topic_registry.register('status-flags', _status_flags,
742
411
"Help on status flags")
743
412
def get_bugs_topic(topic):
744
413
from bzrlib import bugtracker
745
return ("Bug Tracker Settings\n\n" +
746
bugtracker.tracker_registry.help_topic(topic))
747
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
748
topic_registry.register('env-variables', _env_variables,
749
'Environment variable names and values')
750
topic_registry.register('files', _files,
751
'Information on configuration and log files')
752
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
753
'Points at which custom processing can be added')
755
# Load some of the help topics from files. Note that topics which reproduce API
756
# details will tend to skew (quickly usually!) so please seek other solutions
758
topic_registry.register('authentication', _load_from_file,
759
'Information on configuring authentication')
760
topic_registry.register('configuration', _load_from_file,
761
'Details on the configuration settings available')
762
topic_registry.register('conflict-types', _load_from_file,
763
'Types of conflicts and what to do about them')
764
topic_registry.register('debug-flags', _load_from_file,
765
'Options to show or record debug information')
766
topic_registry.register('location-alias', _load_from_file,
767
'Aliases for remembered locations')
768
topic_registry.register('log-formats', _load_from_file,
769
'Details on the logging formats available')
772
# Register concept topics.
773
# Note that we might choose to remove these from the online help in the
774
# future or implement them via loading content from files. In the meantime,
775
# please keep them concise.
776
topic_registry.register('branches', _branches,
777
'Information on what a branch is', SECT_CONCEPT)
778
topic_registry.register('checkouts', _checkouts,
779
'Information on what a checkout is', SECT_CONCEPT)
780
topic_registry.register('content-filters', _load_from_file,
781
'Conversion of content into/from working trees',
783
topic_registry.register('diverged-branches', _load_from_file,
784
'How to fix diverged branches',
786
topic_registry.register('eol', _load_from_file,
787
'Information on end-of-line handling',
789
topic_registry.register('formats', _storage_formats,
790
'Information on choosing a storage format',
792
topic_registry.register('patterns', _load_from_file,
793
'Information on the pattern syntax',
414
return bugtracker.tracker_registry.help_topic(topic)
415
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
795
416
topic_registry.register('repositories', _repositories,
796
'Basic information on shared repositories.',
798
topic_registry.register('rules', _load_from_file,
799
'Information on defining rule-based preferences',
801
topic_registry.register('standalone-trees', _standalone_trees,
802
'Information on what a standalone tree is',
417
'Basic information on shared repositories.')
804
418
topic_registry.register('working-trees', _working_trees,
805
'Information on working trees', SECT_CONCEPT)
806
topic_registry.register('criss-cross', _criss_cross,
807
'Information on criss-cross merging', SECT_CONCEPT)
808
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
809
'Steps to resolve "out-of-sync" when reconfiguring',
419
'Information on working trees')
813
422
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
