From 9d9ce171c53ca080754680937e1812f065e3d8f2 Mon Sep 17 00:00:00 2001 From: opencode Date: Wed, 29 Jul 2026 17:46:57 +0000 Subject: [PATCH 1/7] fix: Address documentation issues --- .../apt/examples/custom-pom-installation.apt.vm | 6 +++--- .../apt/examples/generic-pom-generation.apt.vm | 9 ++++----- .../examples/installing-secondary-artifacts.apt.vm | 10 +++++----- src/site/apt/examples/specific-local-repo.apt.vm | 6 +++--- src/site/apt/index.apt.vm | 14 +++++++------- src/site/apt/usage.apt | 13 ++++++------- src/site/fml/faq.fml | 2 ++ 7 files changed, 30 insertions(+), 30 deletions(-) diff --git a/src/site/apt/examples/custom-pom-installation.apt.vm b/src/site/apt/examples/custom-pom-installation.apt.vm index 5f8503d3..90642faa 100644 --- a/src/site/apt/examples/custom-pom-installation.apt.vm +++ b/src/site/apt/examples/custom-pom-installation.apt.vm @@ -1,10 +1,10 @@ ---- Installing an artifact with a custom POM - ------ + ---- Allan Ramirez - ------ + ---- 2009-03-22 - ------ + ---- ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file diff --git a/src/site/apt/examples/generic-pom-generation.apt.vm b/src/site/apt/examples/generic-pom-generation.apt.vm index 712074f8..3abd86f4 100644 --- a/src/site/apt/examples/generic-pom-generation.apt.vm +++ b/src/site/apt/examples/generic-pom-generation.apt.vm @@ -1,10 +1,10 @@ ---- Generating a generic POM - ------ + ---- Allan Ramirez - ------ + ---- 2009-03-22 - ------ + ---- ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file @@ -32,8 +32,7 @@ Generating a generic POM For instance, when installing a proprietary or commercial JAR into a repository. The Install Plugin can create a generic POM in this case which contains the minimal set of POM elements required by Maven, such as groupId, - artifactId, version, packaging. You tell Maven to generate a POM by setting the - <<>> parameter to <<>>. + artifactId, version, packaging. You tell Maven to generate a POM by setting the <<>> parameter to <<>>. +---+ mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-your-artifact-jar \ diff --git a/src/site/apt/examples/installing-secondary-artifacts.apt.vm b/src/site/apt/examples/installing-secondary-artifacts.apt.vm index 201c2084..09eb4cdb 100644 --- a/src/site/apt/examples/installing-secondary-artifacts.apt.vm +++ b/src/site/apt/examples/installing-secondary-artifacts.apt.vm @@ -1,10 +1,10 @@ - ------ + ---- Installing Secondary Artifacts - ------ + ---- Dennis Lundberg - ------ + ---- 2009-03-22 - ------ + ---- ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file @@ -42,7 +42,7 @@ Installing Secondary Artifacts +---+ mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-commons-logging-sources.jar \ -DgroupId=commons-logging \ - -DartifactId=commons-logging \ + -DartifactId=commons-logging \ -Dversion=1.0.3 \ -Dpackaging=jar \ -Dclassifier=sources diff --git a/src/site/apt/examples/specific-local-repo.apt.vm b/src/site/apt/examples/specific-local-repo.apt.vm index bcf03dcc..7116956b 100644 --- a/src/site/apt/examples/specific-local-repo.apt.vm +++ b/src/site/apt/examples/specific-local-repo.apt.vm @@ -1,9 +1,9 @@ - ------ + ---- Installing an artifact to a specific local repository path - ------ + ---- Vincent Siveton Robert Scholte - ------ + ---- 2013-07-20 ------ diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index 68f5e0e6..510f01fd 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -1,10 +1,10 @@ - ------ + ---- Introduction - ------ + ---- Allan Ramirez - ------ + ---- 2013-07-22 - ------ + ---- ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file @@ -33,10 +33,10 @@ ${project.name} the information in the POM (groupId, artifactId, version) to determine the proper location for the artifact within the local repository. - The local repository is the local cache where + The local repository is the local cache where, all artifacts needed for the build are stored. By default, it is located within - the user's home directory <<<(~/.m2/repository)>>> but the location can be configured in - <<<~/.m2/settings.xml>>> using the <<<\>>> element. + the user's home directory <<<(~/.m2/repository)>>> but the location can be configured in + <<<~/.m2/settings.xml>>> using the <<<<localRepository>>>>> element. * Goals Overview diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt index 6b372094..d1a6c4ae 100644 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -1,11 +1,11 @@ - ------ + ---- Usage - ------ + ---- Allan Ramirez Robert Scholte - ------ + ---- 2013-07-20 - ------ + ---- ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file @@ -30,7 +30,7 @@ Usage Apache Maven has a two level strategy to resolve and distribute files, which we call artifacts. - The first level is called the <<>>, which is the artifact cache on your system, by default located at <<<$\{user.home\}/.m2/repository>>>. + The first level is called the <<>>, which is the artifact cache on your system, by default located at <<<${user.home}/.m2/repository>>>. When executing Maven, it first looks in this local cache for artifacts. If the artifact cannot be found here, Maven will access the remote repositories to find the artifact. Once found it will be stored into the local repository, so it's available for current and future usage. @@ -65,12 +65,11 @@ mvn install:install-file -Dfile=your-artifact-1.0.jar \ [-Dpackaging=jar] \ [-Dclassifier=sources] \ [-DgeneratePom=true] \ - [-DcreateChecksum=true] +---+ * the groupId, artifactId, version and packaging of the file to install. These can be taken from the specified pomFile, extracted from the pom.xml inside the artifact, and overridden or specified - using the command line. When the pomFile contains a section, the parent's + using the command line; when the pomFile contains a section, the parent's groupId can be considered if the groupId is not specified further for the current project or on the command line. diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml index e94afa96..ab934a5b 100644 --- a/src/site/fml/faq.fml +++ b/src/site/fml/faq.fml @@ -17,6 +17,8 @@ software distributed under the License is distributed on an KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. + + Date: $Date$ --> From 7fb93ff6a079c22f12ff6cffd8c544d681502ff4 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 17:54:31 +0000 Subject: [PATCH 2/7] Clarify generic POM generation instructions Updated wording for clarity and consistency in the explanation of generating a generic POM. --- src/site/apt/examples/generic-pom-generation.apt.vm | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/site/apt/examples/generic-pom-generation.apt.vm b/src/site/apt/examples/generic-pom-generation.apt.vm index 3abd86f4..3369777f 100644 --- a/src/site/apt/examples/generic-pom-generation.apt.vm +++ b/src/site/apt/examples/generic-pom-generation.apt.vm @@ -28,11 +28,11 @@ Generating a generic POM - There are times when you do not have a POM for a 3rd party artifact. - For instance, when installing a proprietary or commercial JAR into a repository. - The Install Plugin can create a generic POM in this case which - contains the minimal set of POM elements required by Maven, such as groupId, - artifactId, version, packaging. You tell Maven to generate a POM by setting the <<>> parameter to <<>>. + There are times when you do not have a POM for a third party artifact, + for example, when installing a proprietary or commercial JAR into a repository. + The Install Plugin can create a generic POM for such an artifact which + contains the minimal set of POM elements required by Maven such as groupId, + artifactId, version, and packaging. You tell Maven to generate a POM by setting the <<>> parameter to <<>>. +---+ mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -Dfile=path-to-your-artifact-jar \ @@ -43,5 +43,5 @@ mvn ${project.groupId}:${project.artifactId}:${project.version}:install-file -D -DgeneratePom=true +---+ - <>: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using <<>> + <>: By using the fully qualified path of a goal, you're ensured to be using the preferred version of the maven-install-plugin. When using <<>>, its version depends on its specification in the pom or the version of Apache Maven. From da5315a58b8e8b5e418e50ee2a31c13d64910dcc Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 17:55:17 +0000 Subject: [PATCH 3/7] Fix formatting issues in index.apt.vm --- src/site/apt/index.apt.vm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index 510f01fd..f3b975f2 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -33,9 +33,9 @@ ${project.name} the information in the POM (groupId, artifactId, version) to determine the proper location for the artifact within the local repository. - The local repository is the local cache where, + The local repository is the local cache where all artifacts needed for the build are stored. By default, it is located within - the user's home directory <<<(~/.m2/repository)>>> but the location can be configured in + the user's home directory <<<(~/.m2/repository)>>>, but the location can be configured in <<<~/.m2/settings.xml>>> using the <<<<localRepository>>>>> element. * Goals Overview From d19be3403d0cc2abb5b5b5e6ef950c9a77c3a183 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 20:40:09 +0000 Subject: [PATCH 4/7] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- src/site/apt/index.apt.vm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/apt/index.apt.vm b/src/site/apt/index.apt.vm index f3b975f2..c576a136 100644 --- a/src/site/apt/index.apt.vm +++ b/src/site/apt/index.apt.vm @@ -36,7 +36,7 @@ ${project.name} The local repository is the local cache where all artifacts needed for the build are stored. By default, it is located within the user's home directory <<<(~/.m2/repository)>>>, but the location can be configured in - <<<~/.m2/settings.xml>>> using the <<<<localRepository>>>>> element. + <<<~/.m2/settings.xml>>> using the <<<<localRepository>>>> element. * Goals Overview From 0da67e43300c4ab20acd5451b0de950ad4439fee Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 20:40:23 +0000 Subject: [PATCH 5/7] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- src/site/apt/examples/specific-local-repo.apt.vm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/site/apt/examples/specific-local-repo.apt.vm b/src/site/apt/examples/specific-local-repo.apt.vm index 7116956b..78fafbdc 100644 --- a/src/site/apt/examples/specific-local-repo.apt.vm +++ b/src/site/apt/examples/specific-local-repo.apt.vm @@ -5,7 +5,7 @@ Robert Scholte ---- 2013-07-20 - ------ + ---- ~~ Licensed to the Apache Software Foundation (ASF) under one ~~ or more contributor license agreements. See the NOTICE file From afd512788b26457af659a56c15e48dd998032497 Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 20:40:30 +0000 Subject: [PATCH 6/7] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --- src/site/fml/faq.fml | 1 - 1 file changed, 1 deletion(-) diff --git a/src/site/fml/faq.fml b/src/site/fml/faq.fml index ab934a5b..1e1a1879 100644 --- a/src/site/fml/faq.fml +++ b/src/site/fml/faq.fml @@ -18,7 +18,6 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. - Date: $Date$ --> From f77049617698e21b68e687b3ab342a82fd3a5a4d Mon Sep 17 00:00:00 2001 From: Elliotte Rusty Harold Date: Wed, 29 Jul 2026 20:42:39 +0000 Subject: [PATCH 7/7] Fix typos in usage.apt documentation --- src/site/apt/usage.apt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/site/apt/usage.apt b/src/site/apt/usage.apt index d1a6c4ae..9aee1f9f 100644 --- a/src/site/apt/usage.apt +++ b/src/site/apt/usage.apt @@ -39,7 +39,7 @@ Usage * The <<>> goal - In most cases, <<>> goal doesn't need any configuration, it + In most cases, the <<>> goal doesn't need any configuration. It needs the project's POM and the artifact file to be installed during the <<>> phase of the default build lifecycle. @@ -49,7 +49,7 @@ mvn install * The <<>> goal - The <<>> goal is used primarily for installing artifacts to + The <<>> goal is used primarily to install artifacts in the local repository which were not built by Maven. The project's development team may or may not provide a POM for the artifact. Here's a list of some of the available parameters for the <<>> goal: @@ -64,7 +64,7 @@ mvn install:install-file -Dfile=your-artifact-1.0.jar \ [-Dversion=1.0] \ [-Dpackaging=jar] \ [-Dclassifier=sources] \ - [-DgeneratePom=true] \ + [-DgeneratePom=true] +---+ * the groupId, artifactId, version and packaging of the file to install. These can