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

Proposed by Jelmer Vernooij
Status: Merged
Approved by: Vincent Ladeuil
Approved revision: 6493
Merged at revision: 6493
Proposed branch: lp:~jelmer/bzr/2.5-config-help-topics
Merge into: lp:bzr/2.5
Diff against target: 41 lines (+10/-0)
3 files modified
bzrlib/config.py (+3/-0)
bzrlib/tests/test_config.py (+4/-0)
doc/en/release-notes/bzr-2.5.txt (+3/-0)
To merge this branch: bzr merge lp:~jelmer/bzr/2.5-config-help-topics
Reviewer Review Type Date Requested Status
Vincent Ladeuil Approve
Review via email: mp+99372@code.launchpad.net

Commit message

Implement get_help_topic for ConfigOption.

Description of the change

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.

To post a comment you must log in.
Revision history for this message
Vincent Ladeuil (vila) wrote :

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
Revision history for this message
Jelmer Vernooij (jelmer) wrote :

sent to pqm by email

Revision history for this message
Jelmer Vernooij (jelmer) wrote :

sent to pqm by email

Revision history for this message
Jelmer Vernooij (jelmer) wrote :

sent to pqm by email

Revision history for this message
Martin Packman (gz) wrote :

sent to pqm by email

Revision history for this message
Jelmer Vernooij (jelmer) wrote :

sent to pqm by email

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'bzrlib/config.py'
2--- bzrlib/config.py 2012-02-15 22:43:50 +0000
3+++ bzrlib/config.py 2012-03-26 17:07:19 +0000
4@@ -2442,6 +2442,9 @@
5 value = self.default
6 return value
7
8+ def get_help_topic(self):
9+ return self.name
10+
11 def get_help_text(self, additional_see_also=None, plain=True):
12 result = self.help
13 from bzrlib import help_topics
14
15=== modified file 'bzrlib/tests/test_config.py'
16--- bzrlib/tests/test_config.py 2012-02-15 22:43:50 +0000
17+++ bzrlib/tests/test_config.py 2012-03-26 17:07:19 +0000
18@@ -2369,6 +2369,10 @@
19 opt = config.Option('foo', default=bar_not_unicode)
20 self.assertRaises(AssertionError, opt.get_default)
21
22+ def test_get_help_topic(self):
23+ opt = config.Option('foo')
24+ self.assertEquals('foo', opt.get_help_topic())
25+
26
27 class TestOptionConverterMixin(object):
28
29
30=== modified file 'doc/en/release-notes/bzr-2.5.txt'
31--- doc/en/release-notes/bzr-2.5.txt 2012-03-15 16:06:40 +0000
32+++ doc/en/release-notes/bzr-2.5.txt 2012-03-26 17:07:19 +0000
33@@ -39,6 +39,9 @@
34 * Fixed merge tool availability checking and invocation to search the
35 Windows App Path registry in addition to the PATH. (Gordon Tyler, #939605)
36
37+* Make sure configuration options can provide their own help topic.
38+ (Jelmer Vernooij, #941672)
39+
40 Documentation
41 *************
42

Subscribers

People subscribed via source and target branches