Fix documentation errors (#174)

Fix typos and grammar errors. There are no functional changes.
apache · Aug 19, 2024 · 8069051 · 8069051
1 parent c2e4c0b
commit 8069051
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 12 deletions.
diff --git a/src/main/mdo/build-cache-config.mdo b/src/main/mdo/build-cache-config.mdo
@@ -160,8 +160,8 @@ under the License.
           <xs:element minOccurs="0" name="debugs">
             <xs:annotation>
               <xs:documentation source="version">0.0.0+</xs:documentation>
-              <xs:documentation source="description">FileHash (causes file hash is saved in build metadata) or
-                EffectivePom (causes effective pom info is saved in build metadata)</xs:documentation>
+              <xs:documentation source="description">FileHash (causes file hash to be saved in build metadata) or
+                EffectivePom (causes effective pom info to be saved in build metadata)</xs:documentation>
             </xs:annotation>
             <xs:complexType>
               <xs:sequence>
@@ -238,8 +238,8 @@ under the License.
                         <type>String</type>
                         <multiplicity>*</multiplicity>
                     </association>
-                    <description>FileHash (causes file hash is saved in build metadata) or
-                        EffectivePom (causes effective pom info is saved in build metadata)</description>
+                    <description>FileHash (causes file hash to be saved in build metadata) or
+                        EffectivePom (causes effective pom info to be saved in build metadata)</description>
                 </field>
             </fields>
         </class>
@@ -394,7 +394,7 @@ under the License.
             <ul>
               <li><code>&lt;dirName&gt;classes&lt;/dirName&gt;</code> : files in ${project.basedir}/target/classes</li>
               <li><code>&lt;dirName glob="jacoco.xml"&gt;&lt;/dirName&gt;</code> : jacoco report files in ${project.basedir}/target</li>
-              <li><code>&lt;dirName&gt;../src/main/javagen&lt;/dirName&gt;</code> : files in ${project.basedir}/src/main/javagen (in this exemple, javagen is a folder saved in git but erased on clean) </li>
+              <li><code>&lt;dirName&gt;../src/main/javagen&lt;/dirName&gt;</code> : files in ${project.basedir}/src/main/javagen (in this example, javagen is a folder saved in git but erased on clean) </li>
             </ul>
             <br><br>
 
@@ -919,7 +919,7 @@ under the License.
         </class>
         <class>
             <name>Include</name>
-           <description><![CDATA[A <p>file or a directory path to add to checksum computation. Relative path are relative to each module basedir.</p>
+           <description><![CDATA[<p>A file or a directory path to add to checksum computation. Relative paths are relative to each module basedir.</p>
            <p>Include elements can also be added per project with the use of <a href="parameters.html#project-level-properties">maven properties.</a></p>
            ]]></description>
             <fields>
@@ -1305,7 +1305,7 @@ under the License.
                     <xs:element name="execId" type="xs:string" minOccurs="0" maxOccurs="unbounded">
                         <xs:annotation>
                             <xs:documentation>
-                                Executions ids list with plugin identifier
+                                Execution ids list with plugin identifier
                             </xs:documentation>
                         </xs:annotation>
                     </xs:element>
@@ -1325,7 +1325,7 @@ under the License.
                         <type>String</type>
                         <multiplicity>*</multiplicity>
                     </association>
-                    <description>Executions ids list with plugin identifier</description>
+                    <description>Execution ids list with plugin identifier</description>
                 </field>
             </fields>
         </class>

diff --git 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
-
 <extension>
     <groupId>org.apache.maven.extensions</groupId>
     <artifactId>maven-build-cache-extension</artifactId>

diff --git a/src/site/markdown/performance.md b/src/site/markdown/performance.md
@@ -23,15 +23,15 @@ 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.
 
 ```xml
 <hashAlgorithm>XX</hashAlgorithm>
 ```
 
-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
 <cache>
     <configuration>
         ...
-        <projectVersioning adadjustMetaInf="false"/>
+        <projectVersioning adjustMetaInf="false"/>
         ...
     </configuration>
     ...