logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From nickwilli...@apache.org
Subject svn commit: r1504345 - in /logging/log4j/log4j2/trunk: flume-ng/src/site/xdoc/index.xml src/changes/changes.xml src/site/site.xml src/site/xdoc/javadoc.xml taglib/src/main/java/org/apache/logging/log4j/taglib/package-info.java
Date Thu, 18 Jul 2013 02:14:51 GMT
Author: nickwilliams
Date: Thu Jul 18 02:14:50 2013
New Revision: 1504345

URL: http://svn.apache.org/r1504345
Log:
Improved site by adding quick jump-off page and menu for Javadoc links for all components.

Added:
    logging/log4j/log4j2/trunk/src/site/xdoc/javadoc.xml
Modified:
    logging/log4j/log4j2/trunk/flume-ng/src/site/xdoc/index.xml
    logging/log4j/log4j2/trunk/src/changes/changes.xml
    logging/log4j/log4j2/trunk/src/site/site.xml
    logging/log4j/log4j2/trunk/taglib/src/main/java/org/apache/logging/log4j/taglib/package-info.java

Modified: logging/log4j/log4j2/trunk/flume-ng/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/flume-ng/src/site/xdoc/index.xml?rev=1504345&r1=1504344&r2=1504345&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/flume-ng/src/site/xdoc/index.xml (original)
+++ logging/log4j/log4j2/trunk/flume-ng/src/site/xdoc/index.xml Thu Jul 18 02:14:50 2013
@@ -39,30 +39,29 @@
               The persistent agent uses Berkeley DB. The following dependency should be added
to your pom.xml
               in addition to the log4j-flume-ng dependency.
             </p>
-            <source><![CDATA[
-            <dependencyManagement>
-              <dependencies>
-                <dependency>
-                  <groupId>com.sleepycat</groupId>
-                  <artifactId>je</artifactId>
-                  <version>5.0.73</version>
-                  </dependency>
-              </dependencies>
-            </dependencyManagement>
-            <dependencies>
-              <dependency>
-                <groupId>com.sleepycat</groupId>
-                <artifactId>je</artifactId>
-              </dependency>
-            </dependencies>
-            <repositories>
-              <repository>
-                <id>oracleReleases</id>
-                <name>Oracle Released Java Packages</name>
-                <url>http://download.oracle.com/maven</url>
-                <layout>default</layout>
-              </repository>
-            </repositories>]]></source>
+            <pre class="prettyprint linenums"><![CDATA[  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>com.sleepycat</groupId>
+        <artifactId>je</artifactId>
+        <version>5.0.73</version>
+        </dependency>
+    </dependencies>
+  </dependencyManagement>
+  <dependencies>
+    <dependency>
+      <groupId>com.sleepycat</groupId>
+      <artifactId>je</artifactId>
+    </dependency>
+  </dependencies>
+  <repositories>
+    <repository>
+      <id>oracleReleases</id>
+      <name>Oracle Released Java Packages</name>
+      <url>http://download.oracle.com/maven</url>
+      <layout>default</layout>
+    </repository>
+  </repositories>]]></pre>
           </subsection>
 
           <subsection name="Embedded Agent">
@@ -70,166 +69,166 @@
               The following is a sample pom file for Maven that can be used as a template
for integrating the
               Flume Embedded Appender into an application.
             </p>
