~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to bzrlib/help_topics/__init__.py

  • Committer: Martin Pool
  • Date: 2010-08-18 04:26:39 UTC
  • mfrom: (129.1.8 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100818042639-mjoxtngyjwiu05fo
* PPA rebuild for lucid.
* PPA rebuild for karmic.
* PPA rebuild onto jaunty.
* New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
279
279
 
280
280
_basic_help = \
281
281
"""Bazaar %s -- a free distributed version-control tool
282
 
http://bazaar-vcs.org/
 
282
http://www.bazaar.canonical.com/
283
283
 
284
284
Basic commands:
285
285
  bzr init           makes this directory a versioned branch
406
406
end. Checkouts also work on the local file system, so that all that matters is
407
407
file permissions.
408
408
 
409
 
You can change the master of a checkout by using the "bind" command (see "help
410
 
bind"). This will change the location that the commits are sent to. The bind
411
 
command can also be used to turn a branch into a heavy checkout. If you
412
 
would like to convert your heavy checkout into a normal branch so that every
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.
 
409
You can change the master of a checkout by using the "switch" command (see
 
410
"help switch").  This will change the location that the commits are sent to.
 
411
The "bind" command can also be used to turn a normal branch into a heavy
 
412
checkout. If you would like to convert your heavy checkout into a normal
 
413
branch so that every commit is local, you can use the "unbind" command. To see
 
414
whether or not a branch is bound or not you can use the "info" command. If the
 
415
branch is bound it will tell you the location of the bound branch.
416
416
 
417
417
Related commands::
418
418
 
422
422
  commit      Make a commit that is sent to the master branch. If you have
423
423
              a heavy checkout then the --local option will commit to the
424
424
              checkout without sending the commit to the master
425
 
  bind        Change the master branch that the commits in the checkout will
 
425
  switch      Change the master branch that the commits in the checkout will
426
426
              be sent to
 
427
  bind        Turn a standalone branch into a heavy checkout so that any
 
428
              commits will be sent to the master branch
427
429
  unbind      Turn a heavy checkout into a standalone branch so that any
428
430
              commits are only made locally
429
431
  info        Displays whether a branch is bound or unbound. If the branch is
589
591
_env_variables = \
590
592
"""Environment Variables
591
593
 
592
 
================ =================================================================
593
 
BZRPATH          Path where bzr is to look for shell plugin external commands.
594
 
BZR_EMAIL        E-Mail address of the user. Overrides EMAIL.
595
 
EMAIL            E-Mail address of the user.
596
 
BZR_EDITOR       Editor for editing commit messages. Overrides EDITOR.
597
 
EDITOR           Editor for editing commit messages.
598
 
BZR_PLUGIN_PATH  Paths where bzr should look for plugins.
599
 
BZR_HOME         Directory holding .bazaar config dir. Overrides HOME.
600
 
BZR_HOME (Win32) Directory holding bazaar config dir. Overrides APPDATA and HOME.
601
 
BZR_REMOTE_PATH  Full name of remote 'bzr' command (for bzr+ssh:// URLs).
602
 
BZR_SSH          Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
603
 
BZR_LOG          Location of .bzr.log (use '/dev/null' to suppress log).
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).
607
 
================ =================================================================
 
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_DISABLE_PLUGINS Plugins that bzr should not load.
 
602
BZR_PLUGINS_AT      Plugins to load from a directory not in BZR_PLUGIN_PATH.
 
603
BZR_HOME            Directory holding .bazaar config dir. Overrides HOME.
 
604
BZR_HOME (Win32)    Directory holding bazaar config dir. Overrides APPDATA and HOME.
 
605
BZR_REMOTE_PATH     Full name of remote 'bzr' command (for bzr+ssh:// URLs).
 
606
BZR_SSH             Path to SSH client, or one of paramiko, openssh, sshcorp, plink.
 
607
BZR_LOG             Location of .bzr.log (use '/dev/null' to suppress log).
 
608
BZR_LOG (Win32)     Location of .bzr.log (use 'NUL' to suppress log).
 
609
BZR_COLUMNS         Override implicit terminal width.
 
610
BZR_CONCURRENCY     Number of processes that can be run concurrently (selftest).
 
611
BZR_PROGRESS_BAR    Override the progress display. Values are 'none', 'dots', or 'tty'.
 
612
BZR_PDB             Control whether to launch a debugger on error.
 
613
BZR_SIGQUIT_PDB     Control whether SIGQUIT behaves normally or invokes a breakin debugger.
 
614
=================== =======================================================================
608
615
"""
609
616
 
610
617
 
611
618
_files = \
612
619
r"""Files
613
620
 
614
 
:On Linux:   ~/.bazaar/bazaar.conf
 
621
:On Unix:   ~/.bazaar/bazaar.conf
615
622
:On Windows: C:\\Documents and Settings\\username\\Application Data\\bazaar\\2.0\\bazaar.conf
616
623
 
617
624
Contains the user's default configuration. The section ``[DEFAULT]`` is
875
882
def help_as_plain_text(text):
876
883
    """Minimal converter of reStructuredText to plain text."""
877
884
    import re
 
885
    # Remove the standalone code block marker
 
886
    text = re.sub(r"(?m)^\s*::\n\s*$", "", text)
878
887
    lines = text.splitlines()
879
888
    result = []
880
889
    for line in lines: