Merge lp:~lifeless/bzr/env-variable-help into lp:bzr

Proposed by Robert Collins on 2012-09-25
Status: Merged
Approved by: Vincent Ladeuil on 2012-09-26
Approved revision: 6566
Merged at revision: 6566
Proposed branch: lp:~lifeless/bzr/env-variable-help
Merge into: lp:bzr
Diff against target: 28 lines (+6/-1)
2 files modified
bzrlib/help_topics/__init__.py (+2/-1)
doc/en/release-notes/bzr-2.6.txt (+4/-0)
To merge this branch: bzr merge lp:~lifeless/bzr/env-variable-help
Reviewer Review Type Date Requested Status
Vincent Ladeuil 2012-09-25 Approve on 2012-09-26
Review via email: mp+126193@code.launchpad.net

Commit message

Add reference to configuration in 'bzr help env-variables'

Description of the change

I went 'bzr help env-variables' wanting to remember the BZR_PLUGINS_AT variable, but the help there was minimal, turns out that bzr help configuration is /much/ more helpful, so I've added a cross-reference sentence.

Could look at doing more, but this is a driveby make-it-a-little-better patch.

To post a comment you must log in.
Vincent Ladeuil (vila) :
review: Approve
Vincent Ladeuil (vila) 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/help_topics/__init__.py'
2--- bzrlib/help_topics/__init__.py 2012-03-15 15:36:12 +0000
3+++ bzrlib/help_topics/__init__.py 2012-09-25 08:36:28 +0000
4@@ -620,7 +620,8 @@
5
6 def _env_variables(topic):
7 import textwrap
8- ret = ["Environment Variables\n\n"]
9+ ret = ["Environment Variables\n\n"
10+ "See bzr help configuration for more details.\n\n"]
11 max_key_len = max([len(k[0]) for k in known_env_variables])
12 desc_len = (80 - max_key_len - 2)
13 ret.append("=" * max_key_len + " " + "=" * desc_len + "\n")
14
15=== modified file 'doc/en/release-notes/bzr-2.6.txt'
16--- doc/en/release-notes/bzr-2.6.txt 2012-09-20 08:27:39 +0000
17+++ doc/en/release-notes/bzr-2.6.txt 2012-09-25 08:36:28 +0000
18@@ -30,6 +30,10 @@
19 Improvements
20 ************
21
22+* ``bzr help env-variables`` now points users at ``bzr help configuration``
23+ which has much more detailed information on the same stuff.
24+ (Robert Collins)
25+
26 * ``bzr lp-find-proposal`` now only cares about the revision-id that is
27 specified, not the branch you use. This was enabled by a new API call in
28 Launchpad's web service. (Aaron Bentley)