This is an automated email from the ASF dual-hosted git repository. tv pushed a commit to branch release-3.2 in repository https://gitbox.apache.org/repos/asf/commons-jcs.git
commit 817aa692c9851417737947ab5c6f7ccea263078f Author: Thomas Vandahl <[email protected]> AuthorDate: Sun Jan 8 20:46:00 2023 +0100 Update generated files --- CONTRIBUTING.md | 230 +++++++++++++++++++++++++-------------------------- README.md | 211 +++++++++++++++++++++++----------------------- xdocs/mail-lists.xml | 20 +++-- 3 files changed, 236 insertions(+), 225 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7e75de18..019a5169 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,115 +1,115 @@ -<!--- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!--- - +======================================================================+ - |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| - |**** DO NOT EDIT DIRECTLY ****| - |**** ****| - +======================================================================+ - | TEMPLATE FILE: contributing-md-template.md | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | - +======================================================================+ - | | - | 1) Re-generate using: mvn commons-build:contributing-md | - | | - | 2) Set the following properties in the component's pom: | - | - commons.jira.id (required, alphabetic, upper case) | - | | - | 3) Example Properties | - | | - | <properties> | - | <commons.jira.id>MATH</commons.jira.id> | - | </properties> | - | | - +======================================================================+ ----> -Contributing to Apache Commons JCS -====================== - -You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to -the open source community. Before you dig right into the code there are a few guidelines that we need contributors to -follow so that we can have a chance of keeping on top of things. - -Getting Started ---------------- - -+ Make sure you have a [JIRA account](https://issues.apache.org/jira/). -+ Make sure you have a [GitHub account](https://github.com/signup/free). -+ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons JCS's scope. -+ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist. - + Clearly describe the issue including steps to reproduce when it is a bug. - + Make sure you fill in the earliest version that you know has the issue. -+ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-), -[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. - -Making Changes --------------- - -+ Create a _topic branch_ for your isolated work. - * Usually you should base your branch on the `master` branch. - * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `JCS-123-InputStream`. - * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests. -+ Make commits of logical units. - * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue. - * e.g. `JCS-123: Close input stream earlier` -+ Respect the original code style: - + Only use spaces for indentation. - + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first. - + Check for unnecessary whitespace with `git diff` -- check before committing. -+ Make sure you have added the necessary tests for your changes, typically in `src/test/java`. -+ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken. - -Making Trivial Changes ----------------------- - -The JIRA tickets are used to generate the changelog for the next release. - -For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. -In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. - - -Submitting Changes ------------------- - -+ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already. - * Note that small patches & typical bug fixes do not require a CLA as - clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions) - covers them. -+ Push your changes to a topic branch in your fork of the repository. -+ Submit a _Pull Request_ to the corresponding repository in the `apache` organization. - * Verify _Files Changed_ shows only your intended changes and does not - include additional files like `target/*.class` -+ Update your JIRA ticket and include a link to the pull request in the ticket. - -If you prefer to not use GitHub, then you can instead use -`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue. - - -Additional Resources --------------------- - -+ [Contributing patches](https://commons.apache.org/patches.html) -+ [Apache Commons JCS JIRA project page][jira] -+ [Contributor License Agreement][cla] -+ [General GitHub documentation](https://help.github.com/) -+ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) -+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.net` - -[cla]:https://www.apache.org/licenses/#clas -[jira]:https://issues.apache.org/jira/browse/JCS +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!--- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: contributing-md-template.md | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons-build:contributing-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.jira.id (required, alphabetic, upper case) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.jira.id>MATH</commons.jira.id> | + | </properties> | + | | + +======================================================================+ +---> +Contributing to Apache Commons JCS +====================== + +You have found a bug or you have an idea for a cool new feature? Contributing code is a great way to give something back to +the open source community. Before you dig right into the code there are a few guidelines that we need contributors to +follow so that we can have a chance of keeping on top of things. + +Getting Started +--------------- + ++ Make sure you have a [JIRA account](https://issues.apache.org/jira/). ++ Make sure you have a [GitHub account](https://github.com/signup/free). ++ If you're planning to implement a new feature it makes sense to discuss your changes on the [dev list](https://commons.apache.org/mail-lists.html) first. This way you can make sure you're not wasting your time on something that isn't considered to be in Apache Commons JCS's scope. ++ Submit a [Jira Ticket][jira] for your issue, assuming one does not already exist. + + Clearly describe the issue including steps to reproduce when it is a bug. + + Make sure you fill in the earliest version that you know has the issue. ++ Find the corresponding [repository on GitHub](https://github.com/apache/?query=commons-), +[fork](https://help.github.com/articles/fork-a-repo/) and check out your forked repository. + +Making Changes +-------------- + ++ Create a _topic branch_ for your isolated work. + * Usually you should base your branch on the `master` or `trunk` branch. + * A good topic branch name can be the JIRA bug id plus a keyword, e.g. `JCS-123-InputStream`. + * If you have submitted multiple JIRA issues, try to maintain separate branches and pull requests. ++ Make commits of logical units. + * Make sure your commit messages are meaningful and in the proper format. Your commit message should contain the key of the JIRA issue. + * e.g. `JCS-123: Close input stream earlier` ++ Respect the original code style: + + Only use spaces for indentation. + + Create minimal diffs - disable _On Save_ actions like _Reformat Source Code_ or _Organize Imports_. If you feel the source code should be reformatted create a separate PR for this change first. + + Check for unnecessary whitespace with `git diff` -- check before committing. ++ Make sure you have added the necessary tests for your changes, typically in `src/test/java`. ++ Run all the tests with `mvn clean verify` to assure nothing else was accidentally broken. + +Making Trivial Changes +---------------------- + +The JIRA tickets are used to generate the changelog for the next release. + +For changes of a trivial nature to comments and documentation, it is not always necessary to create a new ticket in JIRA. +In this case, it is appropriate to start the first line of a commit with '(doc)' instead of a ticket number. + + +Submitting Changes +------------------ + ++ Sign and submit the Apache [Contributor License Agreement][cla] if you haven't already. + * Note that small patches & typical bug fixes do not require a CLA as + clause 5 of the [Apache License](https://www.apache.org/licenses/LICENSE-2.0.html#contributions) + covers them. ++ Push your changes to a topic branch in your fork of the repository. ++ Submit a _Pull Request_ to the corresponding repository in the `apache` organization. + * Verify _Files Changed_ shows only your intended changes and does not + include additional files like `target/*.class` ++ Update your JIRA ticket and include a link to the pull request in the ticket. + +If you prefer to not use GitHub, then you can instead use +`git format-patch` (or `svn diff`) and attach the patch file to the JIRA issue. + + +Additional Resources +-------------------- + ++ [Contributing patches](https://commons.apache.org/patches.html) ++ [Apache Commons JCS JIRA project page][jira] ++ [Contributor License Agreement][cla] ++ [General GitHub documentation](https://help.github.com/) ++ [GitHub pull request documentation](https://help.github.com/articles/creating-a-pull-request/) ++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) ++ `#apache-commons` IRC channel on `irc.freenode.net` + +[cla]:https://www.apache.org/licenses/#clas +[jira]:https://issues.apache.org/jira/browse/JCS diff --git a/README.md b/README.md index 1bbaa904..056bcb46 100644 --- a/README.md +++ b/README.md @@ -1,105 +1,106 @@ -<!--- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. ---> -<!--- - +======================================================================+ - |**** ****| - |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| - |**** DO NOT EDIT DIRECTLY ****| - |**** ****| - +======================================================================+ - | TEMPLATE FILE: readme-md-template.md | - | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | - +======================================================================+ - | | - | 1) Re-generate using: mvn commons-build:readme-md | - | | - | 2) Set the following properties in the component's pom: | - | - commons.componentid (required, alphabetic, lower case) | - | - commons.release.version (required) | - | | - | 3) Example Properties | - | | - | <properties> | - | <commons.componentid>math</commons.componentid> | - | <commons.release.version>1.2</commons.release.version> | - | </properties> | - | | - +======================================================================+ ----> -Apache Commons JCS -=================== - -[](https://github.com/apache/commons-jcs/actions) -[](https://app.codecov.io/gh/apache/commons-jcs) -[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-jcs3/?gav=true) -[](https://javadoc.io/doc/org.apache.commons/commons-jcs3/3.1) - -Apache Commons JCS is a distributed, versatile caching system. - -Documentation -------------- - -More information can be found on the [Apache Commons JCS homepage](https://commons.apache.org/proper/commons-jcs). -The [Javadoc](https://commons.apache.org/proper/commons-jcs/apidocs) can be browsed. -Questions related to the usage of Apache Commons JCS should be posted to the [user mailing list][ml]. - -Where can I get the latest release? ------------------------------------ -You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-jcs/download_jcs.cgi). - -Alternatively you can pull it from the central Maven repositories: - -```xml -<dependency> - <groupId>org.apache.commons</groupId> - <artifactId>commons-jcs3</artifactId> - <version>3.1</version> -</dependency> -``` - -Contributing ------------- - -We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. -There are some guidelines which will make applying PRs easier for us: -+ No tabs! Please use spaces for indentation. -+ Respect the code style. -+ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. -+ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn```. - -If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). -You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). - -License -------- -This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). - -See the `NOTICE.txt` file for required notices and attributions. - -Donations ---------- -You like Apache Commons JCS? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. - -Additional Resources --------------------- - -+ [Apache Commons Homepage](https://commons.apache.org/) -+ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/JCS) -+ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) -+ `#apache-commons` IRC channel on `irc.freenode.org` - -[ml]:https://commons.apache.org/mail-lists.html +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<!--- + +======================================================================+ + |**** ****| + |**** THIS FILE IS GENERATED BY THE COMMONS BUILD PLUGIN ****| + |**** DO NOT EDIT DIRECTLY ****| + |**** ****| + +======================================================================+ + | TEMPLATE FILE: readme-md-template.md | + | commons-build-plugin/trunk/src/main/resources/commons-xdoc-templates | + +======================================================================+ + | | + | 1) Re-generate using: mvn commons-build:readme-md | + | | + | 2) Set the following properties in the component's pom: | + | - commons.componentid (required, alphabetic, lower case) | + | - commons.release.version (required) | + | | + | 3) Example Properties | + | | + | <properties> | + | <commons.componentid>math</commons.componentid> | + | <commons.release.version>1.2</commons.release.version> | + | </properties> | + | | + +======================================================================+ +---> +Apache Commons JCS +=================== + +[](https://travis-ci.org/apache/commons-jcs) +[](https://github.com/apache/commons-jcs/actions) +[](https://coveralls.io/r/apache/commons-jcs) +[](https://maven-badges.herokuapp.com/maven-central/org.apache.commons/commons-jcs3/) +[](https://javadoc.io/doc/org.apache.commons/commons-jcs3/3.2) + +Apache Commons JCS is a distributed, versatile caching system. + +Documentation +------------- + +More information can be found on the [Apache Commons JCS homepage](https://commons.apache.org/proper/commons-jcs). +The [Javadoc](https://commons.apache.org/proper/commons-jcs/apidocs) can be browsed. +Questions related to the usage of Apache Commons JCS should be posted to the [user mailing list][ml]. + +Where can I get the latest release? +----------------------------------- +You can download source and binaries from our [download page](https://commons.apache.org/proper/commons-jcs/download_jcs.cgi). + +Alternatively you can pull it from the central Maven repositories: + +```xml +<dependency> + <groupId>org.apache.commons</groupId> + <artifactId>commons-jcs3</artifactId> + <version>3.2</version> +</dependency> +``` + +Contributing +------------ + +We accept Pull Requests via GitHub. The [developer mailing list][ml] is the main channel of communication for contributors. +There are some guidelines which will make applying PRs easier for us: ++ No tabs! Please use spaces for indentation. ++ Respect the code style. ++ Create minimal diffs - disable on save actions like reformat source code or organize imports. If you feel the source code should be reformatted create a separate PR for this change. ++ Provide JUnit tests for your changes and make sure your changes don't break any existing tests by running ```mvn clean test```. + +If you plan to contribute on a regular basis, please consider filing a [contributor license agreement](https://www.apache.org/licenses/#clas). +You can learn more about contributing via GitHub in our [contribution guidelines](CONTRIBUTING.md). + +License +------- +This code is under the [Apache Licence v2](https://www.apache.org/licenses/LICENSE-2.0). + +See the `NOTICE.txt` file for required notices and attributions. + +Donations +--------- +You like Apache Commons JCS? Then [donate back to the ASF](https://www.apache.org/foundation/contributing.html) to support the development. + +Additional Resources +-------------------- + ++ [Apache Commons Homepage](https://commons.apache.org/) ++ [Apache Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/JCS) ++ [Apache Commons Twitter Account](https://twitter.com/ApacheCommons) ++ `#apache-commons` IRC channel on `irc.freenode.org` + +[ml]:https://commons.apache.org/mail-lists.html diff --git a/xdocs/mail-lists.xml b/xdocs/mail-lists.xml index f19151ad..b37bef0d 100644 --- a/xdocs/mail-lists.xml +++ b/xdocs/mail-lists.xml @@ -105,7 +105,9 @@ limitations under the License. <td><a href="mailto:[email protected]";>Subscribe</a></td> <td><a href="mailto:[email protected]";>Unsubscribe</a></td> <td><a href="mailto:[email protected]?subject=[jcs]";>Post</a></td> - <td><a href="https://mail-archives.apache.org/mod_mbox/commons-user/";>mail-archives.apache.org</a></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-user/";>mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/[email protected]";>lists.apache.org</a> + </td> <td><a href="https://markmail.org/list/org.apache.commons.users/";>markmail.org</a><br /> <a href="https://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a><br /> <a href="https://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a> @@ -123,7 +125,9 @@ limitations under the License. <td><a href="mailto:[email protected]";>Subscribe</a></td> <td><a href="mailto:[email protected]";>Unsubscribe</a></td> <td><a href="mailto:[email protected]?subject=[jcs]";>Post</a></td> - <td><a href="https://mail-archives.apache.org/mod_mbox/commons-dev/";>mail-archives.apache.org</a></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-dev/";>mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/[email protected]";>lists.apache.org</a> + </td> <td><a href="https://markmail.org/list/org.apache.commons.dev/";>markmail.org</a><br /> <a href="https://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a><br /> <a href="https://news.gmane.org/gmane.comp.jakarta.commons.devel";>news.gmane.org</a> @@ -141,7 +145,9 @@ limitations under the License. <td><a href="mailto:[email protected]";>Subscribe</a></td> <td><a href="mailto:[email protected]";>Unsubscribe</a></td> <td><i>read only</i></td> - <td><a href="https://mail-archives.apache.org/mod_mbox/commons-issues/";>mail-archives.apache.org</a></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-issues/";>mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/[email protected]";>lists.apache.org</a> + </td> <td><a href="https://markmail.org/list/org.apache.commons.issues/";>markmail.org</a><br /> <a href="https://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a> </td> @@ -158,7 +164,9 @@ limitations under the License. <td><a href="mailto:[email protected]";>Subscribe</a></td> <td><a href="mailto:[email protected]";>Unsubscribe</a></td> <td><i>read only</i></td> - <td><a href="https://mail-archives.apache.org/mod_mbox/commons-commits/";>mail-archives.apache.org</a></td> + <td><a href="https://mail-archives.apache.org/mod_mbox/commons-commits/";>mail-archives.apache.org</a><br /> + <a href="https://lists.apache.org/[email protected]";>lists.apache.org</a> + </td> <td><a href="https://markmail.org/list/org.apache.commons.commits/";>markmail.org</a><br /> <a href="https://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a> </td> @@ -191,7 +199,9 @@ limitations under the License. <td><a class="externalLink" href="mailto:[email protected]";>Subscribe</a></td> <td><a class="externalLink" href="mailto:[email protected]";>Unsubscribe</a></td> <td><i>read only</i></td> - <td><a class="externalLink" href="https://mail-archives.apache.org/mod_mbox/www-announce/";>mail-archives.apache.org</a></td> + <td><a class="externalLink" href="https://mail-archives.apache.org/mod_mbox/www-announce/";>mail-archives.apache.org</a><br /> + <a class="externalLink" href="https://lists.apache.org/[email protected]";>lists.apache.org</a> + </td> <td><a class="externalLink" href="https://markmail.org/list/org.apache.announce/";>markmail.org</a><br /> <a class="externalLink" href="https://old.nabble.com/Apache-News-and-Announce-f109.html";>old.nabble.com</a><br /> <a class="externalLink" href="https://www.mail-archive.com/[email protected]/";>www.mail-archive.com</a><br />
