Rev 4829: (robertc) Doc improvements for bzr help urlspec. (Neil in file:///home/pqm/archives/thelove/bzr/%2Btrunk/

[Canonical.com Patch Queue Manager]

At file:///home/pqm/archives/thelove/bzr/%2Btrunk/

------------------------------------------------------------
revno: 4829 [merge]
revision-id: pqm at pqm.ubuntu.com-20091126045809-fzd0z4hll8fsgosd
parent: pqm at pqm.ubuntu.com-20091126022650-zjeqb0su8ak4oi6s
parent: nmb at wartburg.edu-20091125162430-olcxfhqdttqho1hw
committer: Canonical.com Patch Queue Manager <pqm at pqm.ubuntu.com>
branch nick: +trunk
timestamp: Thu 2009-11-26 04:58:09 +0000
message:
  (robertc) Doc improvements for bzr help urlspec. (Neil
  	Martinsen-Burrell)
modified:
  bzrlib/help_topics/__init__.py help_topics.py-20060920210027-rnim90q9e0bwxvy4-1
=== modified file 'bzrlib/help_topics/__init__.py'
--- a/bzrlib/help_topics/__init__.py	2009-11-07 08:02:13 +0000
+++ b/bzrlib/help_topics/__init__.py	2009-11-26 04:58:09 +0000
@@ -251,6 +251,26 @@
         out += "\nSupported modifiers::\n\n  " + \
             '  '.join(decl)
 
+    out += """\
+\nBazaar supports all of the standard parts within the URL::
+
+  <protocol>://[user[:password]@]host[:port]/[path]
+
+allowing URLs such as::
+
+  http://bzruser:BadPass@bzr.example.com:8080/bzr/trunk
+
+For bzr+ssh:// URLs, Bazaar also supports paths that begin with '~' as
+meaning that the rest of the path should be interpreted relative to the
+remote user's home directory.  For example if the user ``remote`` has a 
+home directory of ``/home/remote`` on the server shell.example.com, 
+then::
+
+  bzr+ssh://remote@shell.example.com/~/myproject/trunk
+
+would refer to ``/home/remote/myproject/trunk``.
+"""
+
     return out