You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by vy...@apache.org on 2024/04/05 18:55:05 UTC
(logging-log4j2) 02/02: Improve `BUILDING.adoc`
This is an automated email from the ASF dual-hosted git repository.
vy pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git
commit b7f42b1d2c3cd12dbd843c9e8e6e2b516018868e
Author: Volkan Yazıcı <vo...@yazi.ci>
AuthorDate: Fri Apr 5 20:53:09 2024 +0200
Improve `BUILDING.adoc`
---
BUILDING.adoc | 12 ++++++++----
1 file changed, 8 insertions(+), 4 deletions(-)
diff --git a/BUILDING.adoc b/BUILDING.adoc
index f95ebe1433..0148c93c45 100644
--- a/BUILDING.adoc
+++ b/BUILDING.adoc
@@ -85,14 +85,18 @@ You either need to have a user-level configuration in `~/.m2/toolchains.xml` or
----
[#website]
-== Building the website and manual
+== Building the website
-You can build the website and manual as follows:
+You can build the website as follows:
[source,bash]
----
-./mvnw site
+./mvnw compile # <1>
+./mvnw site # <2>
----
+<1> Generate plugin descriptors that will be used to generate the plugin reference page.
+Descriptors are placed under `target/plugin-descriptors`.
+<2> Generate the website to `target/site`
You can view the generated website with a browser by pointing it to `target/site` directory.
@@ -108,7 +112,7 @@ You can follow below steps for casual development needs:
You can connect your IDE to a `./mvnw test` run by
-. Add `-Dmaven.surefire.debug` to the `./mvnw test` command
+. Run `./mvnw test -pl :log4j-core-test -Dtest=FooBarTest -Dmaven.surefire.debug`
. Use _"Run > Attach to process"_ in IntelliJ IDEA
[#development-faq]