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

Commit c09cf28

Browse files
committed
improve doc formatting
1 parent 2f028ee commit c09cf28

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ This module is suitable for pretty much any Linux system. It currently supports
2727
oracle_java will affect the following parts of your system:
2828

2929
* jre/jdk package
30-
* java alternative +slaves
30+
* java alternative (and slaves)
3131

3232
Including the main class is enough to install the latest version of the Oracle JRE.
3333

@@ -91,31 +91,28 @@ Primary class and entry point of the module.
9191

9292
#####`version`
9393

94-
Java version to install, formated as 'major_version'u'minor_version' or simply 'major_version' for the latest available release in the selected Java SE series. Defaults to '8'
95-
96-
Note: a minor version of '0' (for example '8u0') matches the initial release of the selected Java SE series.
94+
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`
95+
*Note*: a minor version of '0' (for example `8u0`) matches the initial release of the selected Java SE series.
9796

9897
#####`type`
9998

100-
What envionment type to install. Valid values are 'jre' and 'jdk'. Defaults to 'jre'
99+
What envionment type to install. Valid values are `jre` and `jdk`. Defaults to `jre`
101100

102101
#####`format`
103102

104-
What format of installation archive to retrieve. Valid values are 'rpm' and 'tar.gz'. Default depends on the platform
103+
What format of installation archive to retrieve. Valid values are `rpm` and `tar.gz`. Default depends on the platform
105104

106105
#####`check_checksum`
107106

108-
Enable checksum validation on downloaded archives. Boolean value. Defaults to 'true'
107+
Enable checksum validation on downloaded archives. Boolean value. Defaults to `true`
109108

110109
#####`add_alternative`
111110

112-
Add Oracle Java to the system alternatives on compatible platforms*. Boolean value. Defaults to 'false'
113-
114-
(*Debian/RHEL/SuSE-like)
111+
Add Oracle Java to the system alternatives on compatible platforms (Debian/RHEL/SuSE families). Boolean value. Defaults to `false`
115112

116113
##Limitations
117114

118-
* Prior to Java 8u20, two different releases of the same Java series could not cohabit on the same system when installed from RPM. Each new version would override the previous one. This does not happen with tar.gz archives however.
115+
Prior to Java 8u20, two different releases of the same Java series could not cohabit on the same system when installed from RPM. Each new version would override the previous one. This does not happen with tar.gz archives however.
119116

120117
##Credits
121118

0 commit comments

Comments
 (0)