Merge pull request #98 from mhaskel/missed_docs

Add missing docs for new facts
This commit is contained in:
Jean B.
2015-01-16 15:18:49 -08:00

View File

@@ -8,8 +8,8 @@
* [Beginning with the java module](#beginning-with-the-java-module)
4. [Usage - Configuration options and additional functionality](#usage)
5. [Reference - An under-the-hood peek at what the module is doing and how](#reference)
5. [Limitations - OS compatibility, etc.](#limitations)
6. [Development - Guide for contributing to the module](#development)
6. [Limitations - OS compatibility, etc.](#limitations)
7. [Development - Guide for contributing to the module](#development)
##Overview
@@ -62,6 +62,16 @@ The following parameters are available in the java module:
* `java_alternative_path`: The path to the 'java' command. Since the alternatives system makes it difficult to verify which alternative is actually enabled, this is required to ensure the correct JVM is enabled.
###Facts
The java module includes a few facts to describe the version of Java installed on the system:
* `java_major_version`: The major version of Java.
* `java_patch_level`: The patch level of Java.
* `java_version`: The full Java version string.
**Note:** The facts return `nil` if Java is not installed on the system.
##Limitations
This module cannot guarantee installation of Java versions that are not available on platform repositories.