Skip to content
This repository was archived by the owner on Dec 19, 2024. It is now read-only.

Commit afdb18d

Browse files
committed
Simplify README
1 parent 8eccd80 commit afdb18d

File tree

1 file changed

+21
-32
lines changed

1 file changed

+21
-32
lines changed

README.md

Lines changed: 21 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [Classes and Defined Types](#classes-and-defined-types)
1111
* [Class: oracle_java](#class-oracle_java)
1212
* [Define: oracle_java::installation](#define-oracle_javainstallation)
13+
* [Common parameters](#common-parameters)
1314
5. [Limitations](#limitations)
1415
6. [Contributors](#contributors)
1516
7. [Credits](#credits)
@@ -116,10 +117,6 @@ Primary class and entry point of the module. Installs Java in `/usr/java`
116117
Java version to install, formatted as '*major_version*'u'*minor_version*' or simply '*major_version*' for the latest available release in the selected Java SE series. Defaults to `8`
117118
*Note*: a minor version of '0' (for example `8u0`) matches the initial release of the selected Java SE series.
118119

119-
#####`type`
120-
121-
What envionment type to install. Valid values are `jre` and `jdk`. Defaults to `jre`
122-
123120
#####`format`
124121

125122
What format of installation archive to retrieve. Valid values are `rpm` and `tar.gz`. Default depends on the platform
@@ -128,33 +125,11 @@ What format of installation archive to retrieve. Valid values are `rpm` and `tar
128125

129126
Absolute root path where the Oracle Java archives are extracted. Requires `format` set to `tar.gz`. Defaults to `/usr/java`
130127

131-
#####`check_checksum`
132-
133-
Enable checksum validation on downloaded archives. Boolean value. Defaults to `true`
134-
135-
#####`add_alternative`
136-
137-
Add Oracle Java to the system alternatives on compatible platforms (Debian/RHEL/SuSE families). Boolean value. Defaults to `false`
138-
139128
#####`add_system_env`
140129

141130
Add `JAVA_HOME` environment variable to the `/etc/environment` file. Boolean value. Defaults to `false`
142131

143-
#####`custom_download_url`
144-
145-
Do not download the Oracle Java archive from Oracle servers, instead use an alternative URL. Must but the full URL to the archive file or RPM package
146-
147-
#####`custom_checksum`
148-
149-
Custom MD5 checksum used to verify the archive integrity. Optional. Defaults to the checksum provided by Oracle
150-
151-
#####`proxy_server`
152-
153-
URL of a proxy server used for downloading Java archives
154-
155-
#####`proxy_type`
156-
157-
Type of the proxy server. Valid values are `none`, `http`, `https` and `ftp`. Optional. Default determined by the scheme used in `proxy_server`
132+
See also [Common parameters](#common-parameters)
158133

159134
####Define: `oracle_java::installation`
160135

@@ -166,25 +141,39 @@ Installs an extra version of Oracle Java in `install_path`
166141

167142
Namevar. See [oracle_java::version](#version)
168143

144+
See also [Common parameters](#common-parameters)
145+
146+
####Common parameters
147+
148+
Parameters common to both `oracle_java` and `oracle_java::installation`
149+
169150
#####`type`
170151

171-
See [oracle_java::type](#type)
152+
What envionment type to install. Valid values are `jre` and `jdk`. Defaults to `jre`
172153

173154
#####`check_checksum`
174155

175-
See [oracle_java::check_checksum](#check_checksum)
156+
Enable checksum validation on downloaded archives. Boolean value. Defaults to `true`
176157

177158
#####`add_alternative`
178159

179-
See [oracle_java::add_alternative](#add_alternative)
160+
Add Oracle Java to the system alternatives on compatible platforms (Debian/RHEL/SuSE families). Boolean value. Defaults to `false`
180161

181162
#####`custom_download_url`
182163

183-
See [oracle_java::custom_download_url](#custom_download_url)
164+
Do not download the Oracle Java archive from Oracle servers, instead use an alternative URL. Must but the full URL to the archive file or RPM package
184165

185166
#####`custom_checksum`
186167

187-
See [oracle_java::custom_checksum](#custom_checksum)
168+
Custom MD5 checksum used to verify the archive integrity. Optional. Defaults to the checksum provided by Oracle
169+
170+
#####`proxy_server`
171+
172+
URL of a proxy server used for downloading Java archives
173+
174+
#####`proxy_type`
175+
176+
Type of the proxy server. Valid values are `none`, `http`, `https` and `ftp`. Optional. Default determined by the scheme used in `proxy_server`
188177

189178
##Limitations
190179

0 commit comments

Comments
 (0)