Modified: maven/website/content/docs/3.5.0/release-notes.html ============================================================================== --- maven/website/content/docs/3.5.0/release-notes.html (original) +++ maven/website/content/docs/3.5.0/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.5.0</h1> @@ -253,7 +256,7 @@ <li><a href="https://issues.apache.org/jira/browse/MNG-5962"; class="externalLink">MNG-5962</a> - <code>mvn.cmd</code> fails when the current directory has spaces in between</li> <li><a href="https://issues.apache.org/jira/browse/MNG-5963"; class="externalLink">MNG-5963</a> - <code>mvn.cmd</code> does not return ERROR_CODE</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6022"; class="externalLink">MNG-6022</a> - <code>mvn.cmd</code> fails if directory contains an ampersand (<code>&</code>)</li> -<li>[MNG-6053][] - Unsafe System Properties copy in <code>MavenRepositorySystemUtils</code>, causing NPEs</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6053"; class="externalLink">MNG-6053</a> - Unsafe System Properties copy in <code>MavenRepositorySystemUtils</code>, causing NPEs</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6057"; class="externalLink">MNG-6057</a> - Problem with CI friendly usage of `${..} reactor order is changed</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6090"; class="externalLink">MNG-6090</a> - CI friendly properties break submodule builds</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6105"; class="externalLink">MNG-6105</a> - <code>properties.internal.SystemProperties.addSystemProperties()</code> is not really thread-safe</li> @@ -312,12 +315,12 @@ <li><a href="https://issues.apache.org/jira/browse/MNG-6145"; class="externalLink">MNG-6145</a> - Remove non-existent m2 include in <code>component.xml</code></li> <li><a href="https://issues.apache.org/jira/browse/MNG-6146"; class="externalLink">MNG-6146</a> - Several small stylistic and spelling improvements to code and documentation</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6147"; class="externalLink">MNG-6147</a> - `MetadataResolutionResult#getGraph()`` contains duplicate if clause</li> -<li>[MNG-6150][] - Javadoc improvements for 3.5.0</li> -<li>[MNG-6163][] - Introduce <code>CLASSWORLDS_JAR</code> in shell startup scripts</li> -<li>[MNG-6165][] - Deprecate and replace incorrectly spelled public API</li> -<li>[MNG-6179][] - Remove unused prerequisites</li> -<li>[MNG-6185][] - Replace doclettag explanation with annotations in AbstractMojo javadoc</li> -<li>[MNG-6189][] - WARN if maven-site-plugin configuration contains <code>reportPlugins</code> element</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6150"; class="externalLink">MNG-6150</a> - Javadoc improvements for 3.5.0</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6163"; class="externalLink">MNG-6163</a> - Introduce <code>CLASSWORLDS_JAR</code> in shell startup scripts</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6165"; class="externalLink">MNG-6165</a> - Deprecate and replace incorrectly spelled public API</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6179"; class="externalLink">MNG-6179</a> - Remove unused prerequisites</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6185"; class="externalLink">MNG-6185</a> - Replace doclettag explanation with annotations in AbstractMojo javadoc</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6189"; class="externalLink">MNG-6189</a> - WARN if maven-site-plugin configuration contains <code>reportPlugins</code> element</li> </ul></section><section> <h3>New Features</h3> <ul> @@ -325,25 +328,25 @@ <li><a href="https://issues.apache.org/jira/browse/MNG-3507"; class="externalLink">MNG-3507</a> - ANSI color logging for improved output visibility</li> <li><a href="https://issues.apache.org/jira/browse/MNG-5878"; class="externalLink">MNG-5878</a> - add support for module name != <code>artifactId</code> in every calculated URLs (project, SCM, site): special <code>project.directory</code> property</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6093"; class="externalLink">MNG-6093</a> - create a <code>slf4j-simple</code> provider extension that supports level color rendering</li> -<li>[MNG-6182][] - ModelResolver interface enhancement: addition of <code>resolveModel(Dependency)</code> supporting version ranges</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6182"; class="externalLink">MNG-6182</a> - ModelResolver interface enhancement: addition of <code>resolveModel(Dependency)</code> supporting version ranges</li> </ul></section><section> <h3>Tasks</h3> <ul> -<li>[MNG-5954][] - Remove outdated <code>maven-embedder/src/main/resources/META-INF/MANIFEST.MF</code></li> -<li>[MNG-6106][] - Remove <code>maven.home</code> default value setter from <code>m2.conf</code></li> -<li>[MNG-6136][] - Upgrade Maven Wagon from 2.10 to 2.12</li> -<li>[MNG-6137][] - Clean up duplicate dependencies caused by incomplete Wagon HTTP Provider exclusions</li> -<li>[MNG-6138][] - Remove obsolete <code>message_*.properties</code> from maven-core</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-5954"; class="externalLink">MNG-5954</a> - Remove outdated <code>maven-embedder/src/main/resources/META-INF/MANIFEST.MF</code></li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6106"; class="externalLink">MNG-6106</a> - Remove <code>maven.home</code> default value setter from <code>m2.conf</code></li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6136"; class="externalLink">MNG-6136</a> - Upgrade Maven Wagon from 2.10 to 2.12</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6137"; class="externalLink">MNG-6137</a> - Clean up duplicate dependencies caused by incomplete Wagon HTTP Provider exclusions</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6138"; class="externalLink">MNG-6138</a> - Remove obsolete <code>message_*.properties</code> from maven-core</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6140"; class="externalLink">MNG-6140</a> - update documentation's dependency graph with <code>resolver</code> + <code>resolver-provider</code> + <code>slf4j-provider</code></li> -<li>[MNG-6151][] - Force Push master from <code>737de43e392fc15a0ce366db98d70aa18b3f6c03</code></li> -<li>[MNG-6152][] - Add a <code>Jenkinsfile</code> so that builds.apache.org can use multibranch pipeline</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6151"; class="externalLink">MNG-6151</a> - Force Push master from <code>737de43e392fc15a0ce366db98d70aa18b3f6c03</code></li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6152"; class="externalLink">MNG-6152</a> - Add a <code>Jenkinsfile</code> so that builds.apache.org can use multibranch pipeline</li> </ul></section><section> <h3>Wishes</h3> <ul> -<li>[MNG-2199][] - Support version ranges in parent elements</li> -<li>[MNG-6088][] - after forked execution success, add an empty line</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-2199"; class="externalLink">MNG-2199</a> - Support version ranges in parent elements</li> +<li><a href="https://issues.apache.org/jira/browse/MNG-6088"; class="externalLink">MNG-6088</a> - after forked execution success, add an empty line</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6092"; class="externalLink">MNG-6092</a> - warn if <code>prerequisites.maven</code> is used for non-plugin projects</li> </ul></section></section><section> <h2>Complete Release Notes</h2>
Modified: maven/website/content/docs/3.5.2/release-notes.html ============================================================================== --- maven/website/content/docs/3.5.2/release-notes.html (original) +++ maven/website/content/docs/3.5.2/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.5.2</h1> Modified: maven/website/content/docs/3.5.3/release-notes.html ============================================================================== --- maven/website/content/docs/3.5.3/release-notes.html (original) +++ maven/website/content/docs/3.5.3/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.5.3</h1> @@ -240,7 +243,7 @@ <li> <p>If you have used the deprecated version markers like <code>RELEASE</code> or <code>LATEST</code> this will now produce a WARNING during the build <a href="https://issues.apache.org/jira/browse/MNG-6342"; class="externalLink">MNG-6342</a>.</p></li> </ul></section><section> -<h2><a href="#details">The detailed issue list</a></h2> +<h2><a href="#Details">The detailed issue list</a></h2> <p>Bugs:</p> <ul> Modified: maven/website/content/docs/3.5.4/release-notes.html ============================================================================== --- maven/website/content/docs/3.5.4/release-notes.html (original) +++ maven/website/content/docs/3.5.4/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.5.4</h1> @@ -186,7 +189,7 @@ <li>The Maven Super POM changes the default execution of the <code>maven-source-plugin</code> <code>jar</code> goal into <code>jar-no-fork</code> which should resolve some issues complex projects had running releases.</li> </ul></section><section> -<h2><a href="#details">The detailed issue list</a></h2><section> +<h2><a href="#Details">The detailed issue list</a></h2><section> <h3>Bugs</h3> <ul> Modified: maven/website/content/docs/3.6.0/release-notes.html ============================================================================== --- maven/website/content/docs/3.6.0/release-notes.html (original) +++ maven/website/content/docs/3.6.0/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.6.0</h1> @@ -155,7 +158,7 @@ <h2>Reporters and Contributors of this release</h2> <p>We really value the contributions of these non committers, so this section is focused on those individuals. Descriptions of the issues fixed can be found at -the <a href="#details">end of these release notes</a>.</p> +the <a href="#Details">end of these release notes</a>.</p> <p>Code Contributors of this release:</p> <ul> @@ -248,8 +251,8 @@ versions each line will contain the appr <li>There was an issue related to the classpath ordering <a href="https://issues.apache.org/jira/browse/MNG-6415"; class="externalLink">MNG-6415</a> in Maven which can cause issues which has been fixed.</li> </ul></section><section> -<h2><a href="#details">The detailed issue list</a></h2><section> -<h3>Bugs</h3> +<h2><a href="#Details">The detailed issue list</a></h2><section> +<h3>Bugs:</h3> <ul> <li><a href="https://issues.apache.org/jira/browse/MNG-6311"; class="externalLink">MNG-6311</a> - Maven intolerably slow when import scope used heavily in large project</li> @@ -260,7 +263,7 @@ can cause issues which has been fixed.</ <li><a href="https://issues.apache.org/jira/browse/MNG-6472"; class="externalLink">MNG-6472</a> - Mockito cannot mock this class: interface org.eclipse.aether.impl.RepositoryEventDispatcher</li> <li><a href="https://issues.apache.org/jira/browse/MNG-6490"; class="externalLink">MNG-6490</a> - Maven shall not fail reporting circular dependency when the dependency is a classified secondary artifact</li> </ul></section><section> -<h3>Improvements</h3> +<h3>Improvements:</h3> <ul> <li><a href="https://issues.apache.org/jira/browse/MNG-4508"; class="externalLink">MNG-4508</a> - No way to avoid adding artifactId to site urls</li> Modified: maven/website/content/docs/3.6.1/release-notes.html ============================================================================== --- maven/website/content/docs/3.6.1/release-notes.html (original) +++ maven/website/content/docs/3.6.1/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.6.1</h1> @@ -155,7 +158,7 @@ <h2>Reporters and Contributors of this release</h2> <p>We really value the contributions of these non committers, so this section is focused on those individuals. Descriptions of the issues fixed can be found at -the <a href="#details">end of these release notes</a>.</p> +the <a href="#Details">end of these release notes</a>.</p> <p>Issue Reporters of this release:</p> <ul> @@ -282,7 +285,7 @@ URL's etc. within <code>project</code>, builds like this:</li> </ul> -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project child.project.url.inherit.append.path="false"> +<div class="source"><pre class="prettyprint linenums"><code><project child.project.url.inherit.append.path="false"> <url>...</url> <scm child.scm.connection.inherit.append.path="false" @@ -301,8 +304,8 @@ builds like this:</li> </project> </code></pre></div> <p>Detailed explanations can be found in <a href="https://maven.apache.org/ref/3.6.1/maven-model-builder/index.html#Inheritance_Assembly"; class="externalLink">Inheritance Assembly</a> and in <a href="http://issues.apache.org/jira/browse/MNG-6059"; class="externalLink">MNG-6059</a></p></section><section> -<h2>The detailed issue list<a href="#details"></a></h2><section> -<h3>Bugs</h3> +<h2>The detailed issue list<a href="#Details"></a></h2><section> +<h3>Bugs:</h3> <ul> <li><a href="http://issues.apache.org/jira/browse/MNG-5705"; class="externalLink">MNG-5705</a> - NPE on parallel build in BuilderCommon.handleBuildError(BuilderCommon.java:147)</li> Modified: maven/website/content/docs/3.6.2/release-notes.html ============================================================================== --- maven/website/content/docs/3.6.2/release-notes.html (original) +++ maven/website/content/docs/3.6.2/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <section> <h1>Release Notes – Maven 3.6.2</h1> @@ -155,7 +158,7 @@ <h2>Reporters and Contributors of this release</h2> <p>We really value the contributions of these non committers, so this section is focused on those individuals. Descriptions of the issues fixed can be found at -the <a href="#details">end of these release notes</a>.</p> +the <a href="#Details">end of these release notes</a>.</p> <p>Issue Reporters of this release: Benoit GUERIN, Christian Schulte, Elliotte Rusty Harold, Falko Modler, Francesco Chicchiriccò, Guillaume Nodet, guofei, Joseph Walton, Louis Mills, Mark Derricutt, Mark McKelvy, Mickael Istria, Nicolas Echegut, Nicolas Radde, Raphael Rösch, Ray Tsang, Robert Thornton, Rohan Padhye, Sergey Chernov, Stefan Oehme, Thibaud Lepretre, zhb.</p> <p>Code Contributors of this release: Guillaume Nodet, Mickael Istria, Ray Tsang, Stefan Oehme, Joseph Walton, Bo Zhang, AElMehdi, Christian Schulte, Mao Shuai, MartinKanters, Sergey Chernov, Jesse Glick.</p> <p>Many thanks to all reporters and contributors for their time and support.</p> @@ -172,7 +175,7 @@ the <a href="#details">end of these rele <li> <p>The toolchain.xml file supports environment variables (see <a href="https://issues.apache.org/jira/browse/MNG-6665"; class="externalLink">MNG-6665</a>).</p></li> </ul></section><section> -<h2>The detailed issue list<a href="#details"></a></h2> +<h2>The detailed issue list<a href="#Details"></a></h2> <p>Sub-task</p> <div class="source"><pre class="prettyprint linenums"><code>[MNG-6680] - Convert Maven Settings Builder to JSR 330 Modified: maven/website/content/docs/3.6.3/release-notes.html ============================================================================== --- maven/website/content/docs/3.6.3/release-notes.html (original) +++ maven/website/content/docs/3.6.3/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.6.3</h1> @@ -155,7 +158,7 @@ <h2>Reporters and Contributors of this release</h2> <p>We really value the contributions of these non committers, so this section is focused on those individuals. Descriptions of the issues fixed can be found at -the <a href="#details">end of these release notes</a>.</p> +the <a href="#Details">end of these release notes</a>.</p> <p>Issue Reporters of this release: Jonathan Chen, Charles Oliver Nutter, Lucas Ludueño, Stig Rohde Døssing, Vladimir Sitnikov</p> <p>Contributors of this release: Stuart McCulloch, Mickael Istria, Peter Lynch, Christian Wansart, Dezhi Cai, Anatoly Zaretsky, Stig Rohde Døssing</p> <p>Many thanks to all reporters and contributors for their time and support.</p> @@ -176,7 +179,7 @@ the <a href="#details">end of these rele <p>you'll get bit-by-bit identical output (<code>apache-maven-3.6.3-bin.zip</code> and <code>.tar.gz</code> in <code>apache-maven/target/</code>) that you can check with sha512 fingerprints against official release.<br /> If you're building on any Unix system, you'll need to add “<code>-Dline.separator=$'\r\n'</code>”.<br /> See the <a href="/guides/mini/guide-reproducible-builds.html">Maven - Guide to Configuring for Reproducible Builds</a> for more details.</p></section><section> -<h2>The detailed issue list<a href="#details"></a></h2> +<h2>The detailed issue list<a href="#Details"></a></h2> <p>Sub-task</p> <div class="source"><pre class="prettyprint linenums"><code>[MNG-6779] - fix jcl-over-slf4j license: Apache 2.0 instead of MIT Modified: maven/website/content/docs/3.8.1/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.1/release-notes.html (original) +++ maven/website/content/docs/3.8.1/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.1</h1> @@ -215,7 +218,7 @@ With Maven we burn versions, to ensure w <li> <p>keep the dependency version but <a href="/guides/mini/guide-mirror-settings.html">define a mirror in your settings</a>.</p></li> </ul></section><section> -<h2>The detailed issue list<a href="#details"></a></h2> +<h2>The detailed issue list<a href="#Details"></a></h2> <p>Bug</p> <div class="source"><pre class="prettyprint linenums"><code>[MNG-7128] - improve error message when blocked repository defined in build POM Modified: maven/website/content/docs/3.8.2/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.2/release-notes.html (original) +++ maven/website/content/docs/3.8.2/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.2</h1> Modified: maven/website/content/docs/3.8.3/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.3/release-notes.html (original) +++ maven/website/content/docs/3.8.3/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.3</h1> Modified: maven/website/content/docs/3.8.4/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.4/release-notes.html (original) +++ maven/website/content/docs/3.8.4/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.4</h1> Modified: maven/website/content/docs/3.8.5/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.5/release-notes.html (original) +++ maven/website/content/docs/3.8.5/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.5</h1> Modified: maven/website/content/docs/3.8.6/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.6/release-notes.html (original) +++ maven/website/content/docs/3.8.6/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.6</h1> Modified: maven/website/content/docs/3.8.7/release-notes.html ============================================================================== --- maven/website/content/docs/3.8.7/release-notes.html (original) +++ maven/website/content/docs/3.8.7/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.8.7</h1> Modified: maven/website/content/docs/3.9.0/release-notes.html ============================================================================== --- maven/website/content/docs/3.9.0/release-notes.html (original) +++ maven/website/content/docs/3.9.0/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 3.9.0</h1> Modified: maven/website/content/docs/4.0.0-alpha-2/release-notes.html ============================================================================== --- maven/website/content/docs/4.0.0-alpha-2/release-notes.html (original) +++ maven/website/content/docs/4.0.0-alpha-2/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 4.0.0-alpha-2</h1> Modified: maven/website/content/docs/4.0.0-alpha-3/release-notes.html ============================================================================== --- maven/website/content/docs/4.0.0-alpha-3/release-notes.html (original) +++ maven/website/content/docs/4.0.0-alpha-3/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 4.0.0-alpha-3</h1> Modified: maven/website/content/docs/4.0.0-alpha-4/release-notes.html ============================================================================== --- maven/website/content/docs/4.0.0-alpha-4/release-notes.html (original) +++ maven/website/content/docs/4.0.0-alpha-4/release-notes.html Sat Feb 18 20:40:58 2023 @@ -138,6 +138,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/modules/index.html#Markdown --> <section> <h1>Release Notes – Maven 4.0.0-alpha-4</h1> Modified: maven/website/content/docs/history.html ============================================================================== --- maven/website/content/docs/history.html (original) +++ maven/website/content/docs/history.html Sat Feb 18 20:40:58 2023 @@ -139,6 +139,9 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + NOTE: For help with the syntax of this file, see: + http://maven.apache.org/doxia/references/apt-format.html --> <p>Date format is: YYYY-MM-DD</p> Modified: maven/website/content/examples/index.html ============================================================================== --- maven/website/content/examples/index.html (original) +++ maven/website/content/examples/index.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/examples/index.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/examples/index.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Summary of Maven Examples <a href="https://github.com/apache/maven-site/tree/master/content/markdown/examples/index.md";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Summary of Maven Examples <a href="https://github.com/apache/maven-site/tree/master/content/apt/examples/index.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,33 +123,11 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Examples</h2> +<section> +<h1>Examples</h1> <ul> - -<li> -<p><a href="./injecting-properties-via-settings.html">Injecting POM Properties via settings.xml</a></p></li> -<li> -<p><a href="./maven-3-lifecycle-extensions.html">Maven 3 lifecycle extensions</a></p></li> -</ul></section></section> +<li><a href="./injecting-properties-via-settings.html">Injecting POM Properties via settings.xml</a></li> +<li><a href="./maven-3-lifecycle-extensions.html">Maven 3 lifecycle extensions</a></li></ul></section> </main> </div> </div> Modified: maven/website/content/examples/injecting-properties-via-settings.html ============================================================================== --- maven/website/content/examples/injecting-properties-via-settings.html (original) +++ maven/website/content/examples/injecting-properties-via-settings.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/examples/injecting-properties-via-settings.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/examples/injecting-properties-via-settings.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Example: Injecting POM Properties via Settings.xml <a href="https://github.com/apache/maven-site/tree/master/content/markdown/examples/injecting-properties-via-settings.md";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Example: Injecting POM Properties via Settings.xml <a href="https://github.com/apache/maven-site/tree/master/content/apt/examples/injecting-properties-via-settings.apt";><img src="../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,31 +123,12 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Example: Injecting POM Properties via Settings.xml</h2><section> -<h3>Impetus</h3> +<section> +<h1>Example: Injecting POM Properties via Settings.xml</h1><section> +<h2>Impetus</h2> <p>You have a plugin parameter that should contain a user-specific value. This parameter has a common format (relative directory structure), but depends on knowing the directory of the installed application or something.</p></section><section> -<h3>Plugin Configuration</h3> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<h2>Plugin Configuration</h2> +<div class="source"><pre class="prettyprint linenums"><project> [...] <build> <plugins> @@ -160,11 +141,9 @@ under the License. </configuration> </plugin> </plugins> - </build> -</code></pre></div></section><section> -<h3><code>settings.xml</code></h3> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><settings> + </build></pre></div></section><section> +<h2><code>settings.xml</code></h2> +<div class="source"><pre class="prettyprint linenums"><settings> [...] <profiles> <profile> @@ -178,10 +157,9 @@ under the License. <activeProfiles> <activeProfile>inject-application-home</activeProfile> </activeProfiles> -</settings> -</code></pre></div></section><section> -<h3>Explanation</h3> -<p>When Maven loads the project's POM, it will pickup the activated profiles from the <code>activeProfiles</code> section of the <code>settings.xml</code> file, and inject the properties declared within the profile. When the POM is interpolated, the <code>application-home</code> property will already have been injected, so will allow the plugin's parameter value to be resolved.</p></section></section></section> +</settings></pre></div></section><section> +<h2>Explanation</h2> +<p>When Maven loads the project's POM, it will pickup the activated profiles from the <code>activeProfiles</code> section of the <code>settings.xml</code> file, and inject the properties declared within the profile. When the POM is interpolated, the <code>application-home</code> property will already have been injected, so will allow the plugin's parameter value to be resolved.</p></section></section> </main> </div> </div> Modified: maven/website/content/faq-unoffical.html ============================================================================== --- maven/website/content/faq-unoffical.html (original) +++ maven/website/content/faq-unoffical.html Sat Feb 18 20:40:58 2023 @@ -156,7 +156,7 @@ under the License. [How do I add a description to the welcome page of the generated site when I execute mvn site?](#How do I add a description to the welcome page of the generated site when I execute mvn site?] [Which part in pom.xml the javadoc plugin should be configured?](#Which part in pom.xml the javadoc plugin should be configured?]</p></section><section> <h3>Eclipse</h3> -<p>[How do I specify which output directories the Eclipse plugin puts into the .classpath file?](#How do I specify which output directories the Eclipse plugin puts into the .classpath file?] +<p>[How do I specify which output folders the Eclipse plugin puts into the .classpath file?](#How do I specify which output folders the Eclipse plugin puts into the .classpath file?] [Where can I get the Maven plugin for Eclipse?](#Where can I get the Maven plugin for Eclipse?] [I issued- mvn -Declipse.downloadSources=true eclipse eclipse goal. It created .classpath and .project for both modules, and in my local repository it downloaded sources Ho do I access them in eclipse?](#I issued- mvn -Declipse.downloadSources=true eclipse eclipse goal. It created .classpath and .project for both modules, and in my local repository it downloaded sources Ho do I access them in eclipse?] [Is it possible that if I do mvn eclipse eclipse goal that my project would get disconnected from the subversion repository?](#Is it possible that if I do mvn eclipse eclipse goal that my project would get disconnected from the subversion repository?] @@ -308,7 +308,7 @@ under the License. <p>So, to recap:</p> <p>parent:</p> -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><configuration> +<div class="source"><pre class="prettyprint linenums"><code><configuration> <items> <item>one</item> <item>two</item> @@ -521,7 +521,7 @@ plugins will be available soon, currentl <p><a href="http://maven.apache.org/guides/mini/guide-mirror-settings.html"; class="externalLink">Guide mirror settings</a></p> <p><em>Repositories, General</em></p></section><section> <h3>How do I get a list of archetypes?</h3> -<p>To get a list of archetypes, refer to the following page [<a href="http://svn.apache.org/viewcvs.cgi/maven/archetype/trunk/maven-archetypes)" class="externalLink">http://svn.apache.org/viewcvs.cgi/maven/archetype/trunk/maven-archetypes)</a></p></section><section> +<p>To get a list of archetypes, refer to the following page [<a href="http://svn.apache.org/viewcvs.cgi/maven/archetype/trunk/maven-archetypes"; class="externalLink">http://svn.apache.org/viewcvs.cgi/maven/archetype/trunk/maven-archetypes</a>)</p></section><section> <h3>How do I specify my remote repo in Maven?</h3> <p>To specify a remote repo in Maven, add the <code><repositories></code> element to the POM:</p> @@ -533,9 +533,9 @@ plugins will be available soon, currentl </repository> </repositories> </code></pre></div> -<p>Or, refer to the following page [<a href="http://maven.apache.org/guides/mini/guide-multiple-repositories.html)" class="externalLink">http://maven.apache.org/guides/mini/guide-multiple-repositories.html)</a> +<p>Or, refer to the following page [<a href="http://maven.apache.org/guides/mini/guide-multiple-repositories.html"; class="externalLink">http://maven.apache.org/guides/mini/guide-multiple-repositories.html</a>) <em>Repositories</em></p></section><section> -<h3>How do I specify which output directories the Eclipse plugin puts into the .classpath file?</h3> +<h3>How do I specify which output folders the Eclipse plugin puts into the .classpath file?</h3> <div class="source"><pre class="prettyprint linenums"><code><build> ... @@ -616,7 +616,7 @@ plugins will be available soon, currentl <ul> <li>Put your static pages in the resources directory, ${basedir}/src/site/resources.</li> -<li>Create your site.xml and put it in <code>${basedir}/src/site</code>. An example below:</li> +<li>Create your site.xml and put it in ${basedir}/src/site. An example below:</li> </ul> <div class="source"><pre class="prettyprint linenums"><code><project name="Maven War Plugin"> @@ -655,7 +655,7 @@ plugins will be available soon, currentl <p> <em>Sites & Reporting</em></p></section><section> <h3>How do I specify that all web modules will inherit the group's common files from a parent web module?</h3> <p>maven-war-plugin 2.0-beta-3 and later supports merging of wars. Just reference the common WAR project from another WAR project as a dependency of <code><type>war</type></code> and it will automatically be merged.</p> -<p>See [<a href="http://jira.codehaus.org/browse/MWAR-8)" class="externalLink">http://jira.codehaus.org/browse/MWAR-8)</a></p> +<p>See [<a href="http://jira.codehaus.org/browse/MWAR-8"; class="externalLink">http://jira.codehaus.org/browse/MWAR-8</a>)</p> <p><em>Inheritence and Interpolation</em></p></section><section> <h3>How do I determine which POM contains missing transitive dependency?</h3> <p>run <code>mvn -X</code></p> @@ -877,7 +877,7 @@ We will probably try to fix this problem <p>Also see [How do I run a build/package/deploy process without waiting for reports or unit tests, so that I can quickly deploy to an integration box?]</p> <p><em>Sites & Reporting, General</em></p></section><section> <h3>How do I create a command line parameter (i.e., -Dname=value ) in my mojo?</h3> -<p>In your mojo, put <code>expression=${<exp>}</code> in your parameter field</p> +<p>In your mojo, put <code>expression=$\{<exp>\}</code> in your parameter field</p> <div class="source"><pre class="prettyprint linenums"><code>/** * @parameter expression="${expression.name}" @@ -992,7 +992,7 @@ NOTE: this may only work in the latest p <p>Now, to specify a different output directory at runtime simply use the directory property as a mvn command line parameter; {code}mvn -Ddirectory=tmp package</p> -<div class="source"><pre class="prettyprint linenums"><code>This will send the build's output files to the ${basedir}/tmp directory. +<div class="source"><pre class="prettyprint linenums"><code>This will send the build's output files to the $\{basedir}/tmp directory. _POM, Command Line_ @@ -1104,7 +1104,7 @@ e.g. mvn eclipse:help </code></pre></div> <p><em>Plugins and Lifecycle, IDEs</em></p></section><section> <h3>What does aggregator mean in mojo?</h3> -<p>When a Mojo has a <code>@aggregator</code> expression, it means that It can only build the parent project of your multi-module-project, the one who has the packaging of pom. It can also give you values for the expression <code>${reactorProjects}</code> where reactorProjects are the MavenProject references to the parent pom modules.</p></section><section> +<p>When a Mojo has a <code>@aggregator</code> expression, it means that It can only build the parent project of your multi-module-project, the one who has the packaging of pom. It can also give you values for the expression ${reactorProjects} where reactorProjects are the MavenProject references to the parent pom modules.</p></section><section> <h3>Why there are no dependency properties in Maven?</h3> <p>They were removed because they aren't reliable in a transitive environment. It implies that the dependency knows something about the environment of the dependee, which is back to front. In most cases, granted, the value for war bundle will be the same for a particular @@ -1131,7 +1131,7 @@ specified, and allowing the use of artif <p>Absolutely yes!</p> <p>By configuring <code><sourceDirectory></code>, <code><resources></code> and other elements of the <code><build></code> section.</p> <p>In addition, you may need to change the plugin configuration if you are not using plugin defaults for their files/directories.</p></section><section> -<h3>Where is the source code? I couldn't seem to find a link anywhere on the Maven site</h3> +<h3>Where is the source code? I couldn't seem to find a link anywhere on the Maven site.</h3> <p>The source code can be found in subversion: [http://svn.apache.org/repos/asf/maven/components/trunk].</p> <p>For more information, see <a href="http://maven.apache.org/guides/development/guide-building-m2.html"; class="externalLink">Building Maven</a></p></section><section> <h3>Why does Maven compile my test classes but doesn't run them?</h3> @@ -1175,7 +1175,7 @@ Your favorite IDE probably supports XSD <p>(#Dependencies, Design, Patterns & Best Practices)</p></section><section> <h3>Where to find the source code for org.apache.maven.model package?</h3> <p>The source for the model package is generated by modello. From your maven-model source, build it and you should able to see tha java files inside /target/generated-sources directory.</p></section><section> -<h3>List of available Maven mirrors</h3> +<h3>List of available Maven mirrors.</h3> <p>Here is the list of available mirrors you can use, just use one of the following mirror entries in your settings.xml</p> <div class="source"><pre class="prettyprint linenums"><code><settings> @@ -1235,8 +1235,8 @@ In this case the provider needed is ftp, </code></pre></div></section><section> <h3>How can I reference windows or unix environment variables in my POM?</h3> <p>Starting in maven <em>2.0.1</em>, you can reference windows and unix environment variables inside your pom.xml or settings.xml using an expression of the form: -<code>${env.VARNAME}</code> -So, if you wanted to reference your home directory environment variable, you might use: <code>${env.HOME}</code></p></section><section> +<code>$\{env.VARNAME\}</code> +So, if you wanted to reference your home directory environment variable, you might use: <code>$\{env.HOME\}</code></p></section><section> <h3>How do I know which phase a plug-in is associated with?</h3> <p>Open the plugin's Mojo class source code and look for @phase. This tells which phase the plugin is associated.</p></section><section> <h3>Where to get sun.jdk-tools-jar-1.4.0 on MacOSX?</h3> @@ -1295,7 +1295,7 @@ there is already some discussion about t </dependency> </code></pre></div></section><section> <h3>How can I change the default location of the generated jar when I command “mvn package”?</h3> -<p>By default, the location of the generated jar is in <code>${project.build.directory}</code> or in your target directory. +<p>By default, the location of the generated jar is in ${project.build.directory} or in your target directory. We can change this by configuring the outputDirectory of maven-jar-plugin.</p> <div class="source"><pre class="prettyprint linenums"><code><plugin> @@ -1345,7 +1345,7 @@ cell1 ]( cell1 ]( c Wagon wagon; </code></pre></div></section><section> <h3>How do I set the base directory for creating the packages created by assembly?</h3> -<p>The assembly plugin, by default, saves the packages to your project.build.directory from your pom or</p> +<p>The assembly plugin, by default, saves the packages to your project.build.directory folder from your pom or</p> <div class="source"><pre class="prettyprint linenums"><code><project> ... @@ -1403,7 +1403,7 @@ More info about the assembly plugin can <p>The repositories are searched through based in the order they are defined in your pom. The inherited repositories are always searched last. Note: You don't have to define the central repo (i.e. ibiblio).</p></section><section> <h3>Is it possible to exclude a package from the generated jar file?</h3> -<p>You can configure maven-compiler-plugin to exclude your unwanted packages or files to be compiled in the first place. But you will not be able to prevent javac to compile those files if they are referenced by other packages within the source tree. To prevent that, you will need to use antrun plugin ( or write your own custom plugin), bind it to compile phase, and remove unwanted classes in <code>${project.build.directory}/classes</code>. If possible, just move those pacakges/files to another source tree to become another project.</p></section><section> +<p>You can configure maven-compiler-plugin to exclude your unwanted packages or files to be compiled in the first place. But you will not be able to prevent javac to compile those files if they are referenced by other packages within the source tree. To prevent that, you will need to use antrun plugin ( or write your own custom plugin), bind it to compile phase, and remove unwanted classes in ${project.build.directory}/classes. If possible, just move those pacakges/files to another source tree to become another project.</p></section><section> <h3>How should I point a path for Maven to use a certain version of JDK when I have different versions of JDK installed on my PC and my JAVA_HOME already set?</h3> <p>If you don't want to change your system JAVA_HOME, set it in maven script instead.</p></section><section> <h3>Why does release prepare goal requires the project to be released be a snapshot? Is it possible to do a release prepare from a parent project? What about from a sub-project?</h3> @@ -1509,9 +1509,9 @@ I think your choice is probably influenc </code></pre></div></section><section> <h3>How can I stop this “WARNING While downloading artifactId-artifactId-version This artifact has been relocated to groupId-artifactId-version”?</h3> <p>It's probably because some other dependency has specified the dependency on artifactId:artifactId. It will only go away when that declaration is fixed in that POM.</p></section><section> -<h3>I would like clarification on what version of the JDK is required for m2 - particularly with respect to creating Plugins</h3> +<h3>I would like clarification on what version of the JDK is required for m2 - particularly with respect to creating Plugins.</h3> <p>1.4 is required to run m2 there're problems when using 1.5 features in plugins. People tried and failed because qdox (used for some mojo stuff doesn't support new 1.5 language)</p></section><section> -<h3>i'm wondering what a “snapshot” actually is</h3> +<h3>i'm wondering what a “snapshot” actually is.</h3> <p>A snapshot is a development version. e.g, 2.0-SNAPSHOT is thestill-in-development future 2.0.If you want to use a snapshot, just use <code><version></code> , e.g. <code><version>2.0-SNAPSHOT</version></code> . But first you must ensure that you have access to the repository containing this version.</p></section><section> <h3>Is it possible that if I do mvn eclipse eclipse goal that my project would get disconnected from the subversion repository?</h3> <p>1.4 is required to run m2 there're problems when using 1.5 features in plugins. People tried and failed because qdox (used for some mojo stuff doesn't support new 1.5 language)</p></section><section> @@ -1526,7 +1526,7 @@ I think your choice is probably influenc pom.xml > project scope </code></pre></div></section><section> <h3>What is reactorProjects? executedProject?</h3> -<p><code>${reactorProjects}</code> are the projects that the current mvn command are going to be built. This will include the parent project and all its children while <code>${executedProject}</code> is the project where you typed your mvn command.</p></section><section> +<p>${reactorProjects} are the projects that the current mvn command are going to be built. This will include the parent project and all its children while ${executedProject} is the project where you typed your mvn command.</p></section><section> <h3>What is a Snapshot?</h3> <p>A snapshot is a development version. e.g, 2.0-SNAPSHOT is the still-in-development future 2.0. If you want to use a snapshot, juste use <code><version></code> , e.g. <code><version>2.0-SNAPSHOT</version></code>. But first you must ensure that you have access to @@ -1619,7 +1619,7 @@ and A declares the following: <h3>What is the purpose of remote repository (other than ibilbilo)?</h3> <p>To store stuff that is not in ibiblio. An example of this is your own stuff.</p></section><section> <h3>Whenever a file is modified in a maven project how is the SNAPSHOT jar updated in the remote repository?</h3> -<p>Using mvn deploy, after inserting proper <code><distributionManagement></code> section into your POM</p></section><section> +<p>Using mvn deploy, after inserting proper section into your POM</p></section><section> <h3>Is maven ‘deploy’ goal and actually copying of a dependency or artifact jar to remote repository same?</h3> <p>Actually, simply copying the artifact to the repository is not the same as using deploy. The deploy goal will update various metadata files, create the md5 and sha1 checksum files, and can optionally create missing POM files etc along with actually copying the artifact file. So there is a significant difference between the copying the file and using deploy.</p></section><section> Modified: maven/website/content/glossary.html ============================================================================== --- maven/website/content/glossary.html (original) +++ maven/website/content/glossary.html Sat Feb 18 20:40:58 2023 @@ -162,7 +162,7 @@ located in the root directory of each pr <p><strong>Artifact</strong>: An artifact is something that is either produced or used by a project. Examples of artifacts produced by Maven for a project include: JARs, source and binary distributions, WARs. Each -artifact is identified by a <code>group id</code>, an +artifact is identified by a <a href="#GroupId">group id</a>, an artifact ID, a version, an extension and a classifier (extension+classifier may be named by a <a href="/ref/current/maven-core/artifact-handlers.html">type</a>).</p></li> <li> Modified: maven/website/content/guides/development/guide-building-maven.html ============================================================================== --- maven/website/content/guides/development/guide-building-maven.html (original) +++ maven/website/content/guides/development/guide-building-maven.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-building-maven.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-building-maven.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,7 +10,8 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" /> - <meta name="author" content="Brett Porter, Jason van Zyl" /> + <meta name="author" content="Brett Porter +Jason van Zyl" /> <meta name="date" content="2015-01-04" /> <title>Maven – Guide to Building Maven</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> @@ -48,7 +49,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide to Building Maven <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-building-maven.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide to Building Maven <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-building-maven.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -139,65 +140,38 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Building Maven</h2><section> -<h3>Why would I want to build Maven?</h3> +<section> +<h1>Building Maven</h1><section> +<h2>Why would I want to build Maven?</h2> <p>Building Maven (or a plugin, or any component) yourself is for one of two reasons:</p> <ul> - -<li> -<p>to try out a bleeding edge feature or bugfix (issues can be found in <a href="/issue-management.html">JIRA</a>),</p></li> -<li> -<p>to fix a problem you are having and submit a patch to the developers team.</p></li> -</ul></section><section> -<h3>Checking out the sources</h3> +<li>to try out a bleeding edge feature or bugfix (issues can be found in <a href="/issue-management.html"> JIRA</a>),</li> +<li>to fix a problem you are having and submit a patch to the developers team.</li></ul></section><section> +<h2>Checking out the sources</h2> <p>All of the source code for Maven and its related libraries is in managed in the ASF source code repositories: for details, see <a href="/scm.html">https://maven.apache.org/scm.html</a>.</p></section><section> -<h3>Building Maven</h3><section> -<h4>Building a Maven Plugin or Component</h4> +<h2>Building Maven</h2><section> +<h3>Building a Maven Plugin or Component</h3> <p>Building a Maven plugin or component is like any Maven build:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn install -</code></pre></div><section> -<h5>Running Integration Tests</h5> +<div> +<pre>mvn install</pre></div><section> +<h4>Running Integration Tests</h4> <p>Before submitting a patch, it is advised to run the integration tests, which are available in the <code>run-its</code> profile:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn -Prun-its install -</code></pre></div></section></section><section> -<h4>Building Maven core</h4> +<div> +<pre>mvn -Prun-its install</pre></div></section></section><section> +<h3>Building Maven core</h3> <p>Until Maven 3.3, Maven core build could be boostrapped with an Ant build. This bootstrap has been removed in Maven 3.5: you need a pre-built Maven to build Maven from source.</p> <p>To do this, run from the source directory:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn install -</code></pre></div> +<div> +<pre>mvn install</pre></div> <p>The assemblies will be created in <code>apache-maven</code>, and can be manually unzipped to the location where you'd like the resulting Maven installed.</p> <p>If you want to have the resulting Maven directly copied to a directory, you can use the <code>distributionTargetDir</code> property:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn -DdistributionTargetDir="$HOME/app/maven/apache-maven-SNAPSHOT" install -</code></pre></div><section> -<h5>Running the full Maven core integration tests</h5> +<div> +<pre>mvn -DdistributionTargetDir="$HOME/app/maven/apache-maven-SNAPSHOT" install</pre></div><section> +<h4>Running the full Maven core integration tests</h4> <p>Before checking in a change or submitting a patch to Maven core, it is required to run the core integration tests. Using your local build of Maven, run:</p> - -<div class="source"><pre class="prettyprint linenums"><code>mvn test -Prun-its -</code></pre></div> -<p>Consult <a href="/core-its/">Core ITs documentation</a> for more options.</p></section></section></section></section></section> +<div> +<pre>mvn test -Prun-its</pre></div> +<p>Consult <a href="/core-its/">Core ITs documentation</a> for more options.</p></section></section></section></section> </main> </div> </div> Modified: maven/website/content/guides/development/guide-committer-school.html ============================================================================== --- maven/website/content/guides/development/guide-committer-school.html (original) +++ maven/website/content/guides/development/guide-committer-school.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-committer-school.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-committer-school.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -10,8 +10,10 @@ <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M4" /> - <meta name="author" content="Stephen Connolly, Robert Scholte" /> - <meta name="date" content="2012-07-11, 2017-07-21" /> + <meta name="author" content="Stephen Connolly +Robert Scholte" /> + <meta name="date" content="2012-07-11 +2017-07-21" /> <title>Maven – Do you want to become a Maven Committer?</title> <link rel="stylesheet" href="../../css/apache-maven-fluido-1.11.1.min.css" /> <link rel="stylesheet" href="../../css/site.css" /> @@ -48,7 +50,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Do you want to become a Maven Committer? <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-committer-school.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Do you want to become a Maven Committer? <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-committer-school.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -139,92 +141,71 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<!-- Original post: http://javaadventure.blogspot.nl/2012/07/do-you-want-to-become-maven-committer.html --> -<section><section> -<h2>Do you want to become a Maven Committer?</h2> +<section> +<h1>Do you want to become a Maven Committer?</h1> <p>The Apache Software Foundation is a meritocracy. By this we mean that you gain status based on the merit of your work and actions. In fact the status that you gain is a recognition of the merit of your work and actions.</p> <p>Maven is an Apache project, that means that we have to follow the Apache rules and way. One of those rules is that we cannot hand out commit access to anyone who asks for it.</p> <p>To gain commit access you must establish your merit by submitting patches that get picked up by existing committers.</p> <p>After you have contributed enough patches to establish merit, the project management committee decides whether you can be trusted with commit access.</p> -<p><em>The reality is that "It is what it is"TL;DR To become a Maven committer write good patches and get them applied.</em></p></section><section> -<h2>What makes a good patch?</h2> +<p><i>The reality is that "It is what it is"TL;DR To become a Maven committer write good patches and get them applied.</i></p></section><section> +<h1>What makes a good patch?</h1> <p>A good patch is a patch that applies cleanly and includes tests that cover both the positive and negative case and has documentation where relevant.</p> -<p>For example, if you were implementing a patch to fix <a href="http://issues.apache.org/jira/browse/MNG-4612"; class="externalLink">MNG-4612</a> you would first need to write a test case that is failing when trying to encrypt</p> - -<div class="source"><pre class="prettyprint linenums"><code>{DESede}y+qq...== -</code></pre></div> +<p>For example, if you were implementing a patch to fix <a class="externalLink" href="http://issues.apache.org/jira/browse/MNG-4612";>MNG-4612</a> you would first need to write a test case that is failing when trying to encrypt</p> +<div> +<pre>{DESede}y+qq...==</pre></div> <p>and a second test case that is passing when trying to encrypt</p> - -<div class="source"><pre class="prettyprint linenums"><code>password -</code></pre></div> +<div> +<pre>password</pre></div> <p>This is in order to be sure that you have written an effective test case that can pass for good data. Then you implement the fix and all the tests should pass. You then take a Subversion compatible† diff of the source code and attach that to the issue in question.</p> <p>To understand how your patch gets evaluated, here is how I apply patches:</p> -<p>1 I look at the actual diff, if there is a whole lot of formatting changes irrelevant to the issue being fixed => <strong>Patch is no good, ask on JIRA for a clean patch</strong></p> -<p>1 I look at the list of files in the diff, if there are no tests => <strong>Patch is no good, ask on JIRA for test cases</strong></p> -<p>1 I look at the issue and if the issue requires documentation be updated and there is no documentation changes in the patch => <strong>Patch is no good, ask on JIRA for documentation changes in the patch</strong></p> -<p>1 I take a clean checkout of the source that the patch applies to and try to apply the patch… if it does not apply clean => <strong>Patch is no good, ask on JIRA for an updated patch</strong></p> -<p>1 I revert the src/main and run the tests. If the tests all pass, then there are no test cases to catch the bug => <strong>Patch is no good, ask on JIRA for proper tests</strong></p> -<p>1 I revert src and run the tests. If any tests fail, then there is something wrong with the existing code => <strong>If I have time I might try and fix the issue, otherwise I just move on</strong></p> -<p>1 I apply the patch a second time and run the tests. If the tests all pass => <strong>Patch is good, I commit the patch and mark the JIRA as resolved</strong></p> -<p>So there you have it, my guide to writing good patches… now the next step is getting your patches noticed…</p></section><section> -<h2>How to get your patches noticed</h2> +<ol style="list-style-type: decimal"> +<li>I look at the actual diff, if there is a whole lot of formatting changes irrelevant to the issue being fixed => <b>Patch is no good, ask on JIRA for a clean patch</b></li> +<li>I look at the list of files in the diff, if there are no tests => <b>Patch is no good, ask on JIRA for test cases</b></li> +<li>I look at the issue and if the issue requires documentation be updated and there is no documentation changes in the patch => <b>Patch is no good, ask on JIRA for documentation changes in the patch</b></li> +<li>I take a clean checkout of the source that the patch applies to and try to apply the patch... if it does not apply clean => <b>Patch is no good, ask on JIRA for an updated patch</b></li> +<li>I revert the src/main and run the tests. If the tests all pass, then there are no test cases to catch the bug => <b>Patch is no good, ask on JIRA for proper tests</b></li> +<li>I revert src and run the tests. If any tests fail, then there is something wrong with the existing code => <b>If I have time I might try and fix the issue, otherwise I just move on</b></li> +<li>I apply the patch a second time and run the tests. If the tests all pass => <b>Patch is good, I commit the patch and mark the JIRA as resolved</b></li></ol> +<p>So there you have it, my guide to writing good patches... now the next step is getting your patches noticed...</p></section><section> +<h1>How to get your patches noticed</h1> <p>The simplest way to get your patches noticed is to submit them to the JIRA issue that they fix.</p> -<p>Remember that the Maven project is run by volunteers in their spare time, so very often we may not notice your patch for a few days.</p> -<p>If you are certain that your patch is a good patch, and a week has passed with no comments on JIRA, then you should send <em>one and only one</em> email to the <a href="mailto:[email protected]"; class="externalLink">[email protected]</a> mailing list to see if your patch can get noticed.</p> -<p><strong>Note:</strong> you need to be fairly confident that your patch is a good patch, because if you keep on pestering the Maven developers looking to have non-good patches applied, your merit will become negative and people will be less inclined to help you get your patches applied… also this is why you should send one and <em>only one</em> email about your patch on any specific JIRA issue.</p></section><section> -<h2>Stephen, Arnaud & Barrie's school for potential Maven committers</h2> -<p>To help people who are interested in becoming Maven committers fulfill their goals, myself, Arnaud Heritier and Barrie Treloar (along with any other current Maven committers who decide to help) will be running an assignment based class to help people become committers.</p> +<p>Remember that the Maven project is run by volunteers in their spare time, so very often we may not notice your patch for a few days. </p> +<p>If you are certain that your patch is a good patch, and a week has passed with no comments on JIRA, then you should send <i>one and only one</i> email to the <a class="externalLink" href="mailto:[email protected]";>[email protected]</a> mailing list to see if your patch can get noticed.</p> +<p><b>Note:</b> you need to be fairly confident that your patch is a good patch, because if you keep on pestering the Maven developers looking to have non-good patches applied, your merit will become negative and people will be less inclined to help you get your patches applied... also this is why you should send one and <i>only one</i> email about your patch on any specific JIRA issue.</p></section><section> +<h1>Stephen, Arnaud & Barrie's school for potential Maven committers</h1> +<p>To help people who are interested in becoming Maven committers fulfill their goals, myself, Arnaud Heritier and Barrie Treloar (along with any other current Maven committers who decide to help) will be running an assignment based class to help people become committers. </p> <p>To register for the class you need to complete the following steps:</p> -<p>1 Read the <a href="http://www.apache.org/licenses/icla.txt"; class="externalLink">Apache Individual Contributor License Agreement</a>. When you graduate from the class you will be required to sign this in order to become a committer.</p> -<p>1 Subscribe to the <a href="mailto:[email protected]"; class="externalLink">[email protected]</a> mailing list.</p> -<p>1 Send an email to the list with the Subject line: <code>\[Committer School\] I would like to become a committer</code> and the Message body:</p> - -<div class="source"><pre class="prettyprint linenums"><code>I am interested in the following areas: +<ol style="list-style-type: decimal"> +<li>Read the <a class="externalLink" href="http://www.apache.org/licenses/icla.txt";>Apache Individual Contributor License Agreement</a>. When you graduate from the class you will be required to sign this in order to become a committer.</li> +<li>Subscribe to the <a class="externalLink" href="mailto:[email protected]";>[email protected]</a> mailing list.</li> +<li>Send an email to the list with the Subject line: <code>[Committer School] I would like to become a committer</code> and the Message body: +<div> +<pre>I am interested in the following areas: _______, _______ and ______ If anyone knows any issues that I could take a look at I would be very much appreciated -Thanks -</code></pre></div> +Thanks</pre></div></li></ol> <p>Once you have registered your class assignments are basically to find JIRA issues that you want to fix. The issues can be in any part of Maven, but it is best to start with the areas you have the most interest in. Once you have found a JIRA issue that you are interested in fixing, the process will work a little something like this:</p> -<p>1 Make sure that nobody else is working on the issue and that the issue is one that should be fixed by sending an email to the list with a Subject line something like: <code>\[Committer School\] Should I fix MNG-4612?</code> The Message body should be something like:</p> - -<div class="source"><pre class="prettyprint linenums"><code>I have had a look at MNG-4612 and I think this is a real issue because... +<ol style="list-style-type: decimal"> +<li>Make sure that nobody else is working on the issue and that the issue is one that should be fixed by sending an email to the list with a Subject line something like: <code>[Committer School] Should I fix MNG-4612?</code> The Message body should be something like: +<div> +<pre>I have had a look at MNG-4612 and I think this is a real issue because... I think I can fix it like so.... Is that the correct way to go about fixing it and is it a real issue at all -Thanks -</code></pre></div> -<p>1 Wait a couple of days. Arnaud, Barrie and I will do our best to respond quickly to all such emails, but please keep in mind that we are doing this in our spare time.</p> -<p>1 If you get the all clear, develop your patch and upload it to the JIRA, after it is uploaded, send an email to the list with a subject line something like: <code>\[Committer School\] Patch for review: MNG-4612</code> The Message body should be something like:</p> - -<div class="source"><pre class="prettyprint linenums"><code>I have tested that this is a good patch and I would appreciate if a committer could review and apply - -Thanks -</code></pre></div> -<p>Keep in mind that the Committer School is just a way for us to identify people who are committed to developing patches with a view to eventually becoming committers.</p> +Thanks</pre></div></li> +<li>Wait a couple of days. Arnaud, Barrie and I will do our best to respond quickly to all such emails, but please keep in mind that we are doing this in our spare time.</li> +<li>If you get the all clear, develop your patch and upload it to the JIRA, after it is uploaded, send an email to the list with a subject line something like: <code>[Committer School] Patch for review: MNG-4612</code> The Message body should be something like: +<div> +<pre>I have tested that this is a good patch and I would appreciate if a committer could review and apply + +Thanks</pre></div></li></ol> +<p>Keep in mind that the Committer School is just a way for us to identify people who are committed to developing patches with a view to eventually becoming committers. </p> <p>When we have enough evidence that we think we can get you accepted as a committer we will nominate you and hopefully your nomination will be accepted.</p> -<p>Personally, if I see somebody averaging a good patch a week for 2-3 months and being active helping out on the <a href="mailto:[email protected]"; class="externalLink">[email protected]</a> and <a href="mailto:[email protected]"; class="externalLink">[email protected]</a> mailing lists then I think I could make a strong case for such a person being given commit access.</p> -<p>So if you think you have the right stuff and want to become a Maven committer… class enrollment is open!</p></section></section> +<p>Personally, if I see somebody averaging a good patch a week for 2-3 months and being active helping out on the <a class="externalLink" href="mailto:[email protected]";>[email protected]</a> and <a class="externalLink" href="mailto:[email protected]";>[email protected]</a> mailing lists then I think I could make a strong case for such a person being given commit access.</p> +<p>So if you think you have the right stuff and want to become a Maven committer... class enrollment is open!</p></section> </main> </div> </div> Modified: maven/website/content/guides/development/guide-documentation-style.html ============================================================================== --- maven/website/content/guides/development/guide-documentation-style.html (original) +++ maven/website/content/guides/development/guide-documentation-style.html Sat Feb 18 20:40:58 2023 @@ -2,7 +2,7 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/markdown/guides/development/guide-documentation-style.md at 2023-02-18 + | Generated by Apache Maven Doxia Site Renderer 2.0.0-M4 from content/apt/guides/development/guide-documentation-style.apt at 2023-02-18 | Rendered using Apache Maven Fluido Skin 1.11.1 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang=""> @@ -48,7 +48,7 @@ <ul class="breadcrumb"> <li class=""><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> <li class=""><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li class="active ">Guide To Maven Documentation Style <a href="https://github.com/apache/maven-site/tree/master/content/markdown/guides/development/guide-documentation-style.md";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> + <li class="active ">Guide To Maven Documentation Style <a href="https://github.com/apache/maven-site/tree/master/content/apt/guides/development/guide-documentation-style.apt";><img src="../../images/accessories-text-editor.png" title="Edit" /></a></li> <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2023-02-18</li> <li class="pull-right"><span class="divider">|</span> <a href="../../scm.html" title="Get Sources">Get Sources</a></li> @@ -123,63 +123,37 @@ </div> </header> <main id="bodyColumn" class="span10" > -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> -<section><section> -<h2>Guide To Maven Documentation Style</h2><section> -<h3>Where did the style came from?</h3> +<section> +<h1>Guide To Maven Documentation Style</h1><section> +<h2>Where did the style came from?</h2> <p>The documentation style guide was created to make our documentation more consistent and also to apply best practices to the documentation as well. The standard has just been started and will expand over time based on the suggestions made on the Maven dev mailing list. It is a community consensus of how we should write our documentation.</p> <p>Each rule in this guide should come with a motivation as to why it exists. References to external sources are encouraged.</p></section><section> -<h3>Date format</h3> +<h2>Date format</h2> <p>How people format a date varies around the world, sometimes making it hard for people to understand each other. The solution to this problem comes in the form of the ISO-8601 standard.</p> <p>A date in our documentation must follow this standard:</p> -<p><strong>YYYY-MM-DD</strong></p> -<p>where <strong>YYYY</strong> is the year in the Gregorian calendar, <strong>MM</strong> is the month of the year between 01 (January) and 12 (December), and <strong>DD</strong> is the day of the month between 01 and 31.</p> -<p><strong>Note</strong>: All documentation meta-data should respect this convention, for instance for this given APT document:</p> - -<div class="source"><pre class="prettyprint linenums"><code> ------ +<p><b>YYYY-MM-DD</b></p> +<p>where <b>YYYY</b> is the year in the Gregorian calendar, <b>MM</b> is the month of the year between 01 (January) and 12 (December), and <b>DD</b> is the day of the month between 01 and 31.</p> +<p><b>Note</b>: All documentation meta-data should respect this convention, for instance for this given APT document:</p> +<div> +<pre> ------ Guide To Maven Documentation Style ------ Dennis Lundberg ------ 2008-07-03 - ------ -</code></pre></div><section> -<h4>References</h4> + ------</pre></div><section> +<h3>References</h3> <ul> - -<li> -<p><a href="http://www.w3.org/QA/Tips/iso-date"; class="externalLink">W3C Quality Web Tips</a></p></li> -<li> -<p><a href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780"; class="externalLink">ISO-8601</a></p></li> -<li> -<p><a href="http://en.wikipedia.org/wiki/ISO_8601"; class="externalLink">Wikipedia</a></p></li> -</ul><!-- NOTE: Add more rules here. Follow the heading style of the rule above. --> -</section></section><section> -<h3>POM Snippet</h3> +<li><a class="externalLink" href="http://www.w3.org/QA/Tips/iso-date";>W3C Quality Web Tips</a></li> +<li><a class="externalLink" href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780";>ISO-8601</a></li> +<li><a class="externalLink" href="http://en.wikipedia.org/wiki/ISO_8601";>Wikipedia</a></li></ul></section></section><section> +<h2>POM Snippet</h2> <p>A POM file must use 2 spaces for each indentation. Because POM snippets are often used in documentation to show the user how to configure something, it is important that these snippets aren't too wide. If they are too wide, the page is difficult to read on a smaller screen.</p> <p>When you use a snippet of XML from the POM as an example in documentation, make sure that the example is properly indented. A user should be able to copy and paste the example into their own POM without changing the indentation.</p> -<p>Also, you should declare all parent POM elements to improve the comprehension. You could use ellipsis (i.e. …) if you don't want to specify elements.</p><section> -<h4>Example</h4> +<p>Also, you should declare all parent POM elements to improve the comprehension. You could use ellipsis (i.e. ...) if you don't want to specify elements.</p><section> +<h3>Example</h3> <p>The following is an example of how the distribution management of the Maven site is configured.</p> - -<div class="source"><pre class="prettyprint linenums"><code class="language-xml"><project> +<div class="source"><pre class="prettyprint linenums"><project> ... <distributionManagement> <site> @@ -188,22 +162,18 @@ under the License. </site> </distributionManagement> ... -</project> -</code></pre></div> +</project></pre></div> <p>As you can see above the <code><distributionManagement></code> element is indented once (=2 spaces), the <code><site></code> element is indented twice (=4 spaces), and the <code><id></code> is indented three times (=6 spaces).</p></section></section><section> -<h3>Naming Documentation Files</h3> +<h2>Naming Documentation Files</h2> <p>All file names should replace space by a hyphen (-), for instance for this given APT document:</p> - -<div class="source"><pre class="prettyprint linenums"><code> guide-documentation-style.apt -</code></pre></div></section><section> -<h3>Updating Documentation Files</h3> +<div> +<pre> guide-documentation-style.apt</pre></div></section><section> +<h2>Updating Documentation Files</h2> <p>A good practice is to update the date (with the correct date format) when you are updating documentation files.</p></section><section> -<h3>Write Thinking</h3> +<h2>Write Thinking</h2> <p>Here are some pointers about English rules when typing material:</p> <ul> - -<li><a href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style"; class="externalLink">Wikipedia:Manual of Style</a>, specifically <a href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation"; class="externalLink">Punctuation Part</a></li> -</ul></section></section></section> +<li><a class="externalLink" href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style";>Wikipedia:Manual of Style</a>, specifically <a class="externalLink" href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation";>Punctuation Part</a></li></ul></section></section> </main> </div> </div>
