Skip to content

Commit

Permalink
Documentation Polishing
Browse files Browse the repository at this point in the history
This change fixes a rogue line break in the Oracle JRE `cf set-env` example,
and unifies the documentation for all JREs.

[resolves cloudfoundry#769]

Signed-off-by: Ben Hale <bhale@pivotal.io>
  • Loading branch information
mayrstefan authored and nebhale committed Jan 21, 2020
1 parent 9a17b03 commit 3ebda04
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 17 deletions.
9 changes: 5 additions & 4 deletions docs/jre-ibm_jre.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ For general information on configuring the buildpack, including how to specify c

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.

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

`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::IbmJRE"]}'`

`cf restage <app_name>`
```bash
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::IbmJRE"]}'
cf restage <app_name>
```

| Name | Description
| ---- | -----------
Expand Down
11 changes: 6 additions & 5 deletions docs/jre-oracle_jre.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,13 @@ For general information on configuring the buildpack, including how to specify c

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.

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

`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{ jres: [ "JavaBuildpack::Jre::OracleJRE" ] }'`
`cf set-env <app_name> JBP_CONFIG_ORACLE_JRE '{ jre: { repository_root: "<INTERNAL_REPOSITORY_URI>" } }'`

`cf restage <app_name>`
```bash
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{ jres: [ "JavaBuildpack::Jre::OracleJRE" ] }'
cf set-env <app_name> JBP_CONFIG_ORACLE_JRE '{ jre: { repository_root: "<INTERNAL_REPOSITORY_URI>" } }'
cf restage <app_name>
```

| Name | Description
| ---- | -----------
Expand Down
9 changes: 5 additions & 4 deletions docs/jre-sap_machine_jre.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,12 @@ For general information on configuring the buildpack, including how to specify c

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.

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

`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::SapMachineJRE"]}'`

`cf restage <app_name>`
```bash
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::SapMachineJRE"]}'
cf restage <app_name>
```

| Name | Description
| ---- | -----------
Expand Down
9 changes: 5 additions & 4 deletions docs/jre-zulu_jre.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,12 @@ For general information on configuring the buildpack, including how to specify c

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.

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

`cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::ZuluJRE"]}'`

`cf restage <app_name>`
```bash
cf set-env <app_name> JBP_CONFIG_COMPONENTS '{jres: ["JavaBuildpack::Jre::ZuluJRE"]}'
cf restage <app_name>
```

| Name | Description
| ---- | -----------
Expand Down

0 comments on commit 3ebda04

Please sign in to comment.