Skip to content

Commit 3ebda04

Browse files
mayrstefannebhale
authored andcommitted
Documentation Polishing
This change fixes a rogue line break in the Oracle JRE `cf set-env` example, and unifies the documentation for all JREs. [resolves #769] Signed-off-by: Ben Hale <[email protected]>
1 parent 9a17b03 commit 3ebda04

File tree

4 files changed

+21
-17
lines changed

4 files changed

+21
-17
lines changed

docs/jre-ibm_jre.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ For general information on configuring the buildpack, including how to specify c
1111

1212
The JRE can be configured by modifying the [`config/ibm_jre.yml`][] file in the buildpack fork. The JRE uses the [`Repository` utility support][repositories] and so, it supports the [version syntax][] defined there.
1313

14-
To use IBM JRE instead of OpenJDK without forking java-buildpack, set environment variable:
14+
To use IBM JRE instead of OpenJDK without forking java-buildpack, set environment variable and restage:
1515

16-
`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::IbmJRE"]}'`
17-
18-
`cf restage <app_name>`
16+
```bash
17+
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::IbmJRE"]}'
18+
cf restage <app_name>
19+
```
1920

2021
| Name | Description
2122
| ---- | -----------

docs/jre-oracle_jre.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,13 @@ For general information on configuring the buildpack, including how to specify c
3131

3232
The JRE can be configured by modifying the [`config/oracle_jre.yml`][] file in the buildpack fork. The JRE uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
3333

34-
To use Oracle JRE instead of OpenJDK without forking java-buildpack, set environment variable:
34+
To use Oracle JRE instead of OpenJDK without forking java-buildpack, set environment variable and restage:
3535

36-
`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{ jres: [ "JavaBuildpack::Jre::OracleJRE" ] }'`
37-
`cf set-env <app_name> JBP_CONFIG_ORACLE_JRE '{ jre: { repository_root: "<INTERNAL_REPOSITORY_URI>" } }'`
38-
39-
`cf restage <app_name>`
36+
```bash
37+
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{ jres: [ "JavaBuildpack::Jre::OracleJRE" ] }'
38+
cf set-env <app_name> JBP_CONFIG_ORACLE_JRE '{ jre: { repository_root: "<INTERNAL_REPOSITORY_URI>" } }'
39+
cf restage <app_name>
40+
```
4041

4142
| Name | Description
4243
| ---- | -----------

docs/jre-sap_machine_jre.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,12 @@ For general information on configuring the buildpack, including how to specify c
2222

2323
The JRE can be configured by modifying the [`config/sap_machine_jre.yml`][] file in the buildpack fork. The JRE uses the [`Repository` utility support][repositories] and so it supports the [version syntax][] defined there.
2424

25-
To use SapMachine JRE instead of OpenJDK without forking java-buildpack, set environment variable:
25+
To use SapMachine JRE instead of OpenJDK without forking java-buildpack, set environment variable and restage:
2626

27-
`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::SapMachineJRE"]}'`
28-
29-
`cf restage <app_name>`
27+
```bash
28+
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::SapMachineJRE"]}'
29+
cf restage <app_name>
30+
```
3031

3132
| Name | Description
3233
| ---- | -----------

docs/jre-zulu_jre.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ For general information on configuring the buildpack, including how to specify c
2323

2424
The JRE can be configured by modifying the [`config/zulu_jre.yml`][] file in the buildpack fork. The JRE uses the [`Repository` utility support][repositories] and so, it supports the [version syntax][] defined there.
2525

26-
To use Zulu JRE instead of OpenJDK without forking java-buildpack, set environment variable:
26+
To use Zulu JRE instead of OpenJDK without forking java-buildpack, set environment variable and restage:
2727

28-
`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::ZuluJRE"]}'`
29-
30-
`cf restage <app_name>`
28+
```bash
29+
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::ZuluJRE"]}'
30+
cf restage <app_name>
31+
```
3132

3233
| Name | Description
3334
| ---- | -----------

0 commit comments

Comments
 (0)