You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2017/01/29 21:48:06 UTC
[2/2] logging-log4j2 git commit: [LOG4J2-1802]: Migrate component
sites to markdown
[LOG4J2-1802]: Migrate component sites to markdown
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/2f0c6064
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/2f0c6064
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/2f0c6064
Branch: refs/heads/master
Commit: 2f0c6064a337fb7e9a6001f6a8648400a51fea25
Parents: ab24006
Author: Matt Sicker <bo...@gmail.com>
Authored: Sun Jan 29 15:48:59 2017 -0600
Committer: Matt Sicker <bo...@gmail.com>
Committed: Sun Jan 29 15:48:59 2017 -0600
----------------------------------------------------------------------
log4j-1.2-api/src/site/markdown/index.md | 34 +++
log4j-1.2-api/src/site/xdoc/index.xml | 52 -----
log4j-api/src/site/markdown/index.md | 26 +++
log4j-api/src/site/xdoc/index.xml | 42 ----
log4j-core/src/site/manual/index.md | 33 +++
log4j-core/src/site/xdoc/index.xml | 48 -----
log4j-flume-ng/src/site/markdown/index.md.vm | 233 ++++++++++++++++++++
log4j-flume-ng/src/site/xdoc/index.xml.vm | 245 ----------------------
log4j-jcl/src/site/markdown/index.md | 33 +++
log4j-jcl/src/site/xdoc/index.xml | 52 -----
log4j-jmx-gui/src/site/markdown/index.md | 33 +++
log4j-jmx-gui/src/site/xdoc/index.xml | 50 -----
log4j-jul/src/site/markdown/index.md | 76 +++++++
log4j-jul/src/site/xdoc/index.xml | 127 -----------
log4j-liquibase/src/site/markdown/index.md | 31 +++
log4j-liquibase/src/site/xdoc/index.xml | 49 -----
log4j-nosql/src/site/markdown/index.md.vm | 79 +++++++
log4j-nosql/src/site/xdoc/index.xml.vm | 86 --------
log4j-slf4j-impl/src/site/markdown/index.md | 40 ++++
log4j-slf4j-impl/src/site/xdoc/index.xml | 58 -----
log4j-taglib/src/site/markdown/index.md | 70 +++++++
log4j-taglib/src/site/xdoc/index.xml | 84 --------
log4j-to-slf4j/src/site/markdown/index.md | 41 ++++
log4j-to-slf4j/src/site/xdoc/index.xml | 58 -----
log4j-web/src/site/markdown/index.md | 30 +++
log4j-web/src/site/xdoc/index.xml | 44 ----
26 files changed, 759 insertions(+), 995 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-1.2-api/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-1.2-api/src/site/markdown/index.md b/log4j-1.2-api/src/site/markdown/index.md
new file mode 100644
index 0000000..a80e687
--- /dev/null
+++ b/log4j-1.2-api/src/site/markdown/index.md
@@ -0,0 +1,34 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j 1.2 Bridge
+
+The Log4j 1.2 Bridge allows applications coded to use Log4j 1.2 API to use
+Log4j 2 instead.
+
+## Requirements
+
+The Log4j 1.2 bridge is dependent on the Log4j 2 API and implementation.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+To use the Log4j Legacy Bridge just remove all the Log4j 1.x jars from the application and replace them
+with the bridge jar. Once in place all logging that uses Log4j 1.x will be routed to Log4j 2. However,
+applications that attempt to modify legacy Log4j by adding Appenders, Filters, etc may experience problems
+if they try to verify the success of these actions as these methods are largely no-ops.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-1.2-api/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-1.2-api/src/site/xdoc/index.xml b/log4j-1.2-api/src/site/xdoc/index.xml
deleted file mode 100644
index 2ae33bf..0000000
--- a/log4j-1.2-api/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 1.2 Bridge</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Log4j 1.2 Bridge">
-
- <p>
- The Log4j 1.2 Bridge allows applications coded to use Log4j 1.2 API to use
- Log4j 2 instead.
- </p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The Log4j 1.2 bridge is dependent on the Log4j 2 API and implementation.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- <section name="Usage">
- <p>
- To use the Log4j Legacy Bridge just remove all the Log4j 1.x jars from the application and replace them
- with the bridge jar. Once in place all logging that uses Log4j 1.x will be routed to Log4j 2. However,
- applications that attempt to modify legacy Log4j by adding Appenders, Filters, etc may experience problems
- if they try to verify the success of these actions as these methods are largely no-ops.
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-api/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-api/src/site/markdown/index.md b/log4j-api/src/site/markdown/index.md
new file mode 100644
index 0000000..f83cc0d
--- /dev/null
+++ b/log4j-api/src/site/markdown/index.md
@@ -0,0 +1,26 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j 2 API
+
+The Log4j 2 API provides the interface that applications should code to and provides the
+adapter components required for implementers to create a logging implementation.
+
+## Requirements
+
+As of version 2.4, the Log4j 2 API requires Java 7. Versions 2.3 and earlier require Java 6.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-api/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-api/src/site/xdoc/index.xml b/log4j-api/src/site/xdoc/index.xml
deleted file mode 100644
index 7586c5c..0000000
--- a/log4j-api/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,42 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 API</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Log4j 2 API">
-
- <p>
- The Log4j 2 API provides the interface that applications should code to and provides the
- adapter components required for implementers to create a logging implementation.
- </p>
-
- </section>
-
- <section name="Requirements">
- <p>
- As of version 2.4, the Log4j 2 API requires Java 7. Versions 2.3 and earlier require Java 6.
- </p>
- </section>
-
- </body>
-</document>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-core/src/site/manual/index.md
----------------------------------------------------------------------
diff --git a/log4j-core/src/site/manual/index.md b/log4j-core/src/site/manual/index.md
new file mode 100644
index 0000000..7595a08
--- /dev/null
+++ b/log4j-core/src/site/manual/index.md
@@ -0,0 +1,33 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j 2 Implementation
+
+The Log4j 2 implementation provides the functional components of the logging system.
+Users are free to create their own plugins and include them in the logging configuration.
+
+## Requirements
+
+As of version 2.4, Log4j 2 requires Java 7. Versions 2.3 and earlier require Java 6.
+Some features may require optional
+[dependencies](../runtime-dependencies.html). These dependencies are specified in the
+documentation for those features.
+
+Some Log4j features require external dependencies.
+See the [Dependency Tree](dependencies.html#Dependency_Tree)
+for the exact list of JAR files needed for these features.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-core/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-core/src/site/xdoc/index.xml b/log4j-core/src/site/xdoc/index.xml
deleted file mode 100644
index 76f02c2..0000000
--- a/log4j-core/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,48 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 Implementation</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Log4j 2 Implementation">
- <p>
- The Log4j 2 implementation provides the functional components of the logging system.
- Users are free to create their own plugins and include them in the logging configuration.
- </p>
- </section>
-
- <section name="Requirements">
- <p>
- As of version 2.4, Log4j 2 requires Java 7. Versions 2.3 and earlier require Java 6.
- Some features may require optional
- <a href="../runtime-dependencies.html">dependencies</a>. These dependencies are specified in the
- documentation for those features.
- </p>
- <p>
- Some Log4j features require external dependencies.
- See the <a href="dependencies.html#Dependency_Tree">Dependency Tree</a>
- for the exact list of JAR files needed for these features.
- </p>
- </section>
-
- </body>
-</document>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-flume-ng/src/site/markdown/index.md.vm
----------------------------------------------------------------------
diff --git a/log4j-flume-ng/src/site/markdown/index.md.vm b/log4j-flume-ng/src/site/markdown/index.md.vm
new file mode 100644
index 0000000..1652d86
--- /dev/null
+++ b/log4j-flume-ng/src/site/markdown/index.md.vm
@@ -0,0 +1,233 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+#set($dollar = '$')
+#set($h1='#')
+#set($h2='##')
+
+$h1 Flume Appender
+
+The Flume Appender allows applications to send events to Flume Agents.
+
+$h2 Remote Agent
+
+Including the Log4j flume-ng jar in your Maven-based project as a dependency should cause all the
+transitive dependencies necessary for the remote Agent to function to be included.
+
+$h2 Persistent Agent
+
+The persistent agent uses Berkeley DB. The following dependency should be added to your pom.xml
+in addition to the log4j-flume-ng dependency.
+
+<!-- TODO: use variables for dependency versions -->
+```
+ <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>
+```
+
+$h2 Embedded Agent
+
+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.
+
+```
+<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>${Log4jReleaseVersion}</log4j.version>
+ <slf4j.version>${slf4jVersion}</slf4j.version>
+ <jackson.version>${jackson1Version}</jackson.version>
+ </properties>
+
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-api</artifactId>
+ <version>${dollar}{slf4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-ext</artifactId>
+ <version>${dollar}{slf4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-api</artifactId>
+ <version>${dollar}{log4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-1.2-api</artifactId>
+ <version>${dollar}{log4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-core</artifactId>
+ <version>${dollar}{log4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-flume-ng</artifactId>
+ <version>${dollar}{log4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-slf4j-impl</artifactId>
+ <version>${dollar}{log4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.logging.log4j</groupId>
+ <artifactId>log4j-jcl</artifactId>
+ <version>${dollar}{log4j.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.codehaus.jackson</groupId>
+ <artifactId>jackson-core-asl</artifactId>
+ <version>${dollar}{jackson.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.codehaus.jackson</groupId>
+ <artifactId>jackson-mapper-asl</artifactId>
+ <version>${dollar}{jackson.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.codehaus.jackson</groupId>
+ <artifactId>jackson-jaxrs</artifactId>
+ <version>${dollar}{jackson.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.codehaus.jackson</groupId>
+ <artifactId>jackson-xc</artifactId>
+ <version>${dollar}{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>
+```
+
+$h2 Requirements
+The Flume Appender requires the Log4J 2 API.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-flume-ng/src/site/xdoc/index.xml.vm
----------------------------------------------------------------------
diff --git a/log4j-flume-ng/src/site/xdoc/index.xml.vm b/log4j-flume-ng/src/site/xdoc/index.xml.vm
deleted file mode 100644
index f8c9a2f..0000000
--- a/log4j-flume-ng/src/site/xdoc/index.xml.vm
+++ /dev/null
@@ -1,245 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-#set($dollar = '$')
-<document>
- <properties>
- <title>Flume Appender</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Flume Appender">
-
- <p>
- The Flume Appender allows applications to send events to Flume Agents.
- </p>
- <subsection name="Remote Agent">
- <p>
- Including the Log4j flume-ng jar in your Maven-based project as a dependency should cause all the
- transitive dependencies necessary for the remote Agent to function to be included.
- </p>
- </subsection>
- <subsection name="Persistent Agent">
- <p>
- 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>
- <!-- TODO: use variables for dependency versions -->
- <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">
- <p>
- 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>
- <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>${Log4jReleaseVersion}</log4j.version>
- <slf4j.version>${slf4jVersion}</slf4j.version>
- <jackson.version>${jackson1Version}</jackson.version>
- </properties>
-
- <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-api</artifactId>
- <version>${dollar}{slf4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.slf4j</groupId>
- <artifactId>slf4j-ext</artifactId>
- <version>${dollar}{slf4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-api</artifactId>
- <version>${dollar}{log4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-1.2-api</artifactId>
- <version>${dollar}{log4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-core</artifactId>
- <version>${dollar}{log4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-flume-ng</artifactId>
- <version>${dollar}{log4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-slf4j-impl</artifactId>
- <version>${dollar}{log4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.apache.logging.log4j</groupId>
- <artifactId>log4j-jcl</artifactId>
- <version>${dollar}{log4j.version}</version>
- </dependency>
- <dependency>
- <groupId>org.codehaus.jackson</groupId>
- <artifactId>jackson-core-asl</artifactId>
- <version>${dollar}{jackson.version}</version>
- </dependency>
- <dependency>
- <groupId>org.codehaus.jackson</groupId>
- <artifactId>jackson-mapper-asl</artifactId>
- <version>${dollar}{jackson.version}</version>
- </dependency>
- <dependency>
- <groupId>org.codehaus.jackson</groupId>
- <artifactId>jackson-jaxrs</artifactId>
- <version>${dollar}{jackson.version}</version>
- </dependency>
- <dependency>
- <groupId>org.codehaus.jackson</groupId>
- <artifactId>jackson-xc</artifactId>
- <version>${dollar}{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>
-
- <section name="Requirements">
- <p>
- The Flume Appender requires the Log4J 2 API.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-jcl/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-jcl/src/site/markdown/index.md b/log4j-jcl/src/site/markdown/index.md
new file mode 100644
index 0000000..d7f302a
--- /dev/null
+++ b/log4j-jcl/src/site/markdown/index.md
@@ -0,0 +1,33 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Commons Logging Bridge
+
+The Commons Logging Bridge allows applications coded to the Commons Logging API to use
+Log4j 2 as the implementation.
+
+## Requirements
+
+The Commons Logging Bridge is dependent on the Log4j 2 API and Commons Logging.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+Using the Commons Logging Bridge is straightforward. Simply add the bridge jar along with
+the other Log4j 2 jars and the Commons Logging jar, and all logging done using the
+Commons Logging API will be routed to Log4j.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-jcl/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-jcl/src/site/xdoc/index.xml b/log4j-jcl/src/site/xdoc/index.xml
deleted file mode 100644
index c9b5932..0000000
--- a/log4j-jcl/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,52 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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>Commons Logging Bridge</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Commons Logging Bridge">
-
- <p>
- The Commons Logging Bridge allows applications coded to the Commons Logging API to use
- Log4j 2 as the implementation.
- </p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The Commons Logging Bridge is dependent on the Log4j 2 API
- and Commons Logging.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- <section name="Usage">
- <p>
- Using the Commons Logging Bridge is straightforward. Simply add the bridge jar along with
- the other Log4j 2 jars and the Commons Logging jar, and all logging done using the
- Commons Logging API will be routed to Log4j.
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-jmx-gui/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-jmx-gui/src/site/markdown/index.md b/log4j-jmx-gui/src/site/markdown/index.md
new file mode 100644
index 0000000..feb08cc
--- /dev/null
+++ b/log4j-jmx-gui/src/site/markdown/index.md
@@ -0,0 +1,33 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j JMX GUI
+
+JMX GUI provides a Swing-based client for remotely editing the log4j configuration
+and remotely monitoring StatusLogger output.
+
+The JMX GUI can be run as a stand-alone application or as a JConsole plug-in.
+
+## Requirements
+
+The JMX GUI is dependent on Log4j 2 Core.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+See the [JMX manual](../manual/jmx.html#ClientGUI) page for details.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-jmx-gui/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-jmx-gui/src/site/xdoc/index.xml b/log4j-jmx-gui/src/site/xdoc/index.xml
deleted file mode 100644
index 1497df2..0000000
--- a/log4j-jmx-gui/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,50 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 JMX GUI</title>
- <author email="rpopma@apache.org">Remko Popma</author>
- </properties>
-
- <body>
- <section name="Log4j JMX GUI">
-
- <p>
- JMX GUI provides a Swing-based client for remotely editing the log4j configuration
- and remotely monitoring StatusLogger output.
- </p>
- <p>The JMX GUI can be run as a stand-alone application or as a JConsole plug-in.</p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The JMX GUI is dependent on Log4j 2 Core.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- <section name="Usage">
- <p>
- See the <a href="../manual/jmx.html#ClientGUI">JMX manual</a> page for details.
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-jul/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-jul/src/site/markdown/index.md b/log4j-jul/src/site/markdown/index.md
new file mode 100644
index 0000000..80dd6c2
--- /dev/null
+++ b/log4j-jul/src/site/markdown/index.md
@@ -0,0 +1,76 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j JDK Logging Adapter
+
+The JDK Logging Adapter is a custom implementation of
+[`java.util.logging.LogManager`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/LogManager.html)
+that uses [Log4j](../log4j-core/index.html). This adapter can be used with either the Log4j API or
+Log4j Core. When used with the API, there are a couple features of JUL that aren't supported. However, this
+does allow any other Log4j Provider besides the Core provider to be used with JUL.
+
+## Requirements
+
+The JDK Logging Adapter is dependent on the Log4j API and optionally Log4j Core.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+To use the JDK Logging Adapter, you must set the system property `java.util.logging.manager` to
+[`org.apache.logging.log4j.jul.LogManager`](apidocs/org/apache/logging/log4j/jul/LogManager.html)
+
+This must be done either through the command line (i.e., using the
+`-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager` argument) or by using
+`System.setProperty()` before any calls are made to `LogManager` or `Logger`.
+
+## Compatibility
+
+The use of a
+[`java.util.logging.Filter`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Filter.html)
+is supported on a per-[`Logger`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Logger.html)
+basis. However, it is recommended to use the standard [Filters](../manual/filters.html) feature in
+Log4j instead.
+
+The use of
+[`java.util.logging.Handler`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Handler.html)
+classes is _NOT_ supported. Custom Handlers should instead use an appropriate
+[Appender](../manual/appenders.html) or code their own
+[`Appender`](../log4j-core/apidocs/org/apache/logging/log4j/core/Appender.html)
+plugin.
+
+Java logging levels are translated into Log4j logging levels dynamically. The following table lists the
+conversions between a Java logging level and its equivalent Log4j level. Custom levels should be implemented
+as an implementation of
+[`LevelConverter`](apidocs/org/apache/logging/log4j/jul/LevelConverter.html), and the
+Log4j property `log4j.jul.levelConverter` must be set to your custom class name. Using the default
+`LevelConverter` implementation, custom logging levels are mapped to whatever the current level of
+the `Logger` being logged to is using.
+
+### Default Level Conversions
+
+Java Level | Log4j Level
+---------- | -----------
+[`OFF`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#OFF) | `OFF`
+[`SEVERE`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#SEVERE) | `ERROR`
+[`WARNING`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#WARNING) | `WARN`
+[`INFO`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#INFO) | `INFO`
+[`CONFIG`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#CONFIG) | [`CONFIG`](apidocs/org/apache/logging/log4j/jul/LevelTranslator.html#CONFIG)
+[`FINE`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINE) | `DEBUG`
+[`FINER`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINER) | `TRACE`
+[`FINEST`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINEST) | [`FINEST`](apidocs/org/apache/logging/log4j/jul/LevelTranslator.html#FINEST)
+[`ALL`](http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#ALL) | `ALL`
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-jul/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-jul/src/site/xdoc/index.xml b/log4j-jul/src/site/xdoc/index.xml
deleted file mode 100644
index 955a44e..0000000
--- a/log4j-jul/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,127 +0,0 @@
-<?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>Log4j JDK Logging Adapter</title>
- <author email="mattsicker@apache.org">Matt Sicker</author>
- </properties>
- <body>
- <section name="JDK Logging Adapter">
- <p>
- The JDK Logging Adapter is a custom implementation of
- <a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/LogManager.html">java.util.logging.LogManager</a>
- that uses <a href="../log4j-core/index.html">Log4j</a>. This adapter can be used with either the Log4j API or
- Log4j Core. When used with the API, there are a couple features of JUL that aren't supported. However, this
- does allow any other Log4j Provider besides the Core provider to be used with JUL.
- </p>
- </section>
- <section name="Requirements">
- <p>
- The JDK Logging Adapter is dependent on the Log4j API and optionally Log4j Core.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
- <section name="Usage">
- <p>
- To use the JDK Logging Adapter, you must set the system property <code>java.util.logging.manager</code> to
- <a class="javadoc" href="apidocs/org/apache/logging/log4j/jul/LogManager.html">org.apache.logging.log4j.jul.LogManager</a>
- </p>
- <p>
- This must be done either through the command line (i.e., using the
- <code>-Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager</code> argument) or by using
- <code>System.setProperty()</code> before any calls are made to <code>LogManager</code> or <code>Logger</code>.
- </p>
- </section>
- <section name="Compatibility">
- <p>
- The use of a
- <a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Filter.html">java.util.logging.Filter</a>
- is supported on a per-<a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Logger.html">Logger</a>
- basis. However, it is recommended to use the standard <a href="../manual/filters.html">Filters</a> feature in
- Log4j instead.
- </p>
- <p>
- The use of
- <a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Handler.html">java.util.logging.Handler</a>
- classes is <em>NOT</em> supported. Custom Handlers should instead use an appropriate
- <a href="../manual/appenders.html">Appender</a> or code their own
- <a class="javadoc" href="../log4j-core/apidocs/org/apache/logging/log4j/core/Appender.html">Appender</a>
- plugin.
- </p>
- <p>
- Java logging levels are translated into Log4j logging levels dynamically. The following table lists the
- conversions between a Java logging level and its equivalent Log4j level. Custom levels should be implemented
- as an implementation of
- <a class="javadoc" href="apidocs/org/apache/logging/log4j/jul/LevelConverter.html">LevelConverter</a>, and the
- Log4j property <kbd>log4j.jul.levelConverter</kbd> must be set to your custom class name. Using the default
- <code>LevelConverter</code> implementation, custom logging levels are mapped to whatever the current level of
- the <code>Logger</code> being logged to is using.
- </p>
- <table>
- <caption>Default Level conversions</caption>
- <thead>
- <tr>
- <th>Java Level</th>
- <th>Log4j Level</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#OFF">OFF</a></td>
- <td>OFF</td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#SEVERE">SEVERE</a></td>
- <td>ERROR</td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#WARNING">WARNING</a></td>
- <td>WARN</td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#INFO">INFO</a></td>
- <td>INFO</td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#CONFIG">CONFIG</a></td>
- <td><a class="javadoc" href="apidocs/org/apache/logging/log4j/jul/LevelTranslator.html#CONFIG">CONFIG</a></td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINE">FINE</a></td>
- <td>DEBUG</td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINER">FINER</a></td>
- <td>TRACE</td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#FINEST">FINEST</a></td>
- <td><a class="javadoc" href="apidocs/org/apache/logging/log4j/jul/LevelTranslator.html#FINEST">FINEST</a></td>
- </tr>
- <tr>
- <td><a class="javadoc" href="http://docs.oracle.com/javase/6/docs/api/java/util/logging/Level.html#ALL">ALL</a></td>
- <td>ALL</td>
- </tr>
- </tbody>
- </table>
- </section>
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-liquibase/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-liquibase/src/site/markdown/index.md b/log4j-liquibase/src/site/markdown/index.md
new file mode 100644
index 0000000..f074e5b
--- /dev/null
+++ b/log4j-liquibase/src/site/markdown/index.md
@@ -0,0 +1,31 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j 2 Liquibase Binding
+
+The Log4j 2 Liquibase Binding enables [Liquibase](http://www.liquibase.org/) to log via Log4j 2.
+
+## Requirements
+
+The Log4j 2 Liquibase Binding has a dependency on the Log4j 2 API as well as the Liquibase core.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+Including this module will automatically make Liquibase log via Log4j 2, due the the plugin auto discovery mechanism of
+Liquibase.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-liquibase/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-liquibase/src/site/xdoc/index.xml b/log4j-liquibase/src/site/xdoc/index.xml
deleted file mode 100644
index 3b6d3c6..0000000
--- a/log4j-liquibase/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,49 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 Liquibase Binding</title>
- <author email="mikael@staldal.nu">Mikael St\ufffdldal</author>
- </properties>
-
- <body>
- <section name="Log4j 2 Liquibase Binding">
-
- <p>
- The Log4j 2 Liquibase Binding enables <a href="http://www.liquibase.org/">Liquibase</a> to log via Log4j 2.
- </p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The Log4j 2 Liquibase Binding has a dependency
- on the Log4j 2 API as well as the Liquibase core.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- <section name="Usage">
- <p>
- Including this module will automatically make Liquibase log via Log4j 2, due the the plugin auto discovery mechanism of Liquibase.
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-nosql/src/site/markdown/index.md.vm
----------------------------------------------------------------------
diff --git a/log4j-nosql/src/site/markdown/index.md.vm b/log4j-nosql/src/site/markdown/index.md.vm
new file mode 100644
index 0000000..09076a0
--- /dev/null
+++ b/log4j-nosql/src/site/markdown/index.md.vm
@@ -0,0 +1,79 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+#set($h1='#')
+#set($h2='##')
+## TODO: use properties for dynamic dependency versions
+
+$h1 NoSQL Appenders
+
+The NoSQL Appenders allow applications to send events to NoSQL repositories.
+To use it, you need both the `log4j-nosql` as well as the appropriate
+driver for your NoSQL database type.
+
+$h2 CouchDB
+
+[Apache CouchDB](https://couchdb.apache.org/) is supported through the
+[LightCouch](http://www.lightcouch.org/) driver.
+
+```
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.lightcouch</groupId>
+ <artifactId>lightcouch</artifactId>
+ <version>0.0.6</version>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.lightcouch</groupId>
+ <artifactId>lightcouch</artifactId>
+ </dependency>
+ </dependencies>
+```
+
+$h2 MongoDB
+
+[MongoDB](http://www.mongodb.org/) is supported through the
+[Java MongoDB Driver](http://docs.mongodb.org/ecosystem/drivers/java/).
+
+```
+ <dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.mongodb</groupId>
+ <artifactId>mongo-java-driver</artifactId>
+ <version>2.12.3</version>
+ </dependency>
+ </dependencies>
+ </dependencyManagement>
+ <dependencies>
+ <dependency>
+ <groupId>org.mongodb</groupId>
+ <artifactId>mongo-java-driver</artifactId>
+ </dependency>
+ </dependencies>
+```
+
+## TODO: Cassandra dependencies (already mentioned in runtime-dependencies.html)
+
+$h2 Requirements
+
+The NoSQL Appenders is dependent on the Log4j 2 API and implementation.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-nosql/src/site/xdoc/index.xml.vm
----------------------------------------------------------------------
diff --git a/log4j-nosql/src/site/xdoc/index.xml.vm b/log4j-nosql/src/site/xdoc/index.xml.vm
deleted file mode 100644
index 6b63b12..0000000
--- a/log4j-nosql/src/site/xdoc/index.xml.vm
+++ /dev/null
@@ -1,86 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<!-- TODO: use properties for dynamic dependency versions -->
-<document>
- <properties>
- <title>NoSQL Appenders</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="NoSQL Appenders">
-
- <p>
- The NoSQL Appenders allow applications to send events to NoSQL repositories.
- To use it, you need both the <code>log4j-nosql</code> as well as the appropriate
- driver for your NoSQL database type.
- </p>
- <subsection name="CouchDB">
- <p>
- <a href="https://couchdb.apache.org/">Apache CouchDB</a> is supported through the
- <a href="http://www.lightcouch.org/">LightCouch</a> driver.
- </p>
- <pre class="prettyprint linenums"><![CDATA[ <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.lightcouch</groupId>
- <artifactId>lightcouch</artifactId>
- <version>0.0.6</version>
- </dependency>
- </dependencies>
- </dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.lightcouch</groupId>
- <artifactId>lightcouch</artifactId>
- </dependency>
- </dependencies>]]></pre>
- </subsection>
- <subsection name="MongoDB">
- <p>
- <a href="http://www.mongodb.org/">MongoDB</a> is supported through the
- <a href="http://docs.mongodb.org/ecosystem/drivers/java/">Java MongoDB Driver</a>.
- </p>
- <pre class="prettyprint linenums"><![CDATA[ <dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.mongodb</groupId>
- <artifactId>mongo-java-driver</artifactId>
- <version>2.12.3</version>
- </dependency>
- </dependencies>
- </dependencyManagement>
- <dependencies>
- <dependency>
- <groupId>org.mongodb</groupId>
- <artifactId>mongo-java-driver</artifactId>
- </dependency>
- </dependencies>]]></pre>
- </subsection>
-
- </section>
-
- <section name="Requirements">
- <p>
- The NoSQL Appenders is dependent on the Log4j 2 API and implementation.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-slf4j-impl/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-slf4j-impl/src/site/markdown/index.md b/log4j-slf4j-impl/src/site/markdown/index.md
new file mode 100644
index 0000000..6e3f3f6
--- /dev/null
+++ b/log4j-slf4j-impl/src/site/markdown/index.md
@@ -0,0 +1,40 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j 2 SLF4J Binding
+
+The Log4j 2 SLF4J Binding allows applications coded to the SLF4J API to use
+Log4j 2 as the implementation.
+
+## Requirements
+
+The Log4j 2 SLF4J Binding has a dependency on the Log4j 2 API as well as the SLF4J API.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+The SLF4J binding provided in this component cause all the SLF4J APIs to be routed to Log4j 2. Simply
+include the Log4j 2 SLF4J Binding jar along with the Log4j 2 jars and SLF4J API jar to cause all SLF4J
+logging to be handled by Log4j 2.
+
+<div class="alert alert-danger">
+Use of the Log4j 2 SLF4J Binding (log4j-slf4j-impl-2.0.jar) together with
+the SLF4J adapter (log4j-to-slf4j-2.0.jar) should
+never be attempted, as it will cause events to endlessly be routed between
+SLF4J and Log4j 2.
+</div>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-slf4j-impl/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-slf4j-impl/src/site/xdoc/index.xml b/log4j-slf4j-impl/src/site/xdoc/index.xml
deleted file mode 100644
index d875368..0000000
--- a/log4j-slf4j-impl/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,58 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 SLF4J Binding</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Log4j 2 SLF4J Binding">
-
- <p>
- The Log4j 2 SLF4J Binding allows applications coded to the SLF4J API to use
- Log4j 2 as the implementation.
- </p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The Log4j 2 SLF4J Binding has a dependency
- on the Log4j 2 API as well as the SLF4J API.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- <section name="Usage">
- <p>
- The SLF4J binding provided in this component cause all the SLF4J APIs to be routed to Log4j 2. Simply
- include the Log4j 2 SLF4J Binding jar along with the Log4j 2 jars and SLF4J API jar to cause all SLF4J
- logging to be handled by Log4j 2.
- </p>
- <p>
- <b><em>Use of the Log4j 2 SLF4J Binding (log4j-slf4j-impl-2.0.jar) together with
- the SLF4J adapter (log4j-to-slf4j-2.0.jar) should
- never be attempted, as it will cause events to endlessly be routed between
- SLF4J and Log4j 2.</em></b>
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-taglib/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-taglib/src/site/markdown/index.md b/log4j-taglib/src/site/markdown/index.md
new file mode 100644
index 0000000..ea7174a
--- /dev/null
+++ b/log4j-taglib/src/site/markdown/index.md
@@ -0,0 +1,70 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j Tag Library
+
+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.
+
+This tag library is based on the
+[Jakarta Commons Log Taglib](http://jakarta.apache.org/taglibs/log/) by Joseph Ottinger and James
+Strachan. For the most part, logging tags written against Jakarta Commons Log Taglib should
+work against this library as well. However, the "category" attribute from Jakarta has become
+the "logger" attribute in this library.
+
+## Requirements
+
+The Log4j Tag Library requires at least Servlet 2.5 (or Java EE 5), at least
+JSP 2.1 (or Java EE 5), and is dependent on the Log4j 2 API.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+<span class="label label-important">Important Note!</span>
+For performance reasons, containers often ignore certain JARs known not to
+contain TLDs and do not scan them for TLD files. Importantly, Tomcat 7 <7.0.43 ignores all JAR files named
+log4j*.jar, which prevents the JSP tag library from being automatically discovered. This does not affect
+Tomcat 6.x and has been fixed in Tomcat 7.0.43, Tomcat 8, and later. In Tomcat 7 <7.0.43 you
+will need to change `catalina.properties` and remove "log4j*.jar" from the `jarsToSkip`
+property. You may need to do something similar on other containers if they skip scanning Log4j JAR files.
+
+## Usage
+In accordance with the [Logger](../log4j-api/apidocs/org/apache/logging/log4j/Logger.html)
+API, this tag library has tags to
+support the following logging calls: "catching", "entry", "exit", "log", "trace", "debug",
+"info", "warn", "error", and "fatal". The "trace" tag was not supported in Jakarta Commons Log
+Taglib. The "setLogger", "catching", "entry", and "trace" tags are new to this library. This
+tag library also supports the conditional tag "ifEnabled" (new) and troubleshooting tag "dump"
+(existed in Jakarta Commons Log Taglib).
+
+By default, this tag library uses a different Logger for each JSP named after the JSP ID.
+You can customize the Logger in any of the logging tags or the "ifEnabled" tag with the
+"logger" attribute. You can also use the "setLogger" tag to specify the Logger that should apply
+for the rest of a JSP's execution. If the "setLogger" tag comes before any other logging tags in
+a JSP, the default Logger for that JSP will not be created, but instead the specified logger is
+the only one that will be used.
+
+Every effort was made to optimize these tags and ensure decent performance, but users of
+this library should keep in mind that the creation and execution of JSP tags adds significant
+overhead to the standard Log4j method calls. While the "trace", "debug", and "info" options are
+available in this library, their uses are not nano-second order of magnitude with logging off
+that users may be used to with standard Log4j method calls. Therefore, they should be used
+sparingly. Use of the "ifEnabled" tag does not improve this performance; this tag is available
+to conditionally evaluate other actions in addition to logging actions.
+
+For detailed documentation of each tag, see the [Tag Library Reference](tagreference.html) or the
+[TLDDoc Documentation](tlddoc/index.html).
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-taglib/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-taglib/src/site/xdoc/index.xml b/log4j-taglib/src/site/xdoc/index.xml
deleted file mode 100644
index 2abd3d3..0000000
--- a/log4j-taglib/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,84 +0,0 @@
-<?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 Tag Library</title>
- <author email="nickwilliams@apache.org">Nick Williams</author>
- </properties>
-
- <body>
- <section name="Log4j Tag Library">
-
- <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>
-
- <p>This tag library is based on the
- <a href="http://jakarta.apache.org/taglibs/log/">Jakarta Commons Log Taglib</a> by Joseph Ottinger and James
- Strachan. For the most part, logging tags written against Jakarta Commons Log Taglib should
- work against this library as well. However, the "category" attribute from Jakarta has become
- the "logger" attribute in this library.</p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The Log4j Tag Library requires at least Servlet 2.5 (or Java EE 5), at least
- JSP 2.1 (or Java EE 5), and is dependent on the Log4j 2 API.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- <p>
- <b><em>Important Note!</em></b> For performance reasons, containers often ignore certain JARs known not to
- contain TLDs and do not scan them for TLD files. Importantly, Tomcat 7 <7.0.43 ignores all JAR files named
- log4j*.jar, which prevents the JSP tag library from being automatically discovered. This does not affect
- Tomcat 6.x and has been fixed in Tomcat 7.0.43, Tomcat 8, and later. In Tomcat 7 <7.0.43 you
- will need to change <code>catalina.properties</code> and remove "log4j*.jar" from the <code>jarsToSkip</code>
- property. You may need to do something similar on other containers if they skip scanning Log4j JAR files.
- </p>
- </section>
-
- <section name="Usage">
- <p>In accordance with the <a href="../log4j-api/apidocs/org/apache/logging/log4j/Logger.html">Logger</a>
- API, this tag library has tags to
- support the following logging calls: "catching", "entry", "exit", "log", "trace", "debug",
- "info", "warn", "error", and "fatal". The "trace" tag was not supported in Jakarta Commons Log
- Taglib. The "setLogger", "catching", "entry", and "trace" tags are new to this library. This
- tag library also supports the conditional tag "ifEnabled" (new) and troubleshooting tag "dump"
- (existed in Jakarta Commons Log Taglib).</p>
-
- <p>By default, this tag library uses a different Logger for each JSP named after the JSP ID.
- You can customize the Logger in any of the logging tags or the "ifEnabled" tag with the
- "logger" attribute. You can also use the "setLogger" tag to specify the Logger that should apply
- for the rest of a JSP's execution. If the "setLogger" tag comes before any other logging tags in
- a JSP, the default Logger for that JSP will not be created, but instead the specified logger is
- the only one that will be used.</p>
-
- <p>Every effort was made to optimize these tags and ensure decent performance, but users of
- this library should keep in mind that the creation and execution of JSP tags adds significant
- overhead to the standard Log4j method calls. While the "trace", "debug", and "info" options are
- available in this library, their uses are not nano-second order of magnitude with logging off
- that users may be used to with standard Log4j method calls. Therefore, they should be used
- sparingly. Use of the "ifEnabled" tag does not improve this performance; this tag is available
- to conditionally evaluate other actions in addition to logging actions.</p>
-
- <p>For detailed documentation of each tag, see the <a href="tagreference.html">Tag Library Reference</a> or the
- <a href="tlddoc/index.html">TLDDoc Documentation</a>.</p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-to-slf4j/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-to-slf4j/src/site/markdown/index.md b/log4j-to-slf4j/src/site/markdown/index.md
new file mode 100644
index 0000000..34027e7
--- /dev/null
+++ b/log4j-to-slf4j/src/site/markdown/index.md
@@ -0,0 +1,41 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+
+# Log4j to SLF4J Adapter
+
+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. With Log4j 2 as the implementation these would normally be
+formatted only when they are accessed by a Filter or Appender.
+
+## Requirements
+
+The Log4j 2 to SLF4J adapter is dependent on the Log4j 2 API and the SLF4J API.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
+
+## Usage
+
+Include this jar, the SLF4J jar(s) and an SLF4J logging implementation jar together. Configure
+the logging implementation as required.
+
+<div class="alert alert-danger">
+Use of the SLF4J adapter (log4j-to-slf4j-2.x.jar) together with
+the SLF4J bridge (log4j-slf4j-impl-2.x.jar) should
+never be attempted as it will cause events to endlessly be routed between
+SLF4J and Log4j 2.
+</div>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-to-slf4j/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-to-slf4j/src/site/xdoc/index.xml b/log4j-to-slf4j/src/site/xdoc/index.xml
deleted file mode 100644
index 13bbcc9..0000000
--- a/log4j-to-slf4j/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,58 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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 to SLF4J Adapter</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Log4j 2 to SLF4J Adapter">
-
- <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. With Log4j 2 as the implementation these would normally be
- formatted only when they are accessed by a Filter or Appender.
- </p>
-
- </section>
-
- <section name="Requirements">
- <p>
- The Log4j 2 to SLF4J adapter is dependent on the Log4j 2 API and the SLF4J API.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- <section name="Usage">
- <p>
- Include this jar, the SLF4J jar(s) and an SLF4J logging implementation jar together. Configure
- the logging implementation as required.
- </p>
- <p>
- <b><em>Use of the SLF4J adapter (log4j-to-slf4j-2.x.jar) together with
- the SLF4J bridge (log4j-slf4j-impl-2.x.jar) should
- never be attempted as it will cause events to endlessly be routed between
- SLF4J and Log4j 2.</em></b>
- </p>
- </section>
-
- </body>
-</document>
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-web/src/site/markdown/index.md
----------------------------------------------------------------------
diff --git a/log4j-web/src/site/markdown/index.md b/log4j-web/src/site/markdown/index.md
new file mode 100644
index 0000000..9a87a57
--- /dev/null
+++ b/log4j-web/src/site/markdown/index.md
@@ -0,0 +1,30 @@
+<!-- vim: set syn=markdown : -->
+<!--
+ 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.
+-->
+<!-- TODO: turn this into a velocity template for all the version numbers -->
+
+# Web Servlet Containers
+
+The Web module provides support for automatically enabling Log4j in Servlet containers.
+
+See the user manual page on [Web Applications and JSPs](../manual/webapp.html)
+for details on using Log4j 2 in Web Applications.
+
+## Requirements
+
+The Web module requires Servlet 2.5 at minimum and is dependent on the Log4j 2 API and implementation.
+For more information, see [Runtime Dependencies](../runtime-dependencies.html).
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/2f0c6064/log4j-web/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/log4j-web/src/site/xdoc/index.xml b/log4j-web/src/site/xdoc/index.xml
deleted file mode 100644
index 3908d8f..0000000
--- a/log4j-web/src/site/xdoc/index.xml
+++ /dev/null
@@ -1,44 +0,0 @@
-<?xml version="1.0"?>
-<!--
- 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.
--->
-<!-- TODO: turn this into a velocity template for all the version numbers -->
-<document>
- <properties>
- <title>Web Servlet Containers</title>
- <author email="rgoers@apache.org">Ralph Goers</author>
- </properties>
-
- <body>
- <section name="Web Servlet Containers">
- <p>
- The Web module provides support for automatically enabling Log4j in Servlet containers.
- </p>
- <p>
- See the user manual page on <a href="../manual/webapp.html">Web Applications and JSPs</a>
- for details on using Log4j 2 in Web Applications.
- </p>
- </section>
-
- <section name="Requirements">
- <p>
- The Web module requires Servlet 2.5 and is dependent on the Log4j 2 API and implementation.
- For more information, see <a href="../runtime-dependencies.html">Runtime Dependencies</a>.
- </p>
- </section>
-
- </body>
-</document>