[BUILDR-283] env variables: misleading documentation

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.3.4
• Fix Version/s: 1.3.5
• Component/s: Site/documentation
• Assignee: Unassigned
• Reporter: Alexis Midon
• Created: 03/Jun/09 00:25
• Updated: 22/Jun/11 10:10
• Resolved: 18/Sep/09 18:40

Description

The current documentation states that:
"a. For convenience, when you set environment variables on the command line, the variable name is case insensitive (..) b. " Any other way (export, ENV, etc) the variable names are case sensitive."

a. is incorrect because Rake processes env. variables passed on the command line in a case sensitive way. [1]
$buildr MYVAR=foo is different from $buildr myvar=foo

b. is incorrect because TEST and DEBUG are case insensitive even with export and ENV. Some specs already test that case. [2]

The attached patch rephrases this sentence into:
"For convenience, the environment variables @TEST@ and @DEBUG@ are case insensitive, you can use either @test=no@ or @TEST=no@. Any other environment variable names are case sensitive."

[1] http://docs.rubyrake.org/user_guide/chapter02.html
[2] http://github.com/assaf/buildr/blob/1b45697ffb6d2877fc8bc2543be92cb91638e483/spec/core/test_spec.rb#L848