logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nickwilli...@apache.org
Subject svn commit: r1482158 - in /logging/log4j/log4j2/trunk/src/site: apt/download.apt.vm site.xml xdoc/build.xml.vm xdoc/maven-artifacts.xml.vm
Date Tue, 14 May 2013 00:38:06 GMT
Author: nickwilliams
Date: Tue May 14 00:38:05 2013
New Revision: 1482158

URL: http://svn.apache.org/r1482158
Log:
Per discussion on mailing list:
- Added separate page for Maven/Ivy instructions and removed from Build & Install page
- Moved class path instructions from Build & Install page to download page

Added:
    logging/log4j/log4j2/trunk/src/site/xdoc/maven-artifacts.xml.vm
Modified:
    logging/log4j/log4j2/trunk/src/site/apt/download.apt.vm
    logging/log4j/log4j2/trunk/src/site/site.xml
    logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm

Modified: logging/log4j/log4j2/trunk/src/site/apt/download.apt.vm
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/apt/download.apt.vm?rev=1482158&r1=1482157&r2=1482158&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/apt/download.apt.vm (original)
+++ logging/log4j/log4j2/trunk/src/site/apt/download.apt.vm Tue May 14 00:38:05 2013
@@ -20,7 +20,8 @@ Download Apache Log4j 2
 
 Download Apache Log4j 2
 
