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.
137
137
def _load_from_file(topic_name):
138
138
"""Load help from a file.
140
Topics are expected to be txt files in bzrlib.help_topics.
140
Topics are expected to be in bzrlib/help_topics.
142
resource_name = osutils.pathjoin("en", "%s.txt" % (topic_name,))
143
return osutils.resource_string('bzrlib.help_topics', resource_name)
142
base = osutils.dirname(bzrlib.__file__)
143
if getattr(sys, 'frozen', None): # bzr.exe
144
base = osutils.abspath(osutils.pathjoin(base, '..', '..'))
145
filename = osutils.pathjoin(base, 'help_topics', 'en', topic_name + ".txt")
146
return open(filename, 'rU').read()
146
149
def _help_on_revisionspec(name):
149
152
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:
155
out.append("Revision Identifiers\n")
156
out.append("A revision, or a range bound, can be one of the following.\n")
183
details.append("\nIn addition, plugins can provide other keywords.")
184
details.append("\nA detailed description of each keyword is given below.\n")
158
details.append("\nFurther details are given below.\n")
186
160
# The help text is indented 4 spaces - this re cleans that up below
187
161
indent_re = re.compile(r'^ ', re.MULTILINE)
188
for prefix, i in bzrlib.revisionspec.revspec_registry.iteritems():
162
for i in bzrlib.revisionspec.SPEC_TYPES:
190
164
if doc == bzrlib.revisionspec.RevisionSpec.help_txt:
197
171
#doc = indent_re.sub('', doc)
198
172
while (doc[-2:] == '\n\n' or doc[-1:] == ' '):
201
175
# Note: The leading : here are HACKs to get reStructuredText
202
176
# 'field' formatting - we know that the prefix ends in a ':'.
203
177
out.append(":%s\n\t%s" % (i.prefix, summary))
215
189
def add_string(proto, help, maxl, prefix_width=20):
216
help_lines = textwrap.wrap(help, maxl - prefix_width,
217
break_long_words=False)
190
help_lines = textwrap.wrap(help, maxl - prefix_width)
218
191
line_with_indent = '\n' + ' ' * prefix_width
219
192
help_text = line_with_indent.join(help_lines)
220
193
return "%-20s%s\n" % (proto, help_text)
251
224
out += "\nSupported modifiers::\n\n " + \
255
\nBazaar supports all of the standard parts within the URL::
257
<protocol>://[user[:password]@]host[:port]/[path]
259
allowing URLs such as::
261
http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
263
For bzr+ssh:// and sftp:// URLs, Bazaar also supports paths that begin
264
with '~' as meaning that the rest of the path should be interpreted
265
relative to the remote user's home directory. For example if the user
266
``remote`` has a home directory of ``/home/remote`` on the server
267
shell.example.com, then::
269
bzr+ssh://remote@shell.example.com/~/myproject/trunk
271
would refer to ``/home/remote/myproject/trunk``.
273
Many commands that accept URLs also accept location aliases too. See
274
::doc:`location-alias-help`.
281
"""Bazaar %s -- a free distributed version-control tool
282
http://bazaar.canonical.com/
231
"""Bazaar -- a free distributed version-control tool
232
http://bazaar-vcs.org/
285
235
bzr init makes this directory a versioned branch
302
251
bzr help init more help on e.g. init command
303
252
bzr help commands list all commands
304
253
bzr help topics list all help topics
305
""" % bzrlib.__version__
308
257
_global_options = \
309
258
"""Global Options
311
260
These options may be used with any command, and may appear in front of any
312
command. (e.g. ``bzr --profile help``).
261
command. (e.g. "bzr --profile help").
314
263
--version Print the version number. Must be supplied before the command.
315
264
--no-aliases Do not process command aliases when running this command.
316
265
--builtin Use the built-in version of a command, not the plugin version.
317
266
This does not suppress other plugin effects.
318
267
--no-plugins Do not process any plugins.
319
--no-l10n Do not translate messages.
320
--concurrency Number of processes that can be run concurrently (selftest).
322
269
--profile Profile execution using the hotshot profiler.
323
270
--lsprof Profile execution using the lsprof profiler.
327
274
"callgrind.out" or end with ".callgrind", the output will be
328
275
formatted for use with KCacheGrind. Otherwise, the output
329
276
will be a pickle.
330
--coverage Generate line coverage report in the specified directory.
332
See http://doc.bazaar.canonical.com/developers/profiling.html for more
333
information on profiling.
278
See doc/developers/profiling.txt for more information on profiling.
335
279
A number of debug flags are also available to assist troubleshooting and
336
development. See :doc:`debug-flags-help`.
282
-Dauth Trace authentication sections used.
283
-Derror Instead of normal error handling, always print a traceback on
285
-Devil Capture call sites that do expensive or badly-scaling
287
-Dhashcache Log every time a working file is read to determine its hash.
288
-Dhooks Trace hook execution.
289
-Dhttp Trace http connections, requests and responses
290
-Dhpss Trace smart protocol requests and responses.
291
-Dindex Trace major index operations.
292
-Dlock Trace when lockdir locks are taken or released.
293
-Dmerge Emit information for debugging merges.
339
296
_standard_options = \
340
297
"""Standard Options
342
299
Standard options are legal for all commands.
344
301
--help, -h Show help message.
345
302
--verbose, -v Display more information.
346
303
--quiet, -q Only display errors and warnings.
391
348
Lightweight checkouts work best when you have fast reliable access to the
392
349
master branch. This means that if the master branch is on the same disk or LAN
393
350
a lightweight checkout will be faster than a heavyweight one for any commands
394
that modify the revision history (as only one copy of the branch needs to
395
be updated). Heavyweight checkouts will generally be faster for any command
396
that uses the history but does not change it, but if the master branch is on
397
the same disk then there won't be a noticeable difference.
351
that modify the revision history (as only one copy branch needs to be updated).
352
Heavyweight checkouts will generally be faster for any command that uses the
353
history but does not change it, but if the master branch is on the same disk
354
then there wont be a noticeable difference.
399
356
Another possible use for a checkout is to use it with a treeless repository
400
357
containing your branches, where you maintain only one working tree by
401
switching the master branch that the checkout points to when you want to
358
switching the master branch that the checkout points to when you want to
402
359
work on a different branch.
404
361
Obviously to commit on a checkout you need to be able to write to the master
407
364
end. Checkouts also work on the local file system, so that all that matters is
408
365
file permissions.
410
You can change the master of a checkout by using the "switch" command (see
411
"help switch"). This will change the location that the commits are sent to.
412
The "bind" command can also be used to turn a normal branch into a heavy
413
checkout. If you would like to convert your heavy checkout into a normal
414
branch so that every commit is local, you can use the "unbind" command. To see
415
whether or not a branch is bound or not you can use the "info" command. If the
416
branch is bound it will tell you the location of the bound branch.
367
You can change the master of a checkout by using the "bind" command (see "help
368
bind"). This will change the location that the commits are sent to. The bind
369
command can also be used to turn a branch into a heavy checkout. If you
370
would like to convert your heavy checkout into a normal branch so that every
371
commit is local, you can use the "unbind" command.
418
373
Related commands::
422
377
update Pull any changes in the master branch in to your checkout
423
378
commit Make a commit that is sent to the master branch. If you have
424
a heavy checkout then the --local option will commit to the
379
a heavy checkout then the --local option will commit to the
425
380
checkout without sending the commit to the master
426
switch Change the master branch that the commits in the checkout will
381
bind Change the master branch that the commits in the checkout will
428
bind Turn a standalone branch into a heavy checkout so that any
429
commits will be sent to the master branch
430
383
unbind Turn a heavy checkout into a standalone branch so that any
431
384
commits are only made locally
432
info Displays whether a branch is bound or unbound. If the branch is
433
bound, then it will also display the location of the bound branch
436
387
_repositories = \
442
393
Repositories are a form of database. Bzr will usually maintain this for
443
394
good performance automatically, but in some situations (e.g. when doing
444
very many commits in a short time period) you may want to ask bzr to
395
very many commits in a short time period) you may want to ask bzr to
445
396
optimise the database indices. This can be done by the 'bzr pack' command.
447
398
By default just running 'bzr init' will create a repository within the new
526
477
branch history is stored), but multiple branches may share the same
527
478
repository (a shared repository). Branches can be copied and merged.
529
In addition, one branch may be bound to another one. Binding to another
530
branch indicates that commits which happen in this branch must also
531
happen in the other branch. Bazaar ensures consistency by not allowing
532
commits when the two branches are out of date. In order for a commit
533
to succeed, it may be necessary to update the current branch using
536
480
Related commands::
538
init Change a directory into a versioned branch.
539
branch Create a new branch that is a copy of an existing branch.
482
init Make a directory into a versioned branch.
483
branch Create a new copy of a branch.
540
484
merge Perform a three-way merge.
541
bind Bind a branch to another one.
592
534
_env_variables = \
593
535
"""Environment Variables
595
=================== ===========================================================
596
BZRPATH Path where bzr is to look for shell plugin external
598
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
599
EMAIL E-Mail address of the user.
600
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
601
EDITOR Editor for editing commit messages.
602
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
603
BZR_DISABLE_PLUGINS Plugins that bzr should not load.
604
BZR_PLUGINS_AT Plugins to load from a directory not in BZR_PLUGIN_PATH.
605
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
606
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and
608
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
609
BZR_SSH Path to SSH client, or one of paramiko, openssh, sshcorp,
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', 'dots',
617
BZR_PDB Control whether to launch a debugger on error.
618
BZR_SIGQUIT_PDB Control whether SIGQUIT behaves normally or invokes a
620
=================== ===========================================================
537
================ =================================================================
538
BZRPATH Path where bzr is to look for shell plugin external commands.
539
BZR_EMAIL E-Mail address of the user. Overrides EMAIL.
540
EMAIL E-Mail address of the user.
541
BZR_EDITOR Editor for editing commit messages. Overrides EDITOR.
542
EDITOR Editor for editing commit messages.
543
BZR_PLUGIN_PATH Paths where bzr should look for plugins.
544
BZR_HOME Directory holding .bazaar config dir. Overrides HOME.
545
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
546
BZR_REMOTE_PATH Full name of remote 'bzr' command (for bzr+ssh:// URLs).
547
================ =================================================================
627
:On Unix: ~/.bazaar/bazaar.conf
554
:On Linux: ~/.bazaar/bazaar.conf
628
555
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
630
557
Contains the user's default configuration. The section ``[DEFAULT]`` is
648
575
A criss-cross in the branch history can cause the default merge technique
649
576
to emit more conflicts than would normally be expected.
651
In complex merge cases, ``bzr merge --lca`` or ``bzr merge --weave`` may give
652
better results. You may wish to ``bzr revert`` the working tree and merge
653
again. Alternatively, use ``bzr remerge`` on particular conflicted files.
578
If you encounter criss-crosses, you can use merge --weave instead, which
579
should provide a much better result.
655
581
Criss-crosses occur in a branch's history if two branches merge the same thing
656
582
and then merge one another, or if two branches merge one another at the same
671
597
The ``weave`` merge type is not affected by this problem because it uses
672
598
line-origin detection instead of a basis revision to determine the cause of
676
_branches_out_of_sync = """Branches Out of Sync
678
When reconfiguring a checkout, tree or branch into a lightweight checkout,
679
a local branch must be destroyed. (For checkouts, this is the local branch
680
that serves primarily as a cache.) If the branch-to-be-destroyed does not
681
have the same last revision as the new reference branch for the lightweight
682
checkout, data could be lost, so Bazaar refuses.
684
How you deal with this depends on *why* the branches are out of sync.
686
If you have a checkout and have done local commits, you can get back in sync
687
by running "bzr update" (and possibly "bzr commit").
689
If you have a branch and the remote branch is out-of-date, you can push
690
the local changes using "bzr push". If the local branch is out of date, you
691
can do "bzr pull". If both branches have had changes, you can merge, commit
692
and then push your changes. If you decide that some of the changes aren't
693
useful, you can "push --overwrite" or "pull --overwrite" instead.
700
To ensure that older clients do not access data incorrectly,
701
Bazaar's policy is to introduce a new storage format whenever
702
new features requiring new metadata are added. New storage
703
formats may also be introduced to improve performance and
706
The newest format, 2a, is highly recommended. If your
707
project is not using 2a, then you should suggest to the
708
project owner to upgrade.
713
Some of the older formats have two variants:
714
a plain one and a rich-root one. The latter include an additional
715
field about the root of the tree. There is no performance cost
716
for using a rich-root format but you cannot easily merge changes
717
from a rich-root format into a plain format. As a consequence,
718
moving a project to a rich-root format takes some co-ordination
719
in that all contributors need to upgrade their repositories
720
around the same time. 2a and all future formats will be
721
implicitly rich-root.
723
See :doc:`current-formats-help` for the complete list of
724
currently supported formats. See :doc:`other-formats-help` for
725
descriptions of any available experimental and deprecated formats.
729
602
# Register help topics
731
604
"Explain how to use --revision")
732
605
topic_registry.register('basic', _basic_help, "Basic commands", SECT_HIDDEN)
733
606
topic_registry.register('topics', _help_on_topics, "Topics list", SECT_HIDDEN)
734
def get_current_formats_topic(topic):
735
from bzrlib import bzrdir
736
return "Current Storage Formats\n\n" + \
737
bzrdir.format_registry.help_topic(topic)
738
def get_other_formats_topic(topic):
739
from bzrlib import bzrdir
740
return "Other Storage Formats\n\n" + \
741
bzrdir.format_registry.help_topic(topic)
742
topic_registry.register('current-formats', get_current_formats_topic,
743
'Current storage formats')
744
topic_registry.register('other-formats', get_other_formats_topic,
745
'Experimental and deprecated storage formats')
607
def get_format_topic(topic):
608
from bzrlib import bzrdir
609
return "Storage Formats\n\n" + bzrdir.format_registry.help_topic(topic)
610
topic_registry.register('formats', get_format_topic, 'Directory formats')
746
611
topic_registry.register('standard-options', _standard_options,
747
612
'Options that can be used with any command')
748
613
topic_registry.register('global-options', _global_options,
753
618
"Help on status flags")
754
619
def get_bugs_topic(topic):
755
620
from bzrlib import bugtracker
756
return ("Bug Tracker Settings\n\n" +
757
bugtracker.tracker_registry.help_topic(topic))
758
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker settings')
621
return "Bug Trackers\n\n" + bugtracker.tracker_registry.help_topic(topic)
622
topic_registry.register('bugs', get_bugs_topic, 'Bug tracker support')
759
623
topic_registry.register('env-variables', _env_variables,
760
624
'Environment variable names and values')
761
625
topic_registry.register('files', _files,
762
626
'Information on configuration and log files')
763
topic_registry.register_lazy('hooks', 'bzrlib.hooks', 'hooks_help_text',
764
'Points at which custom processing can be added')
766
# Load some of the help topics from files. Note that topics which reproduce API
767
# details will tend to skew (quickly usually!) so please seek other solutions
628
# Load some of the help topics from files
769
629
topic_registry.register('authentication', _load_from_file,
770
630
'Information on configuring authentication')
771
631
topic_registry.register('configuration', _load_from_file,
772
632
'Details on the configuration settings available')
773
topic_registry.register('conflict-types', _load_from_file,
633
topic_registry.register('conflicts', _load_from_file,
774
634
'Types of conflicts and what to do about them')
775
topic_registry.register('debug-flags', _load_from_file,
776
'Options to show or record debug information')
777
topic_registry.register('location-alias', _load_from_file,
778
'Aliases for remembered locations')
779
topic_registry.register('log-formats', _load_from_file,
780
'Details on the logging formats available')
635
topic_registry.register('hooks', _load_from_file,
636
'Points at which custom processing can be added')
783
639
# Register concept topics.
788
644
'Information on what a branch is', SECT_CONCEPT)
789
645
topic_registry.register('checkouts', _checkouts,
790
646
'Information on what a checkout is', SECT_CONCEPT)
791
topic_registry.register('content-filters', _load_from_file,
792
'Conversion of content into/from working trees',
794
topic_registry.register('diverged-branches', _load_from_file,
795
'How to fix diverged branches',
797
topic_registry.register('eol', _load_from_file,
798
'Information on end-of-line handling',
800
topic_registry.register('formats', _storage_formats,
801
'Information on choosing a storage format',
803
topic_registry.register('patterns', _load_from_file,
804
'Information on the pattern syntax',
806
647
topic_registry.register('repositories', _repositories,
807
648
'Basic information on shared repositories.',
809
topic_registry.register('rules', _load_from_file,
810
'Information on defining rule-based preferences',
812
650
topic_registry.register('standalone-trees', _standalone_trees,
813
651
'Information on what a standalone tree is',
816
654
'Information on working trees', SECT_CONCEPT)
817
655
topic_registry.register('criss-cross', _criss_cross,
818
656
'Information on criss-cross merging', SECT_CONCEPT)
819
topic_registry.register('sync-for-reconfigure', _branches_out_of_sync,
820
'Steps to resolve "out-of-sync" when reconfiguring',
824
659
class HelpTopicIndex(object):
865
700
returned instead of plain text.
867
702
result = topic_registry.get_detail(self.topic)
868
# there is code duplicated here and in bzrlib/plugin.py's
703
# there is code duplicated here and in bzrlib/plugin.py's
869
704
# matching Topic code. This should probably be factored in
870
705
# to a helper function and a common base class.
871
706
if additional_see_also is not None:
888
723
def help_as_plain_text(text):
889
724
"""Minimal converter of reStructuredText to plain text."""
891
# Remove the standalone code block marker
892
text = re.sub(r"(?m)^\s*::\n\s*$", "", text)
893
725
lines = text.splitlines()
895
727
for line in lines:
added
removed
bzrlib/help_topics.py
