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/09 23:02:54 UTC

(maven-jar-plugin) branch fix-faq-code-markup created (now 25f9bb8)

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

slachiewicz pushed a change to branch fix-faq-code-markup
in repository https://gitbox.apache.org/repos/asf/maven-jar-plugin.git


      at 25f9bb8  Render the archive parameter as code on the FAQ page

This branch includes the following new commits:

     new 25f9bb8  Render the archive parameter as code on the FAQ page

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(maven-jar-plugin) 01/01: Render the archive parameter as code on the FAQ page

Posted by sl...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

slachiewicz pushed a commit to branch fix-faq-code-markup
in repository https://gitbox.apache.org/repos/asf/maven-jar-plugin.git

commit 25f9bb8244e62cd6b51183c67009bd6cf765484c
Author: Sylwester Lachiewicz <sl...@apache.org>
AuthorDate: Mon Aug 10 01:01:15 2026 +0200

    Render the archive parameter as code on the FAQ page
    
    The FAQ answer was rewritten in #581 using Markdown backticks around
    `archive`. FML is not Markdown: an <answer> body is parsed by Doxia's
    XdocParser, which has no backtick handling, so the characters reach the
    generated page verbatim. maven.apache.org currently shows
    
      The `archive` parameter is defined by the Maven Archiver library.
    
    Use <code>, which is what the other 21 faq.fml files in the Maven estate
    use for the same purpose.
    
    The same sentence also gained a full stop in place of a comma, splitting
    "defined by the Maven Archiver library, not by the Maven JAR Plugin" into
    a sentence and a fragment. Fixed here since it is the same sentence and
    the same origin.
    
    Verified by building the site before and after: the only differences in
    the rendered page are `archive` -> archive and library. -> library,. The
    #question1 anchor is unchanged.
    
    Generated-by: Claude Opus 5 (1M context)
---
 src/site/fml/faq.fml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml
index ebe1199..a92dd1f 100644
--- a/src/site/fml/faq.fml
+++ b/src/site/fml/faq.fml
@@ -28,7 +28,7 @@ under the License.
       <question>Why is there no documentation for the archive parameter?</question>
       <answer>
         <p>
-          The `archive` parameter is defined by the Maven Archiver library.
+          The <code>archive</code> parameter is defined by the Maven Archiver library,
           not by the Maven JAR Plugin. Read the <a href="/shared/maven-archiver/index.html">Maven Archiver
           documentation</a>.
         </p>