-  Apache Log4j 2 is distributed under the {{{http://www.apache.org/licenses/LICENSE-2.0.html}
Apache License, version 2.0}}.
+  Apache Log4j 2 is distributed under the
+  {{{http://www.apache.org/licenses/LICENSE-2.0.html} Apache License, version 2.0}}.
 
   The link in the Mirrors column should display a list of available mirrors with a
   default selection based on your inferred location.  If you do not see that page,
@@ -43,9 +44,10 @@ Download Apache Log4j 2
     Please read {{{http://httpd.apache.org/dev/verification.html}Verifying Apache HTTP Server
Releases}} for more
     information on why you should verify our releases.
 
-    The PGP signatures can be verified using PGP or GPG. First download the {{{http://www.apache.org/dist/logging/KEYS}KEYS}}
-    as well as the asc signature file for the relevant distribution. Make sure you get these
files from the
-    {{{http://www.apache.org/dist/logging/}main distribution directory}}, rather than from
a mirror. Then verify the signatures using
+    The PGP signatures can be verified using PGP or GPG. First download the
+    {{{http://www.apache.org/dist/logging/KEYS}KEYS}} as well as the asc signature file for
the relevant distribution.
+    Make sure you get these files from the {{{http://www.apache.org/dist/logging/}main distribution
directory}}, rather
+    than from a mirror. Then verify the signatures using
 
 ---
 % gpg --import KEYS
@@ -61,4 +63,17 @@ Download Apache Log4j 2
 
 * Previous Releases
 
-  All previous releases of Apache log4j can be found in the {{{http://archive.apache.org/dist/logging/log4j}archive
repository}}.
+  All previous releases of Apache log4j can be found in the
+  {{{http://archive.apache.org/dist/logging/log4j}archive repository}}.
+
+* Using Log4J on your classpath
+
+  To use Log4j 2 in your application make sure that both the API and Core jars are in the
application's classpath. Add
+  the dependencies listed below to your classpath.
+
+---
+log4j-api-${Log4jReleaseVersion}.jar
+log4j-core-${Log4jReleaseVersion}.jar
+---
+
+  You can do this from the command line or a manifest file.
\ No newline at end of file

Modified: logging/log4j/log4j2/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/site.xml?rev=1482158&r1=1482157&r2=1482158&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/site.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/site.xml Tue May 14 00:38:05 2013
@@ -20,7 +20,8 @@
     <menu name="Apache Log4j™ 2" inherit="top" img="icon-home">
       <item name="About" href="/index.html"/>
       <item name="Download" href="/download.html"/>
-      <item name="Build and Install" href="/build.html"/>
+      <item name="Maven and Ivy" href="/maven-artifacts.html"/>
+      <item name="Build" href="/build.html"/>
       <item name="Changelog" href="/changelog.html"/>
     </menu>
 

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=1482158&r1=1482157&r2=1482158&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/build.xml.vm Tue May 14 00:38:05 2013
@@ -19,151 +19,38 @@
 	xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
 
 	<properties>
-		<title>Building and Using Log4J</title>
+		<title>Building and Installing Log4j</title>
 	</properties>
 
 	<body>
-		<section name="Building and Using Log4j">
+		<section name="Building and Installing Log4j">
 
-      <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
-          <a href="./source-repository.html">Log4j Source Repository</a>. The
source from the latest release may be
-          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 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
+      <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
+        <a href="./source-repository.html">Log4j Source Repository</a>. The source
from the latest release may be
+        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 and install Log4j in your
local Maven cache, from
+        the root directory run:
+      </p>
+      <pre>mvn install</pre>
+      <p>
+        Then to build the full site, you must use a local staging directory:
+      </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">
-       <p>
-         To use Log4j 2 in your application make sure that both the API and Core jars are
in the application's
-         classpath. Add the dependencies listed below to your classpath.
-       </p>
-       <ul>
-         <li><code>log4j-api-${Log4jReleaseVersion}.jar</code></li>
-         <li><code>log4j-core-${Log4jReleaseVersion}.jar</code></li>
-       </ul>
-       <p>
-         You can do this from the command line or a manifest file.
-       </p>
-      </subsection>
-      <subsection name="Using Log4J in your Apache Maven build">
-       <p>
-         To build with <a href="http://maven.apache.org/">Apache Maven</a>, add
the dependencies listed below to your
-         <code>pom.xml</code> file.
-       </p>
-<pre class="prettyprint linenums"><![CDATA[
-<dependencies>
-  <dependency>
-    <groupId>org.apache.logging.log4j</groupId>
-    <artifactId>log4j-api</artifactId>
-    <version>${Log4jReleaseVersion}</version>
-  </dependency>
-  <dependency>
-    <groupId>org.apache.logging.log4j</groupId>
-    <artifactId>log4j-core</artifactId>
-    <version>${Log4jReleaseVersion}</version>
-  </dependency>
-</dependencies>
-]]></pre>
-      </subsection>
-      <subsection name="Using Log4J in your Apache Ivy build">
-       <p>
-         To build with <a href="https://ant.apache.org/ivy/">Apache Ivy</a>,
add the dependencies listed below to your
-         <code>ivy.xml</code> file.
-       </p>
-<pre class="prettyprint linenums"><![CDATA[
-<dependencies>
-  <dependency org="org.apache.logging.log4j" name="log4j-api" rev="${Log4jReleaseVersion}"
/>
-  <dependency org="org.apache.logging.log4j" name="log4j-core" rev="${Log4jReleaseVersion}"
/>
-</dependencies>
-]]></pre>
-      </subsection>
-      <subsection name="Optional Components">
-        <p>
-          Log4j 2.x contains several optional components that can be included in an application.
-        </p>
-        <h4>Log4j 1.x</h4>
-        <p>If there are existing components that are written to use Log4j 1.x and it
is desired to have this
-           logging routed to Log4j 2 then remove any log4j 1.x dependencies and add the following.
-        </p>
-<pre class="prettyprint linenums"><![CDATA[
-<dependencies>
-  <dependency>
-    <groupId>org.apache.logging.log4j</groupId>
-    <artifactId>log4j-1.2-api</artifactId>
-    <version>${Log4jReleaseVersion}</version>
-  </dependency>
-</dependecies>
-]]></pre>
-          <h4>Apache Commons Logging</h4>
-          <p>Commons Logging is used in many components as a way of letting applications
choose the specific
-             logging implementation. To route logging from those components into Log4j 2
include the
-             following dependency and do not remove the Commons Logging jar.
-          </p>
-<pre class="prettyprint linenums"><![CDATA[
-<dependencies>
-  <dependency>
-    <groupId>org.apache.logging.log4j</groupId>
-    <artifactId>log4j-jcl</artifactId>
-    <version>${Log4jReleaseVersion}</version>
-  </dependency>
-</dependencies>
-]]></pre>
-          <h4>SLF4J</h4>
-          <p>SLF4J is another popular logging API that may be bound to Log4j 2 by including
the following
-             dependency along with the SLF4J dependencies.
-          </p>
-<pre class="prettyprint linenums"><![CDATA[
-<dependencies>
-  <dependency>
-    <groupId>org.apache.logging.log4j</groupId>
-    <artifactId>log4j-slf4j-impl</artifactId>
-    <version>${Log4jReleaseVersion}</version>
-  </dependency>
-</dependencies>
-]]></pre>
-          <h4>Tag Library</h4>
-          <p>The Log4j Log Tag Library creates the capability of inserting log statements
in JSPs without
-             the use of Java scripting. It uses the standard Log4j 2 API to log messages
according to
-             your Log4j configuration.
-          </p>
-<pre class="prettyprint linenums"><![CDATA[
-<dependencies>
-  <dependency>
-    <groupId>org.apache.logging.log4j</groupId>
-    <artifactId>log4j-taglib</artifactId>
-    <version>${Log4jReleaseVersion}</version>
-  </dependency>
-</dependencies>
-]]></pre>
-      </subsection>
+      <p>
+        To rebuild only what's changed and execute the tests, run:
+      </p>
+      <pre>mvn test</pre>
+      <p>
+        To rebuild from scratch, add "clean", for example:
+      </p>
+      <pre>mvn clean test</pre>
+
 		</section>
 	</body>
 </document>

Added: logging/log4j/log4j2/trunk/src/site/xdoc/maven-artifacts.xml.vm
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/maven-artifacts.xml.vm?rev=1482158&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/maven-artifacts.xml.vm (added)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/maven-artifacts.xml.vm Tue May 14 00:38:05 2013
@@ -0,0 +1,205 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+         http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+          xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
+
+  <properties>
+    <title>Maven and Ivy Artifacts</title>
+  </properties>
+
+  <body>
+    <section name="Maven and Ivy Artifacts">
+
+      <subsection name="Using Log4J in your Apache Maven build">
+        <p>
+          To build with <a href="http://maven.apache.org/">Apache Maven</a>,
add the dependencies listed below to your
+          <code>pom.xml</code> file.
+        </p>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-api</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-core</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+      </subsection>
+      <subsection name="Using Log4J in your Apache Ivy build">
+        <p>
+          To build with <a href="https://ant.apache.org/ivy/">Apache Ivy</a>,
add the dependencies listed below to your
+          <code>ivy.xml</code> file.
+        </p>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-api" rev="${Log4jReleaseVersion}"
/>
+  <dependency org="org.apache.logging.log4j" name="log4j-core" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+      </subsection>
+      <subsection name="Optional Components">
+        <p>
+          Log4j 2.x contains several optional components that can be included in an application.
+        </p>
+        <h4>Log4j 1.x API Bridge</h4>
+        <p>If there are existing components that are written to use Log4j 1.x and it
is desired to have this
+          logging routed to Log4j 2 then remove any log4j 1.x dependencies and add the following.
+        </p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-1.2-api</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-1.2-api" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+        <h4>Apache Commons Logging Bridge</h4>
+        <p>Commons Logging is used in many components as a way of letting applications
choose the specific
+          logging implementation. To route logging from those components into Log4j 2 include
the
+          following dependency and do not remove the Commons Logging jar.
+        </p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-jcl</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-jcl" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+        <h4>SLF4J Bridge</h4>
+        <p>SLF4J is another popular logging API that may be bound to Log4j 2 by including
the following
+          dependency along with the SLF4J dependencies.
+        </p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-slf4j-impl</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-slf4j-impl" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+        <h4>Tag Library</h4>
+        <p>The Log4j Log Tag Library creates the capability of inserting log statements
in JSPs without
+          the use of Java scripting. It uses the standard Log4j 2 API to log messages according
to
+          your Log4j configuration.
+        </p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-taglib</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-taglib" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+        <h4>Log4j Web</h4>
+        <p>The Log4j Web artifact contains classes that can be used to initialize logging
within a web application.</p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-web</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-web" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+        <h4>Apache Flume NG Appender</h4>
+        <p>The Flume NG Appender allows applications to send events to Flume NG Agents.</p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-flume-ng</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-flume-ng" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+        <h4>Log4j to SLF4J Adapter</h4>
+        <p>The Log4j 2 to SLF4J Adapter allows applications coded to the Log4j 2 API
to be routed to SLF4J. Use of this
+          adapter may cause some loss of performance as the Log4j 2 Messages must be formatted
before they can be passed
+          to SLF4J. The SLF4J Bridge must NOT be on the class path when this is in use.</p>
+        <code>pom.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency>
+    <groupId>org.apache.logging.log4j</groupId>
+    <artifactId>log4j-to-slf4j</artifactId>
+    <version>${Log4jReleaseVersion}</version>
+  </dependency>
+</dependencies>
+]]></pre>
+        <code>ivy.xml</code>
+        <pre class="prettyprint linenums"><![CDATA[
+<dependencies>
+  <dependency org="org.apache.logging.log4j" name="log4j-to-slf4j" rev="${Log4jReleaseVersion}"
/>
+</dependencies>
+]]></pre>
+      </subsection>
+    </section>
+  </body>
+</document>



Mime
View raw message