136
128
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
131
def _help_on_revisionspec(name):
149
132
"""Generate the help for revision specs."""
151
134
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:
137
out.append("Revision Identifiers\n")
138
out.append("A revision, or a range bound, can be one of the following.\n")
185
details.append("\nIn addition, plugins can provide other keywords.")
186
details.append("\nA detailed description of each keyword is given below.\n")
140
details.append("\nFurther details are given below.\n")
188
142
# The help text is indented 4 spaces - this re cleans that up below
189
143
indent_re = re.compile(r'^ ', re.MULTILINE)
190
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
144
for i in bzrlib.revisionspec.SPEC_TYPES:
192
146
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
253
206
out += "\nSupported modifiers::\n\n " + \
257
\nBazaar supports all of the standard parts within the URL::
259
<protocol>://[user[:password]@]host[:port]/[path]
261
allowing URLs such as::
263
http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
265
For bzr+ssh:// and sftp:// URLs, Bazaar also supports paths that begin
266
with '~' as meaning that the rest of the path should be interpreted
267
relative to the remote user's home directory. For example if the user
268
``remote`` has a home directory of ``/home/remote`` on the server
269
shell.example.com, then::
271
bzr+ssh://remote@shell.example.com/~/myproject/trunk
273
would refer to ``/home/remote/myproject/trunk``.
275
Many commands that accept URLs also accept location aliases too.
276
See :doc:`location-alias-help` and :doc:`url-special-chars-help`.
283
"""Bazaar %s -- a free distributed version-control tool
284
http://bazaar.canonical.com/
213
"""Bazaar -- a free distributed version-control tool
214
http://bazaar-vcs.org/
287
217
bzr init makes this directory a versioned branch
304
233
bzr help init more help on e.g. init command
305
234
bzr help commands list all commands
306
235
bzr help topics list all help topics
307
""" % bzrlib.__version__
310
239
_global_options = \
311
240
"""Global Options
313
242
These options may be used with any command, and may appear in front of any
314
command. (e.g. ``bzr --profile help``).
243
command. (e.g. "bzr --profile help").
316
245
--version Print the version number. Must be supplied before the command.
317
246
--no-aliases Do not process command aliases when running this command.
318
247
--builtin Use the built-in version of a command, not the plugin version.
319
248
This does not suppress other plugin effects.
320
249
--no-plugins Do not process any plugins.
321
--no-l10n Do not translate messages.
322
--concurrency Number of processes that can be run concurrently (selftest).
324
251
--profile Profile execution using the hotshot profiler.
325
252
--lsprof Profile execution using the lsprof profiler.
329
256
"callgrind.out" or end with ".callgrind", the output will be
330
257
formatted for use with KCacheGrind. Otherwise, the output
331
258
will be a pickle.
332
--coverage Generate line coverage report in the specified directory.
334
-Oname=value Override the ``name`` config option setting it to ``value`` for
335
the duration of the command. This can be used multiple times if
336
several options need to be overridden.
338
See http://doc.bazaar.canonical.com/developers/profiling.html for more
339
information on profiling.
260
See doc/developers/profiling.txt for more information on profiling.
341
261
A number of debug flags are also available to assist troubleshooting and
342
development. See :doc:`debug-flags-help`.
264
-Dauth Trace authentication sections used.
265
-Derror Instead of normal error handling, always print a traceback on
267
-Devil Capture call sites that do expensive or badly-scaling
269
-Dhashcache Log every time a working file is read to determine its hash.
270
-Dhooks Trace hook execution.
271
-Dhpss Trace smart protocol requests and responses.
272
-Dindex Trace major index operations.
273
-Dlock Trace when lockdir locks are taken or released.
345
276
_standard_options = \
346
277
"""Standard Options
348
279
Standard options are legal for all commands.
350
281
--help, -h Show help message.
351
282
--verbose, -v Display more information.
352
283
--quiet, -q Only display errors and warnings.
397
328
Lightweight checkouts work best when you have fast reliable access to the
398
329
master branch. This means that if the master branch is on the same disk or LAN
399
330
a lightweight checkout will be faster than a heavyweight one for any commands
400
that modify the revision history (as only one copy of the branch needs to
401
be updated). Heavyweight checkouts will generally be faster for any command
402
that uses the history but does not change it, but if the master branch is on
403
the same disk then there won't be a noticeable difference.
331
that modify the revision history (as only one copy branch needs to be updated).
332
Heavyweight checkouts will generally be faster for any command that uses the
333
history but does not change it, but if the master branch is on the same disk
334
then there wont be a noticeable difference.
405
336
Another possible use for a checkout is to use it with a treeless repository
406
337
containing your branches, where you maintain only one working tree by
407
switching the master branch that the checkout points to when you want to
338
switching the master branch that the checkout points to when you want to
408
339
work on a different branch.
410
341
Obviously to commit on a checkout you need to be able to write to the master
598
known_env_variables = [
599
("BZRPATH", "Path where bzr is to look for shell plugin external commands."),
600
("BZR_EMAIL", "E-Mail address of the user. Overrides EMAIL."),
601
("EMAIL", "E-Mail address of the user."),
602
("BZR_EDITOR", "Editor for editing commit messages. Overrides EDITOR."),
603
("EDITOR", "Editor for editing commit messages."),
604
("BZR_PLUGIN_PATH", "Paths where bzr should look for plugins."),
605
("BZR_DISABLE_PLUGINS", "Plugins that bzr should not load."),
606
("BZR_PLUGINS_AT", "Plugins to load from a directory not in BZR_PLUGIN_PATH."),
607
("BZR_HOME", "Directory holding .bazaar config dir. Overrides HOME."),
608
("BZR_HOME (Win32)", "Directory holding bazaar config dir. Overrides APPDATA and HOME."),
609
("BZR_REMOTE_PATH", "Full name of remote 'bzr' command (for bzr+ssh:// URLs)."),
610
("BZR_SSH", "Path to SSH client, or one of paramiko, openssh, sshcorp, plink or lsh."),
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' or 'text'."),
616
("BZR_PDB", "Control whether to launch a debugger on error."),
617
("BZR_SIGQUIT_PDB", "Control whether SIGQUIT behaves normally or invokes a breakin debugger."),
618
("BZR_TEXTUI_INPUT", "Force console input mode for prompts to line-based (instead of char-based)."),
621
def _env_variables(topic):
623
ret = ["Environment Variables\n\n"
624
"See bzr help configuration for more details.\n\n"]
625
max_key_len = max([len(k[0]) for k in known_env_variables])
626
desc_len = (80 - max_key_len - 2)
627
ret.append("=" * max_key_len + " " + "=" * desc_len + "\n")
628
for k, desc in known_env_variables:
629
ret.append(k + (max_key_len + 1 - len(k)) * " ")
630
ret.append("\n".join(textwrap.wrap(
631
desc, width=desc_len, subsequent_indent=" " * (max_key_len + 1))))
633
ret += "=" * max_key_len + " " + "=" * desc_len + "\n"
515
"""Environment Variables
517
================ =================================================================
518
BZRPATH Path where bzr is to look for shell plugin external commands.
519
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
520
EMAIL E-Mail address of the user.
521
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
522
EDITOR Editor for editing commit messages.
523
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
524
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
525
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
526
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
527
================ =================================================================
639
:On Unix: ~/.bazaar/bazaar.conf
534
:On Linux: ~/.bazaar/bazaar.conf
640
535
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
642
537
Contains the user's default configuration. The section ``[DEFAULT]`` is
654
549
log10 = log --short -r -10..-1
660
A criss-cross in the branch history can cause the default merge technique
661
to emit more conflicts than would normally be expected.
663
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
664
better results. You may wish to ``bzr revert`` the working tree and merge
665
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
667
Criss-crosses occur in a branch's history if two branches merge the same thing
668
and then merge one another, or if two branches merge one another at the same
669
time. They can be avoided by having each branch only merge from or into a
670
designated central branch (a "star topology").
672
Criss-crosses cause problems because of the way merge works. Bazaar's default
673
merge is a three-way merger; in order to merge OTHER into THIS, it must
674
find a basis for comparison, BASE. Using BASE, it can determine whether
675
differences between THIS and OTHER are due to one side adding lines, or
676
from another side removing lines.
678
Criss-crosses mean there is no good choice for a base. Selecting the recent
679
merge points could cause one side's changes to be silently discarded.
680
Selecting older merge points (which Bazaar does) mean that extra conflicts
683
The ``weave`` merge type is not affected by this problem because it uses
684
line-origin detection instead of a basis revision to determine the cause of
688
_branches_out_of_sync = """Branches Out of Sync
690
When reconfiguring a checkout, tree or branch into a lightweight checkout,
691
a local branch must be destroyed. (For checkouts, this is the local branch
692
that serves primarily as a cache.) If the branch-to-be-destroyed does not
693
have the same last revision as the new reference branch for the lightweight
694
checkout, data could be lost, so Bazaar refuses.
696
How you deal with this depends on *why* the branches are out of sync.
698
If you have a checkout and have done local commits, you can get back in sync
699
by running "bzr update" (and possibly "bzr commit").
701
If you have a branch and the remote branch is out-of-date, you can push
702
the local changes using "bzr push". If the local branch is out of date, you
703
can do "bzr pull". If both branches have had changes, you can merge, commit
704
and then push your changes. If you decide that some of the changes aren't
705
useful, you can "push --overwrite" or "pull --overwrite" instead.
712
To ensure that older clients do not access data incorrectly,
713
Bazaar's policy is to introduce a new storage format whenever
714
new features requiring new metadata are added. New storage
715
formats may also be introduced to improve performance and
718
The newest format, 2a, is highly recommended. If your
719
project is not using 2a, then you should suggest to the
720
project owner to upgrade.
725
Some of the older formats have two variants:
726
a plain one and a rich-root one. The latter include an additional
727
field about the root of the tree. There is no performance cost
728
for using a rich-root format but you cannot easily merge changes
729
from a rich-root format into a plain format. As a consequence,
730
moving a project to a rich-root format takes some co-ordination
731
in that all contributors need to upgrade their repositories
732
around the same time. 2a and all future formats will be
733
implicitly rich-root.
735
See :doc:`current-formats-help` for the complete list of
736
currently supported formats. See :doc:`other-formats-help` for
737
descriptions of any available experimental and deprecated formats.
741
553
# Register help topics
742
554
topic_registry.register("revisionspec", _help_on_revisionspec,
743
555
"Explain how to use --revision")
744
556
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
745
557
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
746
def get_current_formats_topic(topic):
747
from bzrlib import controldir
748
return "Current Storage Formats\n\n" + \
749
controldir.format_registry.help_topic(topic)
750
def get_other_formats_topic(topic):
751
from bzrlib import controldir
752
return "Other Storage Formats\n\n" + \
753
controldir.format_registry.help_topic(topic)
754
topic_registry.register('current-formats', get_current_formats_topic,
755
'Current storage formats')
756
topic_registry.register('other-formats', get_other_formats_topic,
757
'Experimental and deprecated storage formats')
558
def get_format_topic(topic):
559
from bzrlib import bzrdir
560
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
561
topic_registry.register('formats', get_format_topic, 'Directory formats')
758
562
topic_registry.register('standard-options', _standard_options,
759
563
'Options that can be used with any command')
760
564
topic_registry.register('global-options', _global_options,
765
569
"Help on status flags")
766
570
def get_bugs_topic(topic):
767
571
from bzrlib import bugtracker
768
return ("Bug Tracker Settings\n\n" +
769
bugtracker.tracker_registry.help_topic(topic))
770
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
572
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
573
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
771
574
topic_registry.register('env-variables', _env_variables,
772
575
'Environment variable names and values')
773
576
topic_registry.register('files', _files,
774
577
'Information on configuration and log files')
775
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
776
'Points at which custom processing can be added')
777
topic_registry.register_lazy('location-alias', 'bzrlib.directory_service',
778
'AliasDirectory.help_text',
779
'Aliases for remembered locations')
781
# Load some of the help topics from files. Note that topics which reproduce API
782
# details will tend to skew (quickly usually!) so please seek other solutions
784
topic_registry.register('authentication', _load_from_file,
785
'Information on configuring authentication')
786
topic_registry.register('configuration', _load_from_file,
787
'Details on the configuration settings available')
788
topic_registry.register('conflict-types', _load_from_file,
789
'Types of conflicts and what to do about them')
790
topic_registry.register('debug-flags', _load_from_file,
791
'Options to show or record debug information')
792
topic_registry.register('log-formats', _load_from_file,
793
'Details on the logging formats available')
794
topic_registry.register('url-special-chars', _load_from_file,
795
'Special character handling in URLs')
798
580
# Register concept topics.
803
585
'Information on what a branch is', SECT_CONCEPT)
804
586
topic_registry.register('checkouts', _checkouts,
805
587
'Information on what a checkout is', SECT_CONCEPT)
806
topic_registry.register('content-filters', _load_from_file,
807
'Conversion of content into/from working trees',
809
topic_registry.register('diverged-branches', _load_from_file,
810
'How to fix diverged branches',
812
topic_registry.register('eol', _load_from_file,
813
'Information on end-of-line handling',
815
topic_registry.register('formats', _storage_formats,
816
'Information on choosing a storage format',
818
topic_registry.register('patterns', _load_from_file,
819
'Information on the pattern syntax',
821
588
topic_registry.register('repositories', _repositories,
822
589
'Basic information on shared repositories.',
824
topic_registry.register('rules', _load_from_file,
825
'Information on defining rule-based preferences',
827
591
topic_registry.register('standalone-trees', _standalone_trees,
828
592
'Information on what a standalone tree is',
830
594
topic_registry.register('working-trees', _working_trees,
831
595
'Information on working trees', SECT_CONCEPT)
832
topic_registry.register('criss-cross', _criss_cross,
833
'Information on criss-cross merging', SECT_CONCEPT)
834
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
835
'Steps to resolve "out-of-sync" when reconfiguring',
839
598
class HelpTopicIndex(object):
added
removed
bzrlib/help_topics.py
