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-site.git

commit 755835a7bdf6c0030e85e8cef84c31902ac3b2ea
Author: Sylwester Lachiewicz <[email protected]>
AuthorDate: Tue Nov 3 21:40:22 2026 +0100

    Show the .mvn directory in the quickstart project trees
    
    The quickstart archetype 1.5 generates an empty .mvn/jvm.config and
    .mvn/maven.config, which the getting-started trees left out, and prints
    three "Don't override file" warnings that the guide did not mention.
---
 content/markdown/guides/getting-started/index.md              | 11 ++++++++++-
 .../markdown/guides/getting-started/maven-in-five-minutes.md  |  7 +++++++
 2 files changed, 17 insertions(+), 1 deletion(-)

diff --git a/content/markdown/guides/getting-started/index.md 
b/content/markdown/guides/getting-started/index.md
index 935664d5..91bbcbd4 100644
--- a/content/markdown/guides/getting-started/index.md
+++ b/content/markdown/guides/getting-started/index.md
@@ -136,6 +136,9 @@ After the archetype generation of your first project you 
will also notice that t
 
 ```
 my-app
+|-- .mvn
+|   |-- jvm.config
+|   `-- maven.config
 |-- pom.xml
 `-- src
     |-- main
@@ -152,7 +155,7 @@ my-app
                         `-- AppTest.java
 ```
 
-As you can see, the project created from the archetype has a POM, a source 
tree for your application's sources and a source tree for your test sources. 
This is the standard layout for Maven projects (the application sources reside 
in `${project.basedir}/src/main/java` and test sources reside in 
`${project.basedir}/src/test/java`, where `${project.basedir}` represents the 
directory containing `pom.xml`).
+As you can see, the project created from the archetype has a POM, a source 
tree for your application's sources, a source tree for your test sources, and a 
`.mvn` directory with two empty files for project-wide [Maven and JVM 
options](../../configure.html#a.mvn_directory.3A). This is the standard layout 
for Maven projects (the application sources reside in 
`${project.basedir}/src/main/java` and test sources reside in 
`${project.basedir}/src/test/java`, where `${project.basedir}` represent [...]
 
 If you were to create a Maven project by hand this is the directory structure 
that we recommend using. This is a Maven convention and to learn more about it 
you can read our [Introduction to the Standard Directory 
Layout](../introduction/introduction-to-the-standard-directory-layout.html).
 
@@ -421,6 +424,9 @@ You see below in our example we have added the directory 
`${project.basedir}/src
 
 ```
 my-app
+|-- .mvn
+|   |-- jvm.config
+|   `-- maven.config
 |-- pom.xml
 `-- src
     |-- main
@@ -471,6 +477,9 @@ To add resources to the classpath for your unit tests, you 
follow the same patte
 
 ```
 my-app
+|-- .mvn
+|   |-- jvm.config
+|   `-- maven.config
 |-- pom.xml
 `-- src
     |-- main
diff --git a/content/markdown/guides/getting-started/maven-in-five-minutes.md 
b/content/markdown/guides/getting-started/maven-in-five-minutes.md
index d749203e..0d34706d 100644
--- a/content/markdown/guides/getting-started/maven-in-five-minutes.md
+++ b/content/markdown/guides/getting-started/maven-in-five-minutes.md
@@ -67,6 +67,9 @@ Under this directory you will notice the following [standard 
project structure](
 
 ```
 my-app
+|-- .mvn
+|   |-- jvm.config
+|   `-- maven.config
 |-- pom.xml
 `-- src
     |-- main
@@ -85,6 +88,10 @@ my-app
 
 The `src/main/java` directory contains the project source code, the 
`src/test/java` directory contains the test source, and the `pom.xml` file is 
the project's Project Object Model, or POM.
 
+The two files in `.mvn` are empty. They are there for options you want on 
every build of this project: Maven reads `.mvn/maven.config` for command-line 
options and `.mvn/jvm.config` for JVM options (see [Configuring Apache 
Maven](../../configure.html#a.mvn_directory.3A)).
+
+While generating, the archetype prints three warnings that contain `Don't 
override file` (for the two `com/mycompany/app` source directories and for 
`.mvn`). They report that the directory already existed when the archetype came 
to create it; the project is generated correctly, and you can ignore them.
+
 ### The POM
 
 The `pom.xml` file is the core of a project's configuration in Maven. It is a 
single configuration file that contains the majority of information required to 
build a project in just the way you want. The POM is huge and can be daunting 
in its complexity, but it is not necessary to understand all of the intricacies 
just yet to use it effectively. This project's POM should look like this:

Reply via email to