-            <source><![CDATA[<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-                     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-              <modelVersion>4.0.0</modelVersion>
-              <groupId>com.myapp</groupId>
-              <artifactId>myapp</artifactId>
-              <version>0.0.1-SNAPSHOT</version>
-              <name>My App</name>
-              <description>App to test log4j appender</description>
-
-              <properties>
-                <log4j.version>2.0-beta6</log4j.version>
-                <slf4j.version>1.6.6</slf4j.version>
-                <jackson.version>1.9.3</jackson.version>
-              </properties>
-
-              <dependencyManagement>
-                <dependencies>
-                  <dependency>
-                    <groupId>org.slf4j</groupId>
-                    <artifactId>slf4j-api</artifactId>
-                    <version>${slf4j.version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.slf4j</groupId>
-                    <artifactId>slf4j-ext</artifactId>
-                    <version>${slf4j.version></version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.apache.logging.log4j</groupId>
-                    <artifactId>log4j-api</artifactId>
-                    <version>${log4j2_version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.apache.logging.log4j</groupId>
-                    <artifactId>log4j-1.2-api</artifactId>
-                    <version>${log4j2_version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.apache.logging.log4j</groupId>
-                    <artifactId>log4j-core</artifactId>
-                    <version>${log4j2_version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.apache.logging.log4j</groupId>
-                    <artifactId>log4j-flume-ng</artifactId>
-                    <version>${log4j2_version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.apache.logging.log4j</groupId>
-                    <artifactId>log4j-slf4j-impl</artifactId>
-                    <version>${log4j2_version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.apache.logging.log4j</groupId>
-                    <artifactId>log4j-jcl</artifactId>
-                    <version>${log4j2_version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.codehaus.jackson</groupId>
-                    <artifactId>jackson-core-asl</artifactId>
-                    <version>${jackson.version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.codehaus.jackson</groupId>
-                    <artifactId>jackson-mapper-asl</artifactId>
-                    <version>${jackson.version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.codehaus.jackson</groupId>
-                    <artifactId>jackson-jaxrs</artifactId>
-                    <version>${jackson.version}</version>
-                  </dependency>
-                  <dependency>
-                    <groupId>org.codehaus.jackson</groupId>
-                    <artifactId>jackson-xc</artifactId>
-                    <version>${jackson.version}</version>
-                  </dependency>
-                </dependencies>
-              </dependencyManagement>
-
-              <dependencies>
-                <!-- Log4j 2 API -->
-                <dependency>
-                  <groupId>org.apache.logging.log4j</groupId>
-                  <artifactId>log4j-api</artifactId>
-                </dependency>
-                <!-- Log4j 1.x API -->
-                <dependency>
-                  <groupId>org.apache.logging.log4j</groupId>
-                  <artifactId>log4j12-api</artifactId>
-                </dependency>
-                <!-- Log4j 2 implementation -->
-                <dependency>
-                  <groupId>org.apache.logging.log4j</groupId>
-                  <artifactId>log4j-core</artifactId>
-                </dependency>
-                <!-- SLF4J to Log4j 2 binding -->
-                <dependency>
-                  <groupId>org.apache.logging.log4j</groupId>
-                  <artifactId>slf4j-impl</artifactId>
-                </dependency>
-                <!-- SLF4J API -->
-                <dependency>
-                  <groupId>org.slf4j</groupId>
-                  <artifactId>slf4j-api</artifactId>
-                </dependency>
-                <!-- SLF4J extensions -->
-                <dependency>
-                  <groupId>org.slf4j</groupId>
-                  <artifactId>slf4j-ext</artifactId>
-                </dependency>
-                <!-- Commson Logging to Log4j 2 binding -->
-                <dependency>
-                  <groupId>org.apache.logging.log4j</groupId>
-                  <artifactId>log4j-jcl</artifactId>
-                </dependency>
-                <!-- Avro transport protocol - required for Flume -->
-                <dependency>
-                  <groupId>org.apache.avro</groupId>
-                  <artifactId>avro</artifactId>
-                  <version>1.6.3</version>
-                </dependency>
-                <!-- Hadoop core - required by embedded Flume Agent -->
-                <dependency>
-                  <groupId>org.apache.hadoop</groupId>
-                  <artifactId>hadoop-core</artifactId>
-                  <version>1.0.3</version>
-                  <exclusions>
-                    <exclusion>
-                      <groupId>org.mortbay.jetty</groupId>
-                      <artifactId>servlet-api</artifactId>
-                    </exclusion>
-                    <exclusion>
-                      <groupId>org.mortbay.jetty</groupId>
-                      <artifactId>servlet-api-2.5</artifactId>
-                    </exclusion>
-                    <exclusion>
-                      <groupId>junit</groupId>
-                      <artifactId>junit</artifactId>
-                    </exclusion>
-                  </exclusions>
-                </dependency>
-                <!-- Flume File Channel - required by embedded Flume agent -->
-                <dependency>
-                  <groupId>org.apache.flume.flume-ng-channels</groupId>
-                  <artifactId>flume-file-channel</artifactId>
-                  <version>1.2.0</version>
-                  <exclusions>
-                    <exclusion>
-                      <groupId>log4j</groupId>
-                      <artifactId>log4j</artifactId>
-                    </exclusion>
-                    <exclusion>
-                      <groupId>org.slf4j</groupId>
-                      <artifactId>slf4j-log4j12</artifactId>
-                    </exclusion>
-                  </exclusions>
-                </dependency>
-              </dependencies>
-            </project>]]></source>
+            <pre class="prettyprint linenums"><![CDATA[<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.myapp</groupId>
+  <artifactId>myapp</artifactId>
+  <version>0.0.1-SNAPSHOT</version>
+  <name>My App</name>
+  <description>App to test log4j appender</description>
+
+  <properties>
+    <log4j.version>2.0-beta6</log4j.version>
+    <slf4j.version>1.6.6</slf4j.version>
+    <jackson.version>1.9.3</jackson.version>
+  </properties>
+
+  <dependencyManagement>
+    <dependencies>
+      <dependency>
+        <groupId>org.slf4j</groupId>
+        <artifactId>slf4j-api</artifactId>
+        <version>${slf4j.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.slf4j</groupId>
+        <artifactId>slf4j-ext</artifactId>
+        <version>${slf4j.version></version>
+      </dependency>
+      <dependency>
+        <groupId>org.apache.logging.log4j</groupId>
+        <artifactId>log4j-api</artifactId>
+        <version>${log4j2_version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.apache.logging.log4j</groupId>
+        <artifactId>log4j-1.2-api</artifactId>
+        <version>${log4j2_version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.apache.logging.log4j</groupId>
+        <artifactId>log4j-core</artifactId>
+        <version>${log4j2_version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.apache.logging.log4j</groupId>
+        <artifactId>log4j-flume-ng</artifactId>
+        <version>${log4j2_version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.apache.logging.log4j</groupId>
+        <artifactId>log4j-slf4j-impl</artifactId>
+        <version>${log4j2_version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.apache.logging.log4j</groupId>
+        <artifactId>log4j-jcl</artifactId>
+        <version>${log4j2_version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.codehaus.jackson</groupId>
+        <artifactId>jackson-core-asl</artifactId>
+        <version>${jackson.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.codehaus.jackson</groupId>
+        <artifactId>jackson-mapper-asl</artifactId>
+        <version>${jackson.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.codehaus.jackson</groupId>
+        <artifactId>jackson-jaxrs</artifactId>
+        <version>${jackson.version}</version>
+      </dependency>
+      <dependency>
+        <groupId>org.codehaus.jackson</groupId>
+        <artifactId>jackson-xc</artifactId>
+        <version>${jackson.version}</version>
+      </dependency>
+    </dependencies>
+  </dependencyManagement>
+
+  <dependencies>
+    <!-- Log4j 2 API -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-api</artifactId>
+    </dependency>
+    <!-- Log4j 1.x API -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j12-api</artifactId>
+    </dependency>
+    <!-- Log4j 2 implementation -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+    </dependency>
+    <!-- SLF4J to Log4j 2 binding -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>slf4j-impl</artifactId>
+    </dependency>
+    <!-- SLF4J API -->
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+    </dependency>
+    <!-- SLF4J extensions -->
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-ext</artifactId>
+    </dependency>
+    <!-- Commson Logging to Log4j 2 binding -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-jcl</artifactId>
+    </dependency>
+    <!-- Avro transport protocol - required for Flume -->
+    <dependency>
+      <groupId>org.apache.avro</groupId>
+      <artifactId>avro</artifactId>
+      <version>1.6.3</version>
+    </dependency>
+    <!-- Hadoop core - required by embedded Flume Agent -->
+    <dependency>
+      <groupId>org.apache.hadoop</groupId>
+      <artifactId>hadoop-core</artifactId>
+      <version>1.0.3</version>
+      <exclusions>
+        <exclusion>
+          <groupId>org.mortbay.jetty</groupId>
+          <artifactId>servlet-api</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>org.mortbay.jetty</groupId>
+          <artifactId>servlet-api-2.5</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>junit</groupId>
+          <artifactId>junit</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+    <!-- Flume File Channel - required by embedded Flume agent -->
+    <dependency>
+      <groupId>org.apache.flume.flume-ng-channels</groupId>
+      <artifactId>flume-file-channel</artifactId>
+      <version>1.2.0</version>
+      <exclusions>
+        <exclusion>
+          <groupId>log4j</groupId>
+          <artifactId>log4j</artifactId>
+        </exclusion>
+        <exclusion>
+          <groupId>org.slf4j</groupId>
+          <artifactId>slf4j-log4j12</artifactId>
+        </exclusion>
+      </exclusions>
+    </dependency>
+  </dependencies>
+</project>]]></pre>
           </subsection>
 
         </section>

Modified: logging/log4j/log4j2/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/changes/changes.xml?rev=1504345&r1=1504344&r2=1504345&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/changes/changes.xml (original)
+++ logging/log4j/log4j2/trunk/src/changes/changes.xml Thu Jul 18 02:14:50 2013
@@ -45,6 +45,9 @@
       <action issue="LOG4J2-291" dev="nickwilliams" type="fix">
         Fixed JDBC, JPA, and NoSQL appenders so that the failover appender properly fails
over on error.
       </action>
+      <action dev="nickwilliams" type="update">
+        Improved site by adding quick jump-off page and menu for Javadoc links for all components.
+      </action>
     </release>
     <release version="2.0-beta8" date="2013-07-10" description="Bug fixes and enhancements">
       <action issue="LOG4J2-270" dev="nickwilliams" type="update">

Modified: logging/log4j/log4j2/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/site.xml?rev=1504345&r1=1504344&r2=1504345&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/site.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/site.xml Thu Jul 18 02:14:50 2013
@@ -23,6 +23,12 @@
       <item name="Maven and Ivy" href="/maven-artifacts.html"/>
       <item name="Build" href="/build.html"/>
       <item name="Changelog" href="/changelog.html"/>
+      <item name="Javadoc" href="/javadoc.html" collapse="true">
+        <item name="Log4j 2 API" href="/log4j-api/apidocs/index.html" />
+        <item name="Implementation" href="/log4j-core/apidocs/index.html" />
+        <item name="JSP Tag Library" href="/log4j-taglib/apidocs/index.html" />
+        <item name="JSP Tag Library (TLD Doc)" href="/log4j-taglib/tlddoc/index.html"
/>
+      </item>
     </menu>
 
     <menu name="Manual" inherit="top" img="icon-book">
@@ -153,7 +159,7 @@
       <item name="Log4j 1.2 API" href="log4j-1.2-api/index.html"/>
       <item name="SLF4J Binding" href="log4j-slf4j-impl/index.html"/>
       <item name="Log4j 2 to SLF4J Adapter" href="log4j-to-slf4j/index.html"/>
-      <item name="Apache Flume" href="log4j-flume-ng/index.html"/>
+      <item name="Apache Flume NG Appender" href="log4j-flume-ng/index.html"/>
       <item name="Log4j Tag Library" href="log4j-taglib/index.html"/>
       <item name="Log4j JMX GUI" href="log4j-jmx-gui/index.html"/>
     </menu>

Added: logging/log4j/log4j2/trunk/src/site/xdoc/javadoc.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/javadoc.xml?rev=1504345&view=auto
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/javadoc.xml (added)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/javadoc.xml Thu Jul 18 02:14:50 2013
@@ -0,0 +1,90 @@
+<?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>
+  <properties>
+    <title>Log4j 2 Javadoc API Documentation and TLD Documentation</title>
+    <author email="nickwilliams@apache.org">Nick Williams</author>
+  </properties>
+
+  <body>
+    <section name="Javadoc API Documentation">
+      <p>
+        The table below contains links to the Javadoc API Documentation for the components
you are most likely to use
+        directly in code. You can also use the menu links on the left.
+      </p>
+      <table>
+        <tr>
+          <th>Component</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td><a href="log4j-api/apidocs/index.html">Log4j 2 API</a></td>
+          <td>The interface that applications should use and code against.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-core/apidocs/index.html">Implementation</a></td>
+          <td>The standard implementation, also called the Log4j 2 Core, that contains
Appenders, Filters, and more.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-taglib/apidocs/index.html">JSP Tag Library</a></td>
+          <td>The tag library that enables Java-free logging in JavaServer Pages™
using Log4j 2.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-taglib/tlddoc/index.html">JSP Tag Library (TLD Doc)</a></td>
+          <td>The special Javadoc-like Tag Library Documentation for the Log4j 2 JSP
Tag Library.</td>
+        </tr>
+      </table>
+
+      <p>
+        The table below contains links to the Javadoc API Documentation for all the other
Log4j 2 components, which you
+        likely will not use directly in code but instead will only configure or include in
your dependencies.
+      </p>
+      <table>
+        <tr>
+          <th>Component</th>
+          <th>Description</th>
+        </tr>
+        <tr>
+          <td><a href="log4j-jcl/apidocs/index.html">Commons Logging Bridge</a></td>
+          <td>A bridge that permits applications written against the Apache Commons
Logging API to log using Log4j 2.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-slf4j-impl/apidocs/index.html">SLF4J Binding</a></td>
+          <td>A bridge that permits applications written against the SLF4J API to log
using Log4j 2.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-1.2-api/apidocs/index.html">Log4j 1.2 API Bridge</a></td>
+          <td>A bridge that permits applications written against the Log4j 1.2.x API
to log using Log4j 2.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-to-slf4j/apidocs/index.html">Log4j 2 to SLF4J Adapter</a></td>
+          <td>An adapter that permits applications written against the Log4j 2 API
to log using SLF4J.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-flume-ng/apidocs/index.html">Apache Flume NG Appender</a></td>
+          <td>An Appender that allows applications to send logging events to Apache
Flume NG Agents.</td>
+        </tr>
+        <tr>
+          <td><a href="log4j-jmx-gui/apidocs/index.html">Log4j JMX GUI</a></td>
+          <td>A Java Swing-based client for remotely viewing the status logger and
editing the Log4j configuration.</td>
+        </tr>
+      </table>
+    </section>
+  </body>
+</document>

Modified: logging/log4j/log4j2/trunk/taglib/src/main/java/org/apache/logging/log4j/taglib/package-info.java
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/taglib/src/main/java/org/apache/logging/log4j/taglib/package-info.java?rev=1504345&r1=1504344&r2=1504345&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/taglib/src/main/java/org/apache/logging/log4j/taglib/package-info.java
(original)
+++ logging/log4j/log4j2/trunk/taglib/src/main/java/org/apache/logging/log4j/taglib/package-info.java
Thu Jul 18 02:14:50 2013
@@ -15,8 +15,8 @@
  * limitations under the license.
  */
 /**
- +  Classes (JSP tags) to enable logging in JSPs without using Java scripting.
- +
- +  @since 2.0
+ * Classes (JSP tags) to enable logging in JSPs without using Java scripting.
+ *
+ * @since 2.0
  */
 package org.apache.logging.log4j.taglib;



Mime
View raw message