You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/01/15 22:12:28 UTC

[maven-build-cache-extension] branch master updated: rename main entry point to BuildCacheMojosExecutionStrategy

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

hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-build-cache-extension.git


The following commit(s) were added to refs/heads/master by this push:
     new b6d430d  rename main entry point to BuildCacheMojosExecutionStrategy
b6d430d is described below

commit b6d430d88be6cee54618d087da7f7c73e6685258
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sat Jan 15 23:12:25 2022 +0100

    rename main entry point to BuildCacheMojosExecutionStrategy
---
 ...tionStrategy.java => BuildCacheMojosExecutionStrategy.java} | 10 ++++------
 src/main/java/org/apache/maven/buildcache/CacheUtils.java      |  2 +-
 src/site/apt/index.apt                                         |  2 +-
 src/site/markdown/cache.md                                     |  2 +-
 src/site/markdown/how-to.md                                    |  2 +-
 src/site/markdown/usage.md                                     |  4 ++--
 6 files changed, 10 insertions(+), 12 deletions(-)

diff --git a/src/main/java/org/apache/maven/buildcache/CachingMojosExecutionStrategy.java b/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java
similarity index 98%
rename from src/main/java/org/apache/maven/buildcache/CachingMojosExecutionStrategy.java
rename to src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java
index d334e53..b79d2f6 100644
--- a/src/main/java/org/apache/maven/buildcache/CachingMojosExecutionStrategy.java
+++ b/src/main/java/org/apache/maven/buildcache/BuildCacheMojosExecutionStrategy.java
@@ -53,18 +53,16 @@ import static org.apache.maven.buildcache.xml.CacheState.DISABLED;
 import static org.apache.maven.buildcache.xml.CacheState.INITIALIZED;
 
 /**
- * <p>
- * Cache-enabled version of the MojoExecutor
- * </p>
+ * Build cache-enabled version of the {@link MojosExecutionStrategy}.
  */
 @SessionScoped
 @Named
 @Priority( 10 )
 @SuppressWarnings( "unused" )
-public class CachingMojosExecutionStrategy implements MojosExecutionStrategy
+public class BuildCacheMojosExecutionStrategy implements MojosExecutionStrategy
 {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger( CachingMojosExecutionStrategy.class );
+    private static final Logger LOGGER = LoggerFactory.getLogger( BuildCacheMojosExecutionStrategy.class );
 
     private final CacheController cacheController;
     private final CacheConfig cacheConfig;
@@ -73,7 +71,7 @@ public class CachingMojosExecutionStrategy implements MojosExecutionStrategy
     private final MavenPluginManager mavenPluginManager;
 
     @Inject
-    public CachingMojosExecutionStrategy(
+    public BuildCacheMojosExecutionStrategy(
             CacheController cacheController,
             CacheConfig cacheConfig,
             MojoParametersListener mojoListener,
diff --git a/src/main/java/org/apache/maven/buildcache/CacheUtils.java b/src/main/java/org/apache/maven/buildcache/CacheUtils.java
index edfd283..d02d08e 100644
--- a/src/main/java/org/apache/maven/buildcache/CacheUtils.java
+++ b/src/main/java/org/apache/maven/buildcache/CacheUtils.java
@@ -50,7 +50,7 @@ import static org.apache.maven.artifact.Artifact.LATEST_VERSION;
 import static org.apache.maven.artifact.Artifact.SNAPSHOT_VERSION;
 
 /**
- * ProjectUtils
+ * Cache Utils
  */
 public class CacheUtils
 {
diff --git a/src/site/apt/index.apt b/src/site/apt/index.apt
index b2ebdf7..689b426 100644
--- a/src/site/apt/index.apt
+++ b/src/site/apt/index.apt
@@ -23,7 +23,7 @@
  2021-11-11
  -----
 
-Maven Caching
+Maven Build Cache Extension
 
  Maven Incremental Build and Cache (local and remote).
 
diff --git a/src/site/markdown/cache.md b/src/site/markdown/cache.md
index a0d025e..1d2f526 100644
--- a/src/site/markdown/cache.md
+++ b/src/site/markdown/cache.md
@@ -27,7 +27,7 @@ achieved by a combination of features:
 
 Large projects usually pose scalability challenges and work with such projects require build tool which scales. Cache
 extension addresses that with incremental build execution and ability to efficiently work on sub-parts of a larger
-project without building and installing dependencies from the larger project. Though, features implemented in maven
+project without building and installing dependencies from the larger project. Though, features implemented in Maven
 should give noticeable benefits in medium and small sized projects as well.
 
 ### Cache concepts
diff --git a/src/site/markdown/how-to.md b/src/site/markdown/how-to.md
index 56b4832..45bc3b1 100644
--- a/src/site/markdown/how-to.md
+++ b/src/site/markdown/how-to.md
@@ -159,7 +159,7 @@ Add `executionControl/runAlways` section
             </goalsLists>
         </runAlways>
     </executionControl>
-``` 
+```
 
 ### I occasionally cached build with `-DskipTests=true` and tests do not run now
 
diff --git a/src/site/markdown/usage.md b/src/site/markdown/usage.md
index 45c23c5..ef81487 100644
--- a/src/site/markdown/usage.md
+++ b/src/site/markdown/usage.md
@@ -48,10 +48,10 @@ On command line:
 
 ## IDE support
 
-Cache extension is generally compatible with ides with one limitation:
+Build cache extension is generally compatible with IDEs with one limitation:
 
 * The cache doesn't restore full project state. Compiled classes and other output directories will not be restored from
-  cache if `clean` was invoked. In order to work efficiently, IDE should be configured to not use maven
+  cache if `clean` was invoked. In order to work efficiently, IDE should be configured to not use Maven
   output (`target`) directories for compilation. In that case compilation caches will be maintained by IDE leveraging
   both fast builds and fast compilation