Merge lp:~sinzui/launchpad/reg-docs-1 into lp:launchpad

[Curtis Hovey]

Fix the protocol in the gpg documentation and branch and MP api docs.

    Launchpad bug:
        https://bugs.launchpad.net/bugs/710054
        https://bugs.launchpad.net/bugs/530476
        https://bugs.launchpad.net/bugs/530477
    Pre-implementation: poolie
    Test command: None

Bug #710054 [opengpg keys help gives incorrect protocol in instructions]
    Poolie: We do indeed need to say hkp rather than http in the instructions.

Bug #530476 [branch_merge_proposals doesn't say who created it]
    https://launchpad.net/+apidoc/#branch_merge_proposal seems like it should
    say who proposed the branch
    Poolie: Apparently yes, it's just the docstring is wrong and
    registrant_link is the mp registrant.

Bug #530477 [branch.url is empty?]
    https://launchpad.net/+apidoc/#branch it looks like the url field is often
    empty? Maybe it's not set for hosted branches; if so maybe the doc could
    mention that.

--------------------------------------------------------------------

RULES

I already updated the wiki page on help.launchpad.net

    * Update the inline help to use hkp://keyserver... instead of
      http://keyserver.
    * Update the IBranchMergeProposal registrant description.
    * Update the IBranch url description to mention that the value is None
      for Lp hosted branches.

QA

    * Visit https://qastaging.launchpad.net/+help/openpgp-keys.html
    * Verify that P"ublishing your key" uses htk://keyserver...
    * Visit https://qastaging.launchpad.net/+apidoc/devel.html
    * Verify that #branch_merge_proposal explains that the registrant
      registred the MP.
    * Verify that #branch explains that the url is None when Lp hosts the
      branch

LINT

  lib/lp/code/interfaces/branch.py
  lib/lp/code/interfaces/branchmergeproposal.py
  lib/lp/registry/help/openpgp-keys.html

IMPLEMENTATION

Updated the documentation. There are no tests for these.
  lib/lp/code/interfaces/branch.py
  lib/lp/code/interfaces/branchmergeproposal.py
  lib/lp/registry/help/openpgp-keys.html

[Brad Crittenden (bac)]

Great collection of fixes Curtis. I do wonder whether we need to specify port 11371. I raise the question and leave it to your unassailable judgment.

review: Approve (code)

=== modified file 'lib/lp/code/interfaces/branch.py'
--- lib/lp/code/interfaces/branch.py	2010-11-18 16:13:32 +0000
+++ lib/lp/code/interfaces/branch.py	2011-02-04 18:03:15 +0000
@@ -954,7 +954,8 @@
             trailing_slash=False,
             description=_(
                 "This is the external location where the Bazaar "
-                "branch is hosted.")))
+                "branch is hosted. This is None when the branch is"
+                "Hosted by Launchpad")))
 
     mirror_status_message = exported(
         Text(

=== modified file 'lib/lp/code/interfaces/branchmergeproposal.py'
--- lib/lp/code/interfaces/branchmergeproposal.py	2010-12-02 16:13:51 +0000
+++ lib/lp/code/interfaces/branchmergeproposal.py	2011-02-04 18:03:15 +0000
@@ -107,13 +107,13 @@
 
     id = Int(
         title=_('DB ID'), required=True, readonly=True,
-        description=_("The tracking number for this question."))
+        description=_("The tracking number for this merge proposal."))
 
     registrant = exported(
         PublicPersonChoice(
             title=_('Person'), required=True,
             vocabulary='ValidPersonOrTeam', readonly=True,
-            description=_('The person who registered the landing target.')))
+            description=_('The person who registered the merge proposal.')))
 
     source_branch = exported(
         ReferenceChoice(

=== modified file 'lib/lp/registry/help/openpgp-keys.html'
--- lib/lp/registry/help/openpgp-keys.html	2010-10-28 13:45:04 +0000
+++ lib/lp/registry/help/openpgp-keys.html	2011-02-04 18:03:15 +0000
@@ -69,7 +69,7 @@
     <p>
       <strong>Step 3</strong> Select <em>Remote &gt; Sync and Publish Keys</em>
       from the menu. Choose the <em>Sync</em> button. (You may need to add
-      http://keyserver.ubuntu.com:11371 to your key servers if you are not
+      hkp://keyserver.ubuntu.com to your key servers if you are not
       using Ubuntu.)
     </p>