This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-resolver.git
The following commit(s) were added to refs/heads/master by this push:
new 3a8ea4c6 Improve docs
3a8ea4c6 is described below
commit 3a8ea4c6a93606705e3eacd9c7f5b885cc1f2f28
Author: Michael Osipov <micha...@apache.org>
AuthorDate: Fri Mar 3 10:08:52 2023 +0100
Improve docs
---
.../src/site/markdown/index.md.vm | 15 ++++++---------
.../src/site/markdown/analyzing-lock-issues.md | 6 +++++-
src/site/markdown/maven-3.8.x.md | 2 +-
3 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
b/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
index 43ad2e84..31f455da 100644
--- a/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
+++ b/maven-resolver-named-locks-redisson/src/site/markdown/index.md.vm
@@ -25,24 +25,20 @@ Redisson distributed objects feature.
Out of the box "redisson" (distributed) named lock implementations are the
following:
- `rwlock-redisson` implemented in
`org.eclipse.aether.named.redisson.RedissonReadWriteLockNamedLockFactory`
- that uses Redisson backed `org.redisson.api.RReadWriteLock`.
+ that uses Redisson-backed `org.redisson.api.RReadWriteLock`.
- `semaphore-redisson` implemented in
`org.eclipse.aether.named.redisson.RedissonSemaphoreNamedLockFactory`
- that uses Redisson backed `org.redisson.api.RSemaphore`.
+ that uses Redisson-backed `org.redisson.api.RSemaphore`.
${esc.hash}${esc.hash} Open Issues/Notes
-- Usage from plugins has not been tested yet.
-- The `furnace-maven-plugin` does not work this implementation because it uses
`ServiceLocator` instead
- of dependency injection.
+- Usage from plugins and extensions hasn't been fully tested yet.
${esc.hash}${esc.hash} Open Issues/Notes for Maven Resolver integrators
To use this implementation within your project, depending on how you
integrate, you have following options:
- If you use Sisu DI, then all you need is to provide this module (and its
dependencies) on classpath and you are done.
- If you use Guice, you need to add this module (and its dependencies)
upfront, and bind them explicitly.
-- If you use ServiceLocator, be aware it is deprecated, and you should move
away from it. In this case, simplest is
- to roll your own "bootstrap" class that does pretty much same thing as
ServiceLocator was, and extend it to
- instantiate these components as well.
+- If you use ServiceLocator, this module will not work.
${esc.hash}${esc.hash} Installation/Testing
@@ -72,4 +68,5 @@ ${esc.hash}${esc.hash} Installation/Testing
├── <a
href="https://repo1.maven.org/maven2/io/netty/netty-transport/${nettyVersion}/netty-transport-${nettyVersion}.jar";>netty-transport-${nettyVersion}.jar</a>
└── <a
href="https://repo1.maven.org/maven2/org/yaml/snakeyaml/${snakeyamlVersion}/snakeyaml-${snakeyamlVersion}.jar";>snakeyaml-${snakeyamlVersion}.jar</a></pre>
- Start your Redis instance on `localhost` or configure a remote instance with
`${maven.conf}/maven-resolver-redisson.yaml`.
-- Now start a multithreaded Maven build on your project.
+- Now start a multithreaded Maven build or multiple builds (e.g., CI server)
on your project.
+
diff --git
a/maven-resolver-named-locks/src/site/markdown/analyzing-lock-issues.md
b/maven-resolver-named-locks/src/site/markdown/analyzing-lock-issues.md
index f8efff18..1bf90743 100644
--- a/maven-resolver-named-locks/src/site/markdown/analyzing-lock-issues.md
+++ b/maven-resolver-named-locks/src/site/markdown/analyzing-lock-issues.md
@@ -25,7 +25,7 @@ This guide will show you how to collect and analyze lock
issues to report with u
Make sure that the following applies:
-- Bash or Bash-compatible installed
+- Bash or Bash-compatible shell installed
- BSD or GNU userland installed
- SQLite installed
- At least Maven 3.9.0
@@ -44,6 +44,8 @@ Prepare your environment:
[`create_lock_workflows.sql`](./sql/create_lock_workflows.sql) and set
`SCHEMA_FILE`,
`CREATE_LOCK_EVENTS_FILE`, `CREATE_LOCK_WORKFLOWS_FILE` to their respective
locations
+TIP: See [overview](./index.html) of possible values for `LOCK_FACTORY` and
`NAME_MAPPER`.
+
## Running Builds
Open `$JOB_COUNT` terminals and change into the `$ROOT/$PROJECT_NAME-1` to
`$ROOT/$PROJECT_NAME-$JOB_COUNT`
@@ -65,6 +67,8 @@ $ for build in $(eval echo {1..$BUILD_COUNT}); do \
Wait for all jobs to complete.
+TIP: If you don't need parallel (multiprocess) builds, you can set `JOB_COUNT`
to 1.
+
## Analyzing Builds
We now need to extract, transform and load the data (ETL) into a SQLite
database.
diff --git a/src/site/markdown/maven-3.8.x.md b/src/site/markdown/maven-3.8.x.md
index 1b928696..21ead383 100644
--- a/src/site/markdown/maven-3.8.x.md
+++ b/src/site/markdown/maven-3.8.x.md
@@ -20,7 +20,7 @@ under the License.
Since version 1.7.0, Maven Resolver requires Java 8 to run and a brand new
default sync context
factory has been implemented. Both are not compatible with Maven 3.8.x anymore
which still requires
-Java 7 to run. Maven 3.8.x will continue to use version 1.6.x which you will
find
+Java 7 to run. Maven 3.8.x will continue to use version 1.6.x which you can
find
[here](/resolver-archives/resolver-1.6.3/).
This also means that you cannot make use of the features provided by version
1.7.0 and later.
If you require the changes from this version, but must use Maven 3.8.x, you
can build yourself an adapted version
