Merge lp:~jelmer/bzr/2.5-config-help-topics into lp:bzr/2.5

[Jelmer Vernooij]

Implement get_help_topic for ConfigOption.

Cherry-pick the fix for configuration help topics from bzr.

This was originally meant to go into 2.5, but merged into bzr.dev instead.

[Vincent Ladeuil (vila)]

IMHO, unless you really want feedback (expect issues or knows someone will object and you want a discussion), there is no need to ask for a review for such proposals.

review: Approve

[Jelmer Vernooij (jelmer)]

sent to pqm by email

[Jelmer Vernooij (jelmer)]

sent to pqm by email

[Jelmer Vernooij (jelmer)]

sent to pqm by email

[Martin Packman (gz)]

sent to pqm by email

[Jelmer Vernooij (jelmer)]

sent to pqm by email

=== modified file 'bzrlib/config.py'
--- bzrlib/config.py	2012-02-15 22:43:50 +0000
+++ bzrlib/config.py	2012-03-26 17:07:19 +0000
@@ -2442,6 +2442,9 @@
                 value = self.default
         return value
 
+    def get_help_topic(self):
+        return self.name
+
     def get_help_text(self, additional_see_also=None, plain=True):
         result = self.help
         from bzrlib import help_topics
 
=== modified file 'bzrlib/tests/test_config.py'
--- bzrlib/tests/test_config.py	2012-02-15 22:43:50 +0000
+++ bzrlib/tests/test_config.py	2012-03-26 17:07:19 +0000
@@ -2369,6 +2369,10 @@
         opt = config.Option('foo', default=bar_not_unicode)
         self.assertRaises(AssertionError, opt.get_default)
 
+    def test_get_help_topic(self):
+        opt = config.Option('foo')
+        self.assertEquals('foo', opt.get_help_topic())
+
 
 class TestOptionConverterMixin(object):
 
 
=== modified file 'doc/en/release-notes/bzr-2.5.txt'
--- doc/en/release-notes/bzr-2.5.txt	2012-03-15 16:06:40 +0000
+++ doc/en/release-notes/bzr-2.5.txt	2012-03-26 17:07:19 +0000
@@ -39,6 +39,9 @@
 * Fixed merge tool availability checking and invocation to search the
   Windows App Path registry in addition to the PATH. (Gordon Tyler, #939605)
 
+* Make sure configuration options can provide their own help topic.
+  (Jelmer Vernooij, #941672)
+
 Documentation
 *************