← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/__init__.py

  • Committer: John Arbash Meinel
  • Date: 2010-02-17 17:11:16 UTC
  • mfrom: (4797.2.17 2.1)
  • mto: (4797.2.18 2.1)
  • mto: This revision was merged to the branch mainline in revision 5055.
  • Revision ID: john@arbash-meinel.com-20100217171116-h7t9223ystbnx5h8
merge bzr.2.1 in preparation for NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/help_topics/__init__.py
1
 
# Copyright (C) 2006, 2009 Canonical Ltd
 
1
# Copyright (C) 2006-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
152
152
    out.append(
153
153
"""Revision Identifiers
154
154
 
155
 
A revision identifier refers to a specific state of a branch's history. It can
156
 
be a revision number, or a keyword followed by ':' and often other
157
 
parameters. Some examples of identifiers are '3', 'last:1', 'before:yesterday'
158
 
and 'submit:'.
 
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:'.
 
159
 
 
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
 
164
be found first.
159
165
 
160
166
If 'REV1' and 'REV2' are revision identifiers, then 'REV1..REV2' denotes a
161
167
revision range. Examples: '3647..3649', 'date:yesterday..-1' and
245
251
        out += "\nSupported modifiers::\n\n  " + \
246
252
            '  '.join(decl)
247
253
 
 
254
    out += """\
 
255
\nBazaar supports all of the standard parts within the URL::
 
256
 
 
257
  <protocol>://[user[:password]@]host[:port]/[path]
 
258
 
 
259
allowing URLs such as::
 
260
 
 
261
  http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
 
262
 
 
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::
 
268
 
 
269
  bzr+ssh://remote@shell.example.com/~/myproject/trunk
 
270
 
 
271
would refer to ``/home/remote/myproject/trunk``.
 
272
 
 
273
Many commands that accept URLs also accept location aliases too.  See
 
274
::doc:`location-alias-help`.
 
275
"""
 
276
 
248
277
    return out
249
278
 
250
279
 
280
309
"""Global Options
281
310
 
282
311
These options may be used with any command, and may appear in front of any
283
 
command.  (e.g. "bzr --profile help").
 
312
command.  (e.g. ``bzr --profile help``).
284
313
 
285
314
--version      Print the version number. Must be supplied before the command.
286
315
--no-aliases   Do not process command aliases when running this command.
287
316
--builtin      Use the built-in version of a command, not the plugin version.
288
317
               This does not suppress other plugin effects.
289
318
--no-plugins   Do not process any plugins.
 
319
--concurrency  Number of processes that can be run concurrently (selftest).
290
320
 
291
321
--profile      Profile execution using the hotshot profiler.
292
322
--lsprof       Profile execution using the lsprof profiler.
298
328
               will be a pickle.
299
329
--coverage     Generate line coverage report in the specified directory.
300
330
 
301
 
See doc/developers/profiling.txt for more information on profiling.
 
331
See http://doc.bazaar.canonical.com/developers/profiling.html for more
 
332
information on profiling.
 
333
 
302
334
A number of debug flags are also available to assist troubleshooting and
303
 
development.  See `bzr help debug-flags`.
 
335
development.  See :doc:`debug-flags-help`.
304
336
"""
305
337
 
306
338
_standard_options = \
378
410
bind"). This will change the location that the commits are sent to. The bind
379
411
command can also be used to turn a branch into a heavy checkout. If you
380
412
would like to convert your heavy checkout into a normal branch so that every
381
 
commit is local, you can use the "unbind" command.
 
413
commit is local, you can use the "unbind" command. To see whether or not a
 
414
branch is bound or not you can use the "info" command. If the branch is bound
 
415
it will tell you the location of the bound branch.
382
416
 
383
417
Related commands::
384
418
 
392
426
              be sent to
393
427
  unbind      Turn a heavy checkout into a standalone branch so that any
394
428
              commits are only made locally
 
429
  info        Displays whether a branch is bound or unbound. If the branch is
 
430
              bound, then it will also display the location of the bound branch
395
431
"""
396
432
 
397
433
_repositories = \
487
523
branch history is stored), but multiple branches may share the same
488
524
repository (a shared repository). Branches can be copied and merged.
489
525
 
 
526
In addition, one branch may be bound to another one.  Binding to another
 
527
branch indicates that commits which happen in this branch must also 
 
528
happen in the other branch.  Bazaar ensures consistency by not allowing 
 
529
commits when the two branches are out of date.  In order for a commit 
 
530
to succeed, it may be necessary to update the current branch using 
 
531
``bzr update``.
 
532
 
490
533
Related commands::
491
534
 
492
535
  init    Change a directory into a versioned branch.
