Merge lp:~parthm/bzr/584650-incorrect-alias-info-in-help into lp:bzr

[Parth Malwankar]

Fix the display of cmd aliases in the help topic for aliased commands.

=== Fixes bug #584650 ===

bzrlib.help.help has the signature below (not seen in the diff)

def help(topic=None, outfile=None):

The for loop in the diff was using 'topic' as a variable so in cases where the loop was coming in, topic was being overwritten and as a result the alias info was showing the object name. Renaming the loop variable to topic_obj fixes this.

Unfortunately I don't have a test case for this as the bundled plugins (I tried lp) doesn't have this problem. I have tested this manually.

[Robert Collins (lifeless)]

looks good; pending a second committer ok.

review: Approve

[Martin Pool (mbp)]

review: Approve

[Parth Malwankar (parthm)]

Thanks for the review. I will go ahead and land this.

[Robert Collins (lifeless)]

sent to pqm by email

[Parth Malwankar (parthm)]

> sent to pqm by email

Looks like you got to pqm before me :)
I will skip feed-pqm.

=== modified file 'NEWS'
--- NEWS	2010-05-25 21:30:52 +0000
+++ NEWS	2010-05-26 07:49:26 +0000
@@ -64,6 +64,10 @@
 Bug Fixes
 *********
 
+* Alias information shown by ``bzr help`` is now accurate. This
+  was showing an internal object name for some plugin aliases.
+  (Parth Malwankar, #584650)
+
 * ``.bazaar``, ``.bazaar/bazaar.conf`` and ``.bzr.log`` inherit user and
   group ownership from the containing directory. This allow bzr to work
   better with sudo.

=== modified file 'bzrlib/help.py'
--- bzrlib/help.py	2010-04-30 11:03:59 +0000
+++ bzrlib/help.py	2010-05-26 07:49:26 +0000
@@ -44,9 +44,9 @@
     try:
         topics = indices.search(topic)
         shadowed_terms = []
-        for index, topic in topics[1:]:
+        for index, topic_obj in topics[1:]:
             shadowed_terms.append('%s%s' % (index.prefix,
-                topic.get_help_topic()))
+                topic_obj.get_help_topic()))
         source = topics[0][1]
         outfile.write(source.get_help_text(shadowed_terms))
     except errors.NoHelpTopic: