diff --git a/src/main/mdo/build-cache-config.mdo b/src/main/mdo/build-cache-config.mdo index ecb15e63..399c820e 100644 --- a/src/main/mdo/build-cache-config.mdo +++ b/src/main/mdo/build-cache-config.mdo @@ -160,8 +160,8 @@ under the License. 0.0.0+ - FileHash (causes file hash is saved in build metadata) or - EffectivePom (causes effective pom info is saved in build metadata) + FileHash (causes file hash to be saved in build metadata) or + EffectivePom (causes effective pom info to be saved in build metadata) @@ -238,8 +238,8 @@ under the License. String * - FileHash (causes file hash is saved in build metadata) or - EffectivePom (causes effective pom info is saved in build metadata) + FileHash (causes file hash to be saved in build metadata) or + EffectivePom (causes effective pom info to be saved in build metadata) @@ -394,7 +394,7 @@ under the License.
  • <dirName>classes</dirName> : files in ${project.basedir}/target/classes
  • <dirName glob="jacoco.xml"></dirName> : jacoco report files in ${project.basedir}/target
  • -
  • <dirName>../src/main/javagen</dirName> : files in ${project.basedir}/src/main/javagen (in this exemple, javagen is a folder saved in git but erased on clean)
  • +
  • <dirName>../src/main/javagen</dirName> : files in ${project.basedir}/src/main/javagen (in this example, javagen is a folder saved in git but erased on clean)


@@ -919,7 +919,7 @@ under the License. Include - file or a directory path to add to checksum computation. Relative path are relative to each module basedir.

+ A file or a directory path to add to checksum computation. Relative paths are relative to each module basedir.

Include elements can also be added per project with the use of maven properties.

]]>
@@ -1305,7 +1305,7 @@ under the License. - Executions ids list with plugin identifier + Execution ids list with plugin identifier @@ -1325,7 +1325,7 @@ under the License. String * - Executions ids list with plugin identifier + Execution ids list with plugin identifier
diff --git a/src/site/markdown/getting-started.md.vm b/src/site/markdown/getting-started.md.vm index 5c44cbf7..8e7d3df6 100644 --- a/src/site/markdown/getting-started.md.vm +++ b/src/site/markdown/getting-started.md.vm @@ -28,7 +28,6 @@ To onboard the build-cache extension you need to complete several steps: #[[###]]# Declaring build cache extension ```xml - org.apache.maven.extensions maven-build-cache-extension diff --git a/src/site/markdown/performance.md b/src/site/markdown/performance.md index f5fbd643..ffd9ce41 100644 --- a/src/site/markdown/performance.md +++ b/src/site/markdown/performance.md @@ -23,7 +23,7 @@ Cache tuning could significantly reduce resource consumption and build execution ### Hash algorithm selection -By default, the cache uses the [XX](https://cyan4973.github.io/xxHash/) algorithm, which is a very fast hash algorithm and should be enough for most use cases. +By default, the cache uses the [XX](https://cyan4973.github.io/xxHash/) algorithm, which is a very fast hash algorithm and should be enough for most use cases. In projects with a large codebase, the performance of hash algorithms becomes more critical, and other algorithms like XXMM (XX with memory-mapped files) could provide better performance, depending on the environment. @@ -31,7 +31,7 @@ XXMM (XX with memory-mapped files) could provide better performance, depending o XX ``` -Also note that the usage of the XXMM or METRO+MM algorithms require the creation of a file `.mvn/jvm.config` in the +Also note that the usage of the XXMM or METRO+MM algorithms require the creation of a file `.mvn/jvm.config` in the top directory with the following line to run successfully on JDK >= 17. ``` --add-opens java.base/sun.nio.ch=ALL-UNNAMED @@ -83,7 +83,7 @@ The cache could be configured to auto-correct metadata (most notably [MANIFEST.M ... - + ... ...