[maven-resolver] branch master updated: Updated Redisson and HZ doco (#130)

[cs...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cstamas 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 ff6b0b9  Updated Redisson and HZ doco (#130)
ff6b0b9 is described below

commit ff6b0b92d47b2eaf8e722ad40cb02852ca1102a6
Author: Tamas Cservenak <ta...@cservenak.net>
AuthorDate: Thu Oct 7 13:34:51 2021 +0200

    Updated Redisson and HZ doco (#130)
    
    Make it clear that "it only works with Sisu" is meant for integrators,
    not "end users" wishing to use them with Maven.
---
 .../src/site/markdown/index.md.vm                             | 11 +++++++++--
 .../src/site/markdown/index.md.vm                             | 11 +++++++++--
 2 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm b/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm
index cdd6ebd..40f629c 100644
--- a/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm
+++ b/maven-resolver-named-locks-hazelcast/src/site/markdown/index.md.vm
@@ -32,12 +32,19 @@ Out of the box "hazelcast" (distributed) named lock implementations are the foll
 
 ${esc.hash}${esc.hash} Open Issues/Notes
 
-- It only works when Sisu DI is used and not the bundled `AetherModule` or
-  `ServiceLocator` (Maven uses Sisu dependency injection).
 - 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.
 
+${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.
+
 ${esc.hash}${esc.hash} Installation/Testing
 
 - Create the directory `${maven.home}/lib/ext/hazelcast/`.
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 efb2eef..951d4e5 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
@@ -31,12 +31,19 @@ Out of the box "redisson" (distributed) named lock implementations are the follo
 
 ${esc.hash}${esc.hash} Open Issues/Notes
 
-- It only works when Sisu DI is used and not the bundled `AetherModule` or
-  `ServiceLocator` (Maven uses Sisu dependency injection).
 - 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.
 
+${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.
+
 ${esc.hash}${esc.hash} Installation/Testing
 
 - Create the directory `${maven.home}/lib/ext/redisson/`.