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 09:00:25 UTC
[maven-build-cache-extension] branch master updated: fix few consistency issues introduced when aligning to build-cache name
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 45fb0c0 fix few consistency issues introduced when aligning to build-cache name
45fb0c0 is described below
commit 45fb0c0fff33288ce5b29d740081490282303a83
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Sat Jan 15 10:00:23 2022 +0100
fix few consistency issues introduced when aligning to build-cache name
---
src/main/mdo/build-cache-report.mdo | 2 +-
src/site/markdown/getting-started.md | 20 +++++++++++---------
...build-cache-config.xml => maven-cache-config.xml} | 2 +-
src/site/site.xml | 8 ++++----
4 files changed, 17 insertions(+), 15 deletions(-)
diff --git a/src/main/mdo/build-cache-report.mdo b/src/main/mdo/build-cache-report.mdo
index 7c15313..bcaf64c 100644
--- a/src/main/mdo/build-cache-report.mdo
+++ b/src/main/mdo/build-cache-report.mdo
@@ -21,7 +21,7 @@ under the License.
xsi:schemaLocation="http://codehaus-plexus.github.io/MODELLO/1.4.0 http://codehaus-plexus.github.io/modello/xsd/modello-1.4.0.xsd"
xml.namespace="http://maven.apache.org/BUILD-CACHE-REPORT/${version}"
xml.schemaLocation="http://maven.apache.org/xsd/build-cache-report-${version}.xsd">
- <id>cbuild-ache-report</id>
+ <id>build-cache-report</id>
<name>BuildCacheReport</name>
<description><![CDATA[BuildCache report, stored in <code>build-cache-report.xml</code>
]]></description>
diff --git a/src/site/markdown/getting-started.md b/src/site/markdown/getting-started.md
index d9ecc7d..c134535 100644
--- a/src/site/markdown/getting-started.md
+++ b/src/site/markdown/getting-started.md
@@ -19,12 +19,12 @@
To on-board incremental Maven you need to complete several steps:
-* Declare caching extension in your project
-* Add cache config in `.mvn` (optional) to customize default behavior
-* Validate build results and iteratively adjust config to properly reflect project specifics
+* Declare caching extension in your project (either in `pom.xml` or `.mvn/extensions.xml`)
+* Add `maven-cache-config.xml` cache config in `.mvn/` (optional) to customize default behavior
+* Validate build results and iteratively, adjust config to properly reflect project specifics
* Setup remote cache (optional)
-### Declaring cache extension
+### Declaring build cache extension
```xml
<extension>
@@ -34,11 +34,13 @@ To on-board incremental Maven you need to complete several steps:
</extension>
```
-### Adding cache config
+either in `pom.xml`'s `<project>/<build>/<extensions>` or in `.mvn/extensions.xml`'s `<extensions>`
-Copy [default config `maven-build-cache-config.xml`](../resources/maven-build-cache-config.xml)
+### Adding build cache config
+
+Copy [default config `maven-cache-config.xml`](../resources/maven-cache-config.xml)
to [`.mvn/`](https://maven.apache.org/configure.html) directory of your project.
-To get overall understanding of cache machinery it is recommended to review the config and read comments. In typical
+To get overall understanding of cache machinery, it is recommended to review the config and read comments. In typical
scenario you need to adjust:
* Exclusions for unstable, temporary files or environment specific files
@@ -47,7 +49,7 @@ scenario you need to adjust:
there might be edge cases.
* remote cache location (if remote cache is used)
-### Adjusting cache config
+### Adjusting build cache config
Having extension run usual command, like `mvn package`. Verify the caching engine is activated:
@@ -66,4 +68,4 @@ checks could reduce both performance and cache efficiency (hit rate).
To leverage remote cache feature there should a shared storage provide. Any technology supported
by [Maven Wagon](https://maven.apache.org/wagon/) will suffice. In simplest form it could be a http web server which
supports get/put operations ([Nginx OSS](http://nginx.org/en/) with fs module or any other equivalent).
-See [Remote cache setup](remote-cache.md) for detailed description of cache setup
+See [Remote cache setup](remote-cache.md) for detailed description of cache setup.
diff --git a/src/site/resources/maven-build-cache-config.xml b/src/site/resources/maven-cache-config.xml
similarity index 99%
rename from src/site/resources/maven-build-cache-config.xml
rename to src/site/resources/maven-cache-config.xml
index 7485dde..ae82b95 100644
--- a/src/site/resources/maven-build-cache-config.xml
+++ b/src/site/resources/maven-cache-config.xml
@@ -19,7 +19,7 @@
xsi:schemaLocation="http://maven.apache.org/CACHE-CONFIG/1.0.0 target/generated-resources/modello/build-cache-config-1.0.0.xsd">
<!--
- Template cache configuration
+ Template Maven build cache configuration
-->
<configuration>
diff --git a/src/site/site.xml b/src/site/site.xml
index c616620..1ca0081 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -48,13 +48,13 @@ under the License.
</menu>
<menu name="Reference">
- <item name="maven-build-cache-config.xml" href="cache-config.html"/>
+ <item name="maven-cache-config.xml" href="build-cache-config.html"/>
</menu>
<menu name="Cache Internals">
- <item name="buildinfo.xml" href="cache-build.html"/>
- <item name="diff-*.xml" href="cache-diff.html"/>
- <item name="cache-report.xml" href="cache-report.html"/>
+ <item name="buildinfo.xml" href="build-cache-build.html"/>
+ <item name="diff-*.xml" href="build-cache-diff.html"/>
+ <item name="cache-report.xml" href="build-cache-report.html"/>
</menu>
<menu ref="parent"/>