Rev 2251: Documentation under 'help launchpad' in file:///home/mbp/bzr/Work/lpurl/

[Martin Pool]

------------------------------------------------------------
revno: 2251
revision-id: mbp at sourcefrog.net-20070126044410-x7dnlcdjbitbb3c2
parent: mbp at sourcefrog.net-20070126031150-80cjzqt6e3f64b2m
committer: Martin Pool <mbp at sourcefrog.net>
branch nick: lpurl
timestamp: Fri 2007-01-26 15:44:10 +1100
message:
  Documentation under 'help launchpad'
modified:
  bzrlib/plugins/launchpad/__init__.py __init__.py-20060315182712-2d5feebd2a1032dc
  bzrlib/plugins/launchpad/lp_indirect.py lp_indirect.py-20070126012204-de5rugwlt22c7u7e-1
=== modified file 'bzrlib/plugins/launchpad/__init__.py'
--- a/bzrlib/plugins/launchpad/__init__.py	2007-01-26 03:11:50 +0000
+++ b/bzrlib/plugins/launchpad/__init__.py	2007-01-26 04:44:10 +0000
@@ -16,13 +16,6 @@
 
 """Launchpad.net integration plugin for Bazaar
 
-This adds two features:
-
-  * A register-branch command that tells launchpad about the existence
-    of a branch
-
-  * A lp: transport that uses Launchpad as a directory to find a branch
-
 To install this file, put the 'bzr_lp' directory, or a symlink to it,
 in your ~/.bazaar/plugins/ directory.
 """
@@ -34,7 +27,7 @@
 
 from bzrlib.commands import Command, Option, register_command
 from bzrlib.transport import register_lazy_transport
-
+from bzrlib.help_topics import topic_registry
 
 
 class cmd_register_branch(Command):
@@ -142,3 +135,27 @@
     for m in [test_register, test_lp_indirect]:
         suite.addTests(loader.loadTestsFromModule(m))
     return suite
+
+_launchpad_help = """Integration with Launchpad.net
+
+Launchpad.net provides free Bazaar branch hosting with integrated bug and
+specification tracking.
+
+The bzr client (through the plugin called 'launchpad') has two special
+features to communicate with Launchpad:
+
+    * The register-branch command tells launchpad about the url of a 
+      public branch.  Launchpad will then mirror the branch, display
+      its contents and allow it to be attached to bugs and other 
+      objects.
+
+    * The 'lp:' transport uses Launchpad as a directory service: 
+      for example 'lp:bzr' and 'lp:python' refer to the main branches of the
+      relevant projects and may be branched, logged, etc.  (Only read access
+      is supported at present.)
+
+For more information see http://help.launchpad.net/
+"""
+topic_registry.register('launchpad',
+    _launchpad_help,
+    'Using Bazaar with Launchpad.net')

=== modified file 'bzrlib/plugins/launchpad/lp_indirect.py'
--- a/bzrlib/plugins/launchpad/lp_indirect.py	2007-01-26 03:11:50 +0000
+++ b/bzrlib/plugins/launchpad/lp_indirect.py	2007-01-26 04:44:10 +0000
@@ -32,7 +32,7 @@
 
 
 def launchpad_transport_indirect(base_url):
-    """Factory that returns the real transport for a lp: url"""
+    """Uses Launchpad.net as a directory of open source software"""
     if base_url.startswith('lp:///'):
         real_url = 'http://code.launchpad.net/' + base_url[6:]
     elif base_url.startswith('lp:') and base_url[3] != '/':