[maven-resolver] branch MRESOLVER-131 updated: Doc improvements

[mi...@apache.org]

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

michaelo pushed a commit to branch MRESOLVER-131
in repository https://gitbox.apache.org/repos/asf/maven-resolver.git


The following commit(s) were added to refs/heads/MRESOLVER-131 by this push:
     new fe411fb  Doc improvements
fe411fb is described below

commit fe411fb1fff7155cbf743a93f8f097de789a0635
Author: Michael Osipov <mi...@apache.org>
AuthorDate: Sun Aug 16 20:18:14 2020 +0200

    Doc improvements
---
 .../synccontext/RedissonSyncContextFactory.java      |  4 +++-
 .../src/site/markdown/index.md                       | 20 ++++++++++----------
 2 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/maven-resolver-synccontext-redisson/src/main/java/org/eclipse/aether/synccontext/RedissonSyncContextFactory.java b/maven-resolver-synccontext-redisson/src/main/java/org/eclipse/aether/synccontext/RedissonSyncContextFactory.java
index ba5381b..6189903 100644
--- a/maven-resolver-synccontext-redisson/src/main/java/org/eclipse/aether/synccontext/RedissonSyncContextFactory.java
+++ b/maven-resolver-synccontext-redisson/src/main/java/org/eclipse/aether/synccontext/RedissonSyncContextFactory.java
@@ -87,7 +87,7 @@ import org.slf4j.LoggerFactory;
  * <li>Determine hostname, if not possible use {@code localhost}.</li>
  * <li>If the property {@code aether.syncContext.redisson.discriminator} is set, use it and skip
  * the remaining steps.</li>
- * <li>Concat hostname with the path of the local repository: <code>${hostname}:${maven.repo.local}</code></li>
+ * <li>Concat hostname with the path of the local repository: <code>${hostname}:${maven.repo.local}</code>.</li>
  * <li>Calculate the SHA-1 digest of this value. If that fails use the static digest of an empty string.</li>
  * </ol>
  *
@@ -125,6 +125,7 @@ public class RedissonSyncContextFactory
 
     public RedissonSyncContextFactory()
     {
+        // TODO These statements will go away
         LOGGER.trace( "TCCL: {}", Thread.currentThread().getContextClassLoader() );
         LOGGER.trace( "CCL: {}", getClass().getClassLoader() );
         this.redissonClient = createRedissonClient();
@@ -203,6 +204,7 @@ public class RedissonSyncContextFactory
 
     public SyncContext newInstance( RepositorySystemSession session, boolean shared )
     {
+        // This statement will go away
         LOGGER.trace( "Instance: {}", this );
         return new RedissonSyncContext( session, hostname, redissonClient, shared );
     }
diff --git a/maven-resolver-synccontext-redisson/src/site/markdown/index.md b/maven-resolver-synccontext-redisson/src/site/markdown/index.md
index 5519235..333d3ab 100644
--- a/maven-resolver-synccontext-redisson/src/site/markdown/index.md
+++ b/maven-resolver-synccontext-redisson/src/site/markdown/index.md
@@ -30,20 +30,20 @@ For further details about the factory read the [Javadoc](./apidocs/org/eclipse/a
 ## Open Issues/Notes
 
 - It only works when dependency injection is used and not the bundled `AetherModule` or
-  `ServiceLocator` (Maven uses dependency injection)
+  `ServiceLocator` (Maven uses dependency injection).
 - It includes a lot of trace logging which partially will go way as soon as it has been stablilized
-- Usage from plugins has not been tested yet
+- 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
-- The installation process has not been streamlined yet
+  of dependency injection.
+- The installation process has not been streamlined yet.
 
 ## Installation/Testing
 
-- Clone Maven Resolver, switch to `MRESOLVER-131` branch and perform `mvn install`
-- Clone Maven, switch to `master` branch, change the Resolver version in Maven's parent POM: `1.5.1-SNAPSHOT`
-- Extract `apache-maven-3.7.0-SNAPSHOT-bin.tar.gz` to a location of your choice
+- Clone Maven Resolver, switch to `MRESOLVER-131` branch and perform `mvn install`.
+- Clone Maven, switch to `master` branch, change the Resolver version in Maven's parent POM: `1.5.1-SNAPSHOT`.
+- Extract `apache-maven-3.7.0-SNAPSHOT-bin.tar.gz` to a location of your choice.
 - Modify `${maven.home}/bin/m2.conf` by adding `optionally ${maven.home}/lib/ext/redisson/*.jar`
-  right after the `${maven.home}/conf/logging` line
+  right after the `${maven.home}/conf/logging` line.
 - Add/modify the following entries in `${maven.home}/conf/logging/simplelogger.properties`:
       ```
       org.slf4j.simpleLogger.showDateTime=true
@@ -53,7 +53,7 @@ For further details about the factory read the [Javadoc](./apidocs/org/eclipse/a
       #org.slf4j.simpleLogger.log.org.redisson=debug
       #org.slf4j.simpleLogger.log.io.netty=debug
       ```
-- Go back to Resolver and run `mvn dependency:copy-dependencies -pl maven-resolver-synccontext-redisson`
+- Go back to Resolver and run `mvn dependency:copy-dependencies -pl maven-resolver-synccontext-redisson`.
 - Copy the following dependencies from `maven-resolver-synccontext-redisson/target/dependency`
   to `${maven.home}/lib/ext/redisson/`:
       ```
@@ -84,7 +84,7 @@ For further details about the factory read the [Javadoc](./apidocs/org/eclipse/a
       └── snakeyaml-1.26.jar
       ```
     Dependencies which are already bundled with Maven have been omitted.
-- Start your Redis instance on a machine of your choice (ideally `localhost`)
+- Start your Redis instance on a machine of your choice (ideally `localhost`).
 - Now start a multithreaded Maven (`3.7.0-SNAPSHOT`) build on your project and you should see at least these lines:
       ```
       # This line does not appear for the default configuration