This is an automated email from the ASF dual-hosted git repository. tv pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
commit 989340bde3b2f97b162b53ac4b28bbd7d5d28b64 Author: Thomas Vandahl <[email protected]> AuthorDate: Wed Mar 25 21:58:37 2026 +0100 Update documentation --- commons-jcs4-core/pom.xml | 4 +++ commons-jcs4-jcache-extras/pom.xml | 4 +++ commons-jcs4-jcache-openjpa/pom.xml | 4 +++ commons-jcs4-jcache-tck/pom.xml | 4 ++- commons-jcs4-jcache/pom.xml | 4 +++ src/site/site.xml | 7 +++- src/site/xdoc/JCSandJCACHE.xml | 9 +++-- src/site/xdoc/getting_started/intro.xml | 4 +++ src/site/xdoc/index.xml | 59 +++++++++++++++++++++++---------- 9 files changed, 77 insertions(+), 22 deletions(-) diff --git a/commons-jcs4-core/pom.xml b/commons-jcs4-core/pom.xml index 9c803436..24c4a072 100644 --- a/commons-jcs4-core/pom.xml +++ b/commons-jcs4-core/pom.xml @@ -31,6 +31,10 @@ <packaging>jar</packaging> <name>Apache Commons JCS :: Core</name> + <description> + This module contains the core implementation of Apache Commons JCS. + It consists of multiple memory cache implementations and various auxiliary plugins. + </description> <scm> <connection>scm:git:https://gitbox.apache.org/repos/asf/commons-jcs.git</connection> diff --git a/commons-jcs4-jcache-extras/pom.xml b/commons-jcs4-jcache-extras/pom.xml index 4d48f836..66914213 100644 --- a/commons-jcs4-jcache-extras/pom.xml +++ b/commons-jcs4-jcache-extras/pom.xml @@ -26,6 +26,10 @@ <modelVersion>4.0.0</modelVersion> <artifactId>commons-jcs4-jcache-extras</artifactId> <name>Apache Commons JCS :: JCache Extras</name> + <description> + This module contains some extensions to the JSR-107 JCache implementation. + </description> + <scm> <connection>scm:git:https://gitbox.apache.org/repos/asf/commons-jcs.git</connection> <developerConnection>scm:git:https://gitbox.apache.org/repos/asf/commons-jcs.git</developerConnection> diff --git a/commons-jcs4-jcache-openjpa/pom.xml b/commons-jcs4-jcache-openjpa/pom.xml index f57ff87d..fe07db8a 100644 --- a/commons-jcs4-jcache-openjpa/pom.xml +++ b/commons-jcs4-jcache-openjpa/pom.xml @@ -27,6 +27,10 @@ <artifactId>commons-jcs4-jcache-openjpa</artifactId> <name>Apache Commons JCS :: JCache OpenJPA</name> + <description> + This module contains an implementation of a DataCache for OpenJPA based on + the JSR-107 JCache implementation. + </description> <scm> <connection>scm:git:https://gitbox.apache.org/repos/asf/commons-jcs.git</connection> diff --git a/commons-jcs4-jcache-tck/pom.xml b/commons-jcs4-jcache-tck/pom.xml index 3703891e..17ee3dbd 100644 --- a/commons-jcs4-jcache-tck/pom.xml +++ b/commons-jcs4-jcache-tck/pom.xml @@ -34,8 +34,10 @@ --> <artifactId>commons-jcs4-jcache-tck</artifactId> - <name>Apache Commons JCS :: JCache TCK</name> + <description> + This module runs the JSR-107 TCK for JCache. + </description> <scm> <connection>scm:git:https://gitbox.apache.org/repos/asf/commons-jcs.git</connection> diff --git a/commons-jcs4-jcache/pom.xml b/commons-jcs4-jcache/pom.xml index fe5c98ff..c822d952 100644 --- a/commons-jcs4-jcache/pom.xml +++ b/commons-jcs4-jcache/pom.xml @@ -29,6 +29,10 @@ <artifactId>commons-jcs4-jcache</artifactId> <name>Apache Commons JCS :: JCache</name> + <description> + This module contains the JSR-107 API (version ${jsr107.api.version}) implementation of + Apache Commons JCS. + </description> <scm> <connection>scm:git:https://gitbox.apache.org/repos/asf/commons-jcs.git</connection> diff --git a/src/site/site.xml b/src/site/site.xml index 9a3df6ea..c72aeb15 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -73,7 +73,12 @@ </item> </menu> - <menu ref="modules" /> + <menu name="Modules"> + <item name="Core" href="commons-jcs4-core/index.html"/> + <item name="JCache" href="commons-jcs4-jcache/index.html"/> + <item name="JCache Extras" href="commons-jcs4-jcache-extras/index.html"/> + <item name="JCache OpenJPA" href="commons-jcs4-jcache-openjpa/index.html"/> + </menu> </body> diff --git a/src/site/xdoc/JCSandJCACHE.xml b/src/site/xdoc/JCSandJCACHE.xml index 50898eb9..f7f24904 100644 --- a/src/site/xdoc/JCSandJCACHE.xml +++ b/src/site/xdoc/JCSandJCACHE.xml @@ -28,9 +28,12 @@ <body> <section name="JCACHE (JSR-107)"> <p> - Since version 2.x, Apache Commons JCS implements - JCache specification (and a few more providing some basic utilities - in its extras module and a basic integration with Apache OpenJPA). + Since version 2.x, Apache Commons JCS implements the + <a href="commons-jcs4-jcache/index.html">JCache specification</a> + (and a few more providing some basic utilities in its + <a href="commons-jcs4-jcache-extras/index.html">extras module</a> + and a <a href="commons-jcs4-jcache-openjpa/index.html">basic integration</a> + with Apache OpenJPA). </p> <p> The next section is about the main differences between the JCache design and the original JCS one. diff --git a/src/site/xdoc/getting_started/intro.xml b/src/site/xdoc/getting_started/intro.xml index 5fb5248e..0f5c4ebb 100644 --- a/src/site/xdoc/getting_started/intro.xml +++ b/src/site/xdoc/getting_started/intro.xml @@ -91,6 +91,10 @@ </section> <section name="STEP 3: Get the Required Dependencies"> + <p> + Beginning with version 3.0 the core of JCS has no mandatory external + dependencies. + </p> <p> Beginning with version 2.0 the core of JCS (the LRU memory cache, the indexed disk cache, the TCP lateral, and the diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml index 0c8c0566..bd90bb5c 100644 --- a/src/site/xdoc/index.xml +++ b/src/site/xdoc/index.xml @@ -57,6 +57,9 @@ <li>Key pattern matching retrieval</li> <li>Network efficient multi-key retrieval</li> </ul> + <p> JCS 4.x works on JDK versions 17 and up. It has no + mandatory external dependencies. See the document about + <a href="UpgradingFrom3x.html">upgrading</a>.</p> <p> JCS 3.x works on JDK versions 1.8 and up. It has no mandatory external dependencies. See the document about <a href="UpgradingFrom2x.html">upgrading</a>.</p> @@ -89,23 +92,45 @@ . </p> </subsection> - <subsection name="Indexed Disk Cache"> - <p> - The - <a href="IndexedDiskAuxCache.html">Indexed Disk Cache</a> - is a fast, reliable, and - <a href="IndexedDiskCacheProperties.html"> highly configurable</a> - swap for cached data. The indexed disk cache follows the fastest - pattern for disk swapping. Cache elements are written to disk via a - continuous queue-based process. The length of the item is stored in - the first few bytes of the entry. The offset is stored in memory - and can be reference via the key. When items are removed from the - disk cache, the location and size are recorded and reused when - possible. Every aspect of the disk cache is configurable, and a - thread pool can be used to reduce the number of queue worker - threads across the system. - </p> - </subsection> + <subsection name="Indexed Disk Cache"> + <p> + The + <a href="IndexedDiskAuxCache.html">Indexed Disk Cache</a> + is a fast, reliable, and + <a href="IndexedDiskCacheProperties.html"> highly configurable</a> + swap for cached data. The indexed disk cache follows the fastest + pattern for disk swapping. Cache elements are written to disk via a + continuous queue-based process. The length of the item is stored in + the first few bytes of the entry. The offset is stored in memory + and can be reference via the key. When items are removed from the + disk cache, the location and size are recorded and reused when + possible. Every aspect of the disk cache is configurable, and a + thread pool can be used to reduce the number of queue worker + threads across the system. + </p> + </subsection> + <subsection name="Block Disk Cache"> + <p> + The + <a href="BlockDiskCache.html">Block Disk Cache</a> + is a fast and reliable swap for cached data, similar to the + Indexed Disk Cache. + </p> + <p> + The Block Disk Cache stores cached values on disk + in a group of fixed size blocks, whereas the Indexed + Disk Cache writes items to disk in one chunk. + </p> + <p> + The Block Disk Cache has advantages over the normal + indexed model for regions where the size of the items + varies. Since all the blocks are the same size, the + recycle bin is very simple. It is just a list of block + numbers. Also, the Block Disk Cache will never need to + be optimized. Once the maximum number of keys is + reached, blocks will be reused. + </p> + </subsection> <subsection name="JDBC Disk Cache"> <p> The
