logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ggreg...@apache.org
Subject svn commit: r1470559 - /logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm
Date Mon, 22 Apr 2013 14:50:06 GMT
Author: ggregory
Date: Mon Apr 22 14:50:06 2013
New Revision: 1470559

URL: http://svn.apache.org/r1470559
Log:
Better instructions for site generation.

Modified:
    logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm

Modified: logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm?rev=1470559&r1=1470558&r2=1470559&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm Mon Apr 22 14:50:06 2013
@@ -19,13 +19,13 @@
 	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
 
 	<properties>
-		<title>Build and Use</title>
+		<title>Building and Using Log4J</title>
 	</properties>
 
 	<body>
-		<section name="Building and Using Log4j 2.x">
+		<section name="Building and Using Log4j">
 
-      <subsection name="Building">
+      <subsection name="Building Log4J">
         <p>
           Log4j 2.x is hosted in the Apache Software Foundation's subversion repository.
Details on obtaining the
           most current source code can be found at
@@ -33,9 +33,31 @@
           obtained by downloading it using the instructions at <a href="./download.html">Log4j
Downloads</a>.
         </p>
         <p>
-          Log4j 2.x uses Maven 2 or 3 as its build tool. To build Log4j simply run "mvn install"
from the root
-          directory. Then to build the site, run "mvn site". To rebuild only what's changed
and execute the tests, run
-          "mvn test". To rebuild from scratch, add "clean", for example: "mvn clean test".
+          Log4j 2.x uses Maven 2 or 3 as its build tool. To build and install Log4j in your
local Maven cache, from 
+          the root directory run:
+        </p>
+        <p>
+          <pre>mvn install</pre>
+        </p>
+        <p>
+          Then to build the full site, you must use a local staging directory:
+        </p>
+        <p>
+          <pre>mvn site
+[Windows] mvn site:stage-deploy -DstagingSiteURL=file:///%HOME%/log4j
+[Unix] mvn site:stage-deploy -DstagingSiteURL=file:///$HOME/log4j</pre>
+        </p>
+        <p>
+          To rebuild only what's changed and execute the tests, run:
+        </p>
+        <p>
+          <pre>mvn test</pre>
+        </p>
+        <p>
+          To rebuild from scratch, add "clean", for example:
+        </p>
+        <p>
+          <pre>mvn clean test</pre>
         </p>
       </subsection>
       <subsection name="Using Log4J on your classpath">



Mime
View raw message