5.2.4 Release

ltsxs · Aug 16, 2020 · e01eeff · e01eeff
1 parent b8290e1
commit e01eeff
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 67 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,25 +1,19 @@
-4.9.4 / 5.2.4 (in progress)
+4.9.5 / 5.2.5 (in progress)
 ================
-* [#1320](https://github.com/oshi/oshi/pull/1320): Avoid NPE for failed Windows registry counter size - [@dbwiddis](https://github.com/dbwiddis).
 * Your contribution here
 
-4.9.3 / 5.2.3 (2020-08-09)
-================
-* [#1310](https://github.com/oshi/oshi/pull/1310): Use fragment size in Linux FileStore size calculation - [@dbwiddis](https://github.com/dbwiddis).
-* [#1316](https://github.com/oshi/oshi/pull/1316): Fix ARM architecture parsing - [@dbwiddis](https://github.com/dbwiddis).
-
-4.9.2 / 5.2.2 (2020-07-20)
-================
-* [#1302](https://github.com/oshi/oshi/pull/1302): More accurate process start times - [@dbwiddis](https://github.com/dbwiddis).
-* [#1307](https://github.com/oshi/oshi/pull/1307): Correctly fetch logical partitions on Windows - [@AnakinHou](https://github.com/AnakinHou).
-
-4.9.1 / 5.2.1 (2020-07-14)
+4.9.1 / 5.2.1 (2020-07-14), 4.9.2 / 5.2.2 (2020-07-20), 4.9.3 / 5.2.3 (2020-08-09), 4.9.4 / 5.2.4 (2020-08-16)
 ================
 * [#1282](https://github.com/oshi/oshi/pull/1282): (5.x) AIX Port - [@tausiflife](https://github.com/tausiflife), [@dbwiddis](https://github.com/dbwiddis).
 * [#1285](https://github.com/oshi/oshi/pull/1285): Fallback to read properties file from classloader of the class - [@ngyukman](https://github.com/ngyukman).
 * [#1290](https://github.com/oshi/oshi/pull/1290): Demo class matching filestore to partition - [@dbwiddis](https://github.com/dbwiddis).
 * [#1298](https://github.com/oshi/oshi/pull/1298): Use lshw as backup for max CPU frequency - [@dbwiddis](https://github.com/dbwiddis), [@Szwendacz99](https://github.com/Szwendacz99)
 * [#1299](https://github.com/oshi/oshi/pull/1299): JNA 5.6.0 / macOS 11 Compatibility - [@dbwiddis](https://github.com/dbwiddis)
+* [#1302](https://github.com/oshi/oshi/pull/1302): More accurate process start times - [@dbwiddis](https://github.com/dbwiddis).
+* [#1307](https://github.com/oshi/oshi/pull/1307): Correctly fetch logical partitions on Windows - [@AnakinHou](https://github.com/AnakinHou).
+* [#1310](https://github.com/oshi/oshi/pull/1310): Use fragment size in Linux FileStore size calculation - [@dbwiddis](https://github.com/dbwiddis).
+* [#1316](https://github.com/oshi/oshi/pull/1316): Fix ARM architecture parsing - [@dbwiddis](https://github.com/dbwiddis).
+* [#1320](https://github.com/oshi/oshi/pull/1320): Avoid NPE for failed Windows registry counter size - [@dbwiddis](https://github.com/dbwiddis).
 
 4.9.0 / 5.2.0 (2020-06-25)
 ================

diff --git a/FAQ.md b/FAQ.md
@@ -48,9 +48,9 @@ OSHI has been implemented and tested on the following systems.  Some features ma
 * Windows 7 and higher.  (Nearly all features work on Vista and most work on Windows XP.)
 * macOS version 10.6 (Snow Leopard) and higher.
 * Linux (Most major distributions) Kernel 2.6 and higher
-* Solaris 11 (SunOS 5.11) 
-* FreeBSD 10 
 * AIX 7.1 (POWER4)
+* FreeBSD 10 
+* Solaris 11 (SunOS 5.11) 
 
 How do I resolve JNA `NoClassDefFound` errors?
 ========
@@ -70,7 +70,7 @@ with nearly all SIGAR functions. Key differences include:
 operating systems. It therefore requires users to download an additional DLL specific to their operating
 system. This does have a few advantages for specific, targeted use cases, including faster native code routines,
 and availability of some native compiler intrinsics. In contrast, OSHI accesses native APIs using JNA, which
-does not require installation of any additional platform-specific DLLs.
+does not require user installation of any additional platform-specific DLLs.
  - **Corporate Development / Abandonment** SIGAR was developed commercially at Hyperic to support monitoring of
 their HQ product. Hyperic's products were later acquired by VMWare, which has transitioned away from Hyperic
 products and have completely abandoned SIGAR. The [last release](https://github.com/hyperic/sigar/releases/tag/sigar-1.6.4)
@@ -87,10 +87,6 @@ Yes, most of the Linux code works here and other Pi-specific code has been imple
 limited testing.  As the developers do not have a Pi to test on, users reporting issues should be 
 prepared to help test solutions.
 
-Will you do a HP-UX port? OpenBSD? How about Android?
-========
-OSHI depends on JNA, which does not produce a native binary for HP-UX.  Support for OpenBSD or Android is unlikely, unless paid to do so.  But happy to advise someone else!
-
 Will you implement ... ?
 ========
 Maybe!  If you can contribute all the code to implement the feature, it will almost certainly be added.  Even if you can't code but can provide pointers to where the information can be found cross-platform, your feature has a good chance. Otherwise, you can always submit an issue to ask, but are at the mercy of the developers' time, enthusiasm level, and the availability of documentation for the feature.
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ memory and CPU usage, disks and partitions, devices, sensors, etc.
 
 Supported platforms 
 --------------------------- 
-Windows • Linux • macOS • Unix (Solaris, FreeBSD, AIX) 
+Windows • Linux • macOS • Unix (AIX, FreeBSD, Solaris) 
 
 Essentials
 ----------
@@ -54,11 +54,11 @@ Downloads
 ---------
 | Stable Release Version | Current Development Version | Dependencies |
 | ------------- | ------------- | ------------- |
-| [oshi-core-5.2.3](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.github.oshi&a=oshi-core&v=5.2.3&e=jar)  | [oshi-core-5.3.0-SNAPSHOT](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.oshi&a=oshi-core&v=5.3.0-SNAPSHOT&e=jar) | [JNA](https://github.com/java-native-access/jna) • [SLF4J](http://www.slf4j.org/) |
+| [oshi-core-5.2.4](https://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.github.oshi&a=oshi-core&v=5.2.4&e=jar)  | [oshi-core-5.3.0-SNAPSHOT](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.oshi&a=oshi-core&v=5.3.0-SNAPSHOT&e=jar) | [JNA](https://github.com/java-native-access/jna) • [SLF4J](http://www.slf4j.org/) |
 
 Usage
 -----
-1. Include OSHI and its dependencies on your classpath.  We strongly recommend you add OSHI as a dependency to your project dependency manager such as Maven or Gradle. You can [find the appropriate syntax to include OSHI here](https://search.maven.org/artifact/com.github.oshi/oshi-core/5.2.3/jar). 
+1. Include OSHI and its dependencies on your classpath.  We strongly recommend you add OSHI as a dependency to your project dependency manager such as Maven or Gradle. You can [find the appropriate syntax to include OSHI here](https://search.maven.org/artifact/com.github.oshi/oshi-core/5.2.4/jar). 
 
 2. Create a new instance of `SystemInfo` 
 
@@ -70,16 +70,7 @@ HardwareAbstractionLayer hal = si.getHardware();
 CentralProcessor cpu = hal.getProcessor();
 ```
 
-You can see more examples and run the [SystemInfoTest](https://github.com/oshi/oshi/blob/master/oshi-core/src/test/java/oshi/SystemInfoTest.java)
-and see the full output for your system by cloning the project and building it with [Maven](https://maven.apache.org/index.html):
-
-```
-git clone https://github.com/oshi/oshi.git && cd oshi
-
-./mvnw test-compile -pl oshi-core exec:java \
-  -Dexec.mainClass="oshi.SystemInfoTest" \
-  -Dexec.classpathScope="test"
-```
+The `oshi-demo` artifact includes [several proof-of-concept examples](https://github.com/oshi/oshi/blob/master/oshi-demo/src/main/java/oshi/demo/) of using OSHI to obtain information, including a basic Swing GUI.
 
 Note: OSHI uses the latest version of [JNA](https://github.com/java-native-access/jna), which may conflict with other dependencies your project (or its parent) includes. If you experience issues with `NoClassDefFound` errors for JNA artifacts, consider one or more of the following steps to resolve the conflict:
  - Listing OSHI earlier (or first) in your dependency list 
@@ -102,8 +93,16 @@ Output
 OSHI provides output directly via Java methods for each of its interfaces.  
 By periodically polling dynamic information (e.g., every second), users can calculate and track changes.
 
-The `main()` method of [SystemInfoTest](https://github.com/oshi/oshi/blob/master/oshi-core/src/test/java/oshi/SystemInfoTest.java) 
-provides sample code demonstrating the use of `oshi-core` interfaces to retrieve information and calculate additional metrics shown in the examples below.
+You can see more examples and run the [SystemInfoTest](https://github.com/oshi/oshi/blob/master/oshi-core/src/test/java/oshi/SystemInfoTest.java)
+and see the full output for your system by cloning the project and building it with [Maven](https://maven.apache.org/index.html):
+
+```
+git clone https://github.com/oshi/oshi.git && cd oshi
+
+./mvnw test-compile -pl oshi-core exec:java \
+  -Dexec.mainClass="oshi.SystemInfoTest" \
+  -Dexec.classpathScope="test"
+```
 
 In addition, the `oshi-demo` project includes an [OshiGui](https://github.com/oshi/oshi/blob/master/oshi-demo/src/main/java/oshi/demo/OshiGui.java) class implementing a basic Swing GUI offering suggestions for potential visualizations using OSHI in a UI, monitoring, or alerting application, as shown below: