You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "elharo (via GitHub)" <gi...@apache.org> on 2026/07/29 17:47:25 UTC
[PR] fix: Address documentation issues [maven-install-plugin]
elharo opened a new pull request, #425:
URL: https://github.com/apache/maven-install-plugin/pull/425
This PR fixes multiple documentation issues in the maven-install-plugin repository:
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] fix: Address documentation issues [maven-install-plugin]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #425:
URL: https://github.com/apache/maven-install-plugin/pull/425#discussion_r3676936072
##########
src/site/apt/usage.apt:
##########
@@ -65,12 +65,11 @@ mvn install:install-file -Dfile=your-artifact-1.0.jar \
[-Dpackaging=jar] \
[-Dclassifier=sources] \
[-DgeneratePom=true] \
- [-DcreateChecksum=true]
+---+
Review Comment:
The command snippet now ends after the generatePom option, but the last line still ends with a continuation backslash (\\). This implies more parameters follow and makes the example invalid as shown.
##########
src/site/apt/index.apt.vm:
##########
@@ -35,8 +35,8 @@ ${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.
+ the user's home directory <<<(~/.m2/repository)>>>, but the location can be configured in
+ <<<~/.m2/settings.xml>>> using the <<<<localRepository>>>>> element.
Review Comment:
The inline code markup for the <localRepository> element has one extra closing '>' ("...>>>>>"), which will render incorrectly in the generated site. It should be closed with exactly three '>' to match the opening "<<<".
##########
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$
Review Comment:
"Date: $Date$" appears to be an unexpanded VCS keyword placeholder and will likely render literally in the published FAQ (there is no other $Date$/$Id$ usage in src/site). If keyword expansion isn't configured, this line should be removed.
##########
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
------
Review Comment:
The header separator line uses "------" here while the other site APT headers use "----". Keeping it consistent avoids odd rendering differences.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] fix: Address documentation issues [maven-install-plugin]
Posted by "elharo (via GitHub)" <gi...@apache.org>.
elharo closed pull request #425: fix: Address documentation issues
URL: https://github.com/apache/maven-install-plugin/pull/425
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@maven.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org