493
536
  branch  Create a new branch that is a copy of an existing branch.
494
537
  merge   Perform a three-way merge.
 
538
  bind    Bind a branch to another one.
495
539
"""
496
540
 
497
541
 
555
599
BZR_HOME         Directory holding .bazaar config dir. Overrides HOME.
556
600
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
557
601
BZR_REMOTE_PATH  Full name of remote 'bzr' command (for bzr+ssh:// URLs).
558
 
BZR_SSH          SSH client: paramiko (default), openssh, ssh, plink.
 
602
BZR_SSH          Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
559
603
BZR_LOG          Location of .bzr.log (use '/dev/null' to suppress log).
560
604
BZR_LOG (Win32)  Location of .bzr.log (use 'NUL' to suppress log).
 
605
BZR_COLUMNS      Override implicit terminal width.
 
606
BZR_CONCURRENCY  Number of processes that can be run concurrently (selftest).
561
607
================ =================================================================
562
608
"""
563
609
 
614
660
differences.
615
661
"""
616
662
 
617
 
_branches_out_of_sync = """Branches out of sync
 
663
_branches_out_of_sync = """Branches Out of Sync
618
664
 
619
665
When reconfiguring a checkout, tree or branch into a lightweight checkout,
620
666
a local branch must be destroyed.  (For checkouts, this is the local branch
649
695
project owner to upgrade.
650
696
 
651
697
 
652
 
Note: Some of the older formats have two variants:
653
 
a plain one and a rich-root one. The latter include an additional
654
 
field about the root of the tree. There is no performance cost
655
 
for using a rich-root format but you cannot easily merge changes
656
 
from a rich-root format into a plain format. As a consequence,
657
 
moving a project to a rich-root format takes some co-ordination
658
 
in that all contributors need to upgrade their repositories
659
 
around the same time. 2a and all future formats will be
660
 
implicitly rich-root.
661
 
 
662
 
See ``bzr help current-formats`` for the complete list of
663
 
currently supported formats. See ``bzr help other-formats`` for
 
698
.. note::
 
699
 
 
700
   Some of the older formats have two variants:
 
701
   a plain one and a rich-root one. The latter include an additional
 
702
   field about the root of the tree. There is no performance cost
 
703
   for using a rich-root format but you cannot easily merge changes
 
704
   from a rich-root format into a plain format. As a consequence,
 
705
   moving a project to a rich-root format takes some co-ordination
 
706
   in that all contributors need to upgrade their repositories
 
707
   around the same time. 2a and all future formats will be
 
708
   implicitly rich-root.
 
709
 
 
710
See :doc:`current-formats-help` for the complete list of
 
711
currently supported formats. See :doc:`other-formats-help` for
664
712
descriptions of any available experimental and deprecated formats.
665
713
"""
666
714
 
709
757
                        'Information on configuring authentication')
710
758
topic_registry.register('configuration', _load_from_file,
711
759
                        'Details on the configuration settings available')
712
 
topic_registry.register('conflicts', _load_from_file,
 
760
topic_registry.register('conflict-types', _load_from_file,
713
761
                        'Types of conflicts and what to do about them')
714
762
topic_registry.register('debug-flags', _load_from_file,
715
763
                        'Options to show or record debug information')
 
764
topic_registry.register('location-alias', _load_from_file,
 
765
                        'Aliases for remembered locations')
716
766
topic_registry.register('log-formats', _load_from_file,
717
767
                        'Details on the logging formats available')
718
 
topic_registry.register('diverged-branches', _load_from_file,
719
 
                        'How to fix diverged branches')
720
768
 
721
769
 
722
770
# Register concept topics.
730
778
topic_registry.register('content-filters', _load_from_file,
731
779
                        'Conversion of content into/from working trees',
732
780
                        SECT_CONCEPT)
 
781
topic_registry.register('diverged-branches', _load_from_file,
 
782
                        'How to fix diverged branches',
 
783
                        SECT_CONCEPT)
733
784
topic_registry.register('eol', _load_from_file,
734
785
                        'Information on end-of-line handling',
735
786
                        SECT_CONCEPT)
823
874
 
824
875
def help_as_plain_text(text):
825
876
    """Minimal converter of reStructuredText to plain text."""
 
877
    import re
826
878
    lines = text.splitlines()
827
879
    result = []
828
880
    for line in lines:
830
882
            line = line[1:]
831
883
        elif line.endswith('::'):
832
884
            line = line[:-1]
 
885
        # Map :doc:`xxx-help` to ``bzr help xxx``
 
886
        line = re.sub(":doc:`(.+)-help`", r'``bzr help \1``', line)
833
887
        result.append(line)
834
888
    return "\n".join(result) + "\n"