You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by sl...@apache.org on 2026/08/06 17:49:52 UTC

(maven-compiler-plugin) 02/02: Port the usage page from APT to Markdown

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

slachiewicz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-compiler-plugin.git

commit 607c57eb697e3a3aff093f06edffcc579129b027
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Thu Aug 6 19:44:54 2026 +0200

    Port the usage page from APT to Markdown
    
    Converted with doxia-converter and then cleaned up by hand:
    
    - <<<code>>> becomes backticks, <<bold>> becomes **bold**, {{{url}text}}
      becomes [text](url)
    - the ASF license header becomes a single block HTML comment
    - the page keeps a Velocity reference, so it stays a .vm. Velocity reads ## as
      a line comment and would silently swallow every ATX heading below level one,
      so subsections use setext underlines and anything deeper is wrapped in
      #[[ ... ]]#
    
    Verified by building the site before and after: the rendered page is
    unchanged apart from <b>/<i> becoming <strong>/<em> and quotes in prose
    picking up the Markdown module's typographic substitution.
---
 src/site/markdown/usage.md.vm | 76 ++++++++++++++++++-------------------------
 1 file changed, 31 insertions(+), 45 deletions(-)

diff --git a/src/site/markdown/usage.md.vm b/src/site/markdown/usage.md.vm
index e038356..1486253 100644
--- a/src/site/markdown/usage.md.vm
+++ b/src/site/markdown/usage.md.vm
@@ -1,60 +1,47 @@
- ------
- Usage
- ------
- Edwin Punzalan
- ------
- 2006-07-05
- ------
+<!--
+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
 
-~~ 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.
+http://www.apache.org/licenses/LICENSE-2.0
 
-~~ NOTE: For help with the syntax of this file, see:
-~~ http://maven.apache.org/doxia/references/apt-format.html
+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.
+-->
 
-Usage
+# Usage
 
-* Compiling Your Java Sources
+Compiling Your Java Sources
+---------------------------
 
-  The goals for the Compiler Plugin are bound to their respective phases in the
-  build lifecycle.  So to compile your sources, you need only to tell maven
-  until which lifecycle to execute.  The following will compile your sources:
+The goals for the Compiler Plugin are bound to their respective phases in the build lifecycle. So to compile your sources, you need only to tell maven until which lifecycle to execute. The following will compile your sources:
 
-+-----
+```unknown
 mvn compile
-+-----
+```
 
-  To compile your test sources, you'll do:
+To compile your test sources, you'll do:
 
-+-----
+```unknown
 mvn test-compile
-+-----
+```
 
-  The above command will execute both <<<compiler:compile>>> and
-  <<<compiler:testCompile>>> since the <<<compile>>> phase happens a few phases
-  before the <<<test-compile>>> phase.
+The above command will execute both `compiler:compile` and `compiler:testCompile` since the `compile` phase happens a few phases before the `test-compile` phase.
 
-* Configuring Your Compiler Plugin
+Configuring Your Compiler Plugin
+--------------------------------
 
-  Since the Compiler Plugin executes automatically during their phases, you
-  don't have to put <<<executions>>> unlike many other plugins. However, you
-  should specify the version of the Compiler Plugin.
+Since the Compiler Plugin executes automatically during their phases, you don't have to put `executions` unlike many other plugins. However, you should specify the version of the Compiler Plugin.
 
-+-----
+```unknown
 <project>
   ...
   <build>
@@ -73,5 +60,4 @@ mvn test-compile
   </build>
   ...
 </project>
-+-----
-
+```