Merge branch 'dsyer-patch-1'

Christopher Frost · Christopher Frost · commit 955a77e299fa · 2015-10-12T16:24:58.000+01:00
diff --git a/README.md b/README.md
@@ -27,30 +27,36 @@ The following are _very_ simple examples for deploying the artifact types that w
 ## Configuration and Extension
 The buildpack supports extension through the use of Git repository forking. The easiest way to accomplish this is to use [GitHub's forking functionality][] to create a copy of this repository.  Make the required extension changes in the copy of the repository. Then specify the URL of the new repository when pushing Cloud Foundry applications. If the modifications are generally applicable to the Cloud Foundry community, please submit a [pull request][] with the changes.
 
-Buildpack configuration can be overridden with an environment variable matching the configuration file you wish to override minus the `.yml` extension and with a prefix of `JBP_CONFIG`. It is not possible to add new configuration properties and properties with `nil` or empty values will be ignored by the buildpack. The value of the variable should be valid inline yaml, referred to as `flow style` in the yaml spec. For example, to change the default version of Java to 7 and adjust the memory heuristics apply this environment variable to the application.
+Buildpack configuration can be overridden with an environment variable matching the configuration file you wish to override minus the `.yml` extension and with a prefix of `JBP_CONFIG`. It is not possible to add new configuration properties and properties with `nil` or empty values will be ignored by the buildpack. The value of the variable should be valid inline yaml, referred to as `flow style` in the yaml spec ([Wikipedia] has a good description of this yaml syntax). For example, to change the default version of Java to 7 and adjust the memory heuristics apply this environment variable to the application.
 
 ```bash
-$ cf set-env my-application JBP_CONFIG_OPEN_JDK_JRE '[jre: { version: 1.7.0_+ }]'
+$ cf set-env my-application JBP_CONFIG_OPEN_JDK_JRE '{jre: { version: 1.7.0_+ }}'
 ```
 
 If the key or value contains a special character such as `:` it should be escaped with double quotes. For example, to change the default repository path for the buildpack.
 
 ```bash
-$ cf set-env my-application JBP_CONFIG_REPOSITORY '[default_repository_root: "http://repo.example.io"]'
+$ cf set-env my-application JBP_CONFIG_REPOSITORY '{default_repository_root: "http://repo.example.io"}'
+```
+
+If the key or value contains an environment variable that you want to bind at runtime you need to escape it from your shell. For example, to add command line arguments containing an environment variable to a [Java Main](docs/container-java_main.md) application.
+
+```bash
+$ cf set-env my-application JBP_CONFIG_JAVA_MAIN '{arguments: "-server.port=\$PORT -foo=bar"}'
 ```
 
 Environment variable can also be specified in the applications `manifest` file. For example, to specify an environment variable in an applications manifest file that disables Auto-reconfiguration.
 
 ```bash
   env: 
-    JBP_CONFIG_SPRING_AUTO_RECONFIGURATION: '[enabled: false]'
+    JBP_CONFIG_SPRING_AUTO_RECONFIGURATION: '{enabled: false}'
 ```
 
 This final example shows how to change the version of Tomcat that is used by the buildpack with an environment variable specified in the applications manifest file.
 
 ```bash
   env: 
-    JBP_CONFIG_TOMCAT: '[tomcat: { version: 8.0.+ }]'
+    JBP_CONFIG_TOMCAT: '{tomcat: { version: 8.0.+ }}'
 ```
 
 See the [Environment Variables][] documentation for more information.
@@ -168,3 +174,4 @@ This buildpack is released under version 2.0 of the [Apache License][].
 [Pull requests]: http://help.github.com/send-pull-requests
 [Running Cloud Foundry locally]: http://docs.cloudfoundry.org/deploying/run-local.html
 [Spring Boot]: http://projects.spring.io/spring-boot/
+[Wikipedia]: https://en.wikipedia.org/wiki/YAML#Basic_components_of_YAML
diff --git a/spec/java_buildpack/util/configuration_utils_spec.rb b/spec/java_buildpack/util/configuration_utils_spec.rb
@@ -59,15 +59,15 @@
     end
 
     it 'load configuration file and clean nil values' do
-      expect(described_class.load('test', true)).to eq('foo'      => { 'one' => '1', 'two' => 2 },
-                                                       'bar'      => { 'alpha' => { 'one' => 'cat', 'two' => 'dog' } },
-                                                       'version'  => '1.7.1')
+      expect(described_class.load('test', true)).to eq('foo'     => { 'one' => '1', 'two' => 2 },
+                                                       'bar'     => { 'alpha' => { 'one' => 'cat', 'two' => 'dog' } },
+                                                       'version' => '1.7.1')
     end
 
     context do
 
       let(:environment) do
-        { 'JBP_CONFIG_TEST' => '[bar: {alpha: {one: 3, two: {one: 3}}, bravo: newValue}, foo: lion]' }
+        { 'JBP_CONFIG_TEST' => '{bar: {alpha: {one: 3, two: {one: 3}}, bravo: newValue}, foo: lion}' }
       end
 
       it 'overlays matching environment variables' do
@@ -82,7 +82,7 @@
     context do
 
       let(:environment) do
-        { 'JBP_CONFIG_TEST' => 'version: 1.8.+' }
+        { 'JBP_CONFIG_TEST' => '{version: 1.8.+}' }
       end
 
       it 'overlays simple matching environment variable' do
@@ -96,7 +96,7 @@
     context do
 
       let(:environment) do
-        { 'JBP_CONFIG_TEST' => 'version 1.8.+' }
+        { 'JBP_CONFIG_TEST' => 'Not an array or a hash' }
       end
 
       it 'raises an exception when invalid override value is specified' do
