logging-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rpo...@apache.org
Subject svn commit: r1617306 - in /logging/log4j/log4j2/trunk: log4j-core/src/site/xdoc/index.xml src/changes/changes.xml src/site/xdoc/faq.xml
Date Mon, 11 Aug 2014 15:19:27 GMT
Author: rpopma
Date: Mon Aug 11 15:19:26 2014
New Revision: 1617306

URL: http://svn.apache.org/r1617306
Log:
LOG4J2-760 Doc improvement: link to Maven-generated dependency tree from log4j-core component
page to make it easier for users to find the exact JARs they need. Also link to log4j-core
component page from FAQ page.

Modified:
    logging/log4j/log4j2/trunk/log4j-core/src/site/xdoc/index.xml
    logging/log4j/log4j2/trunk/src/changes/changes.xml
    logging/log4j/log4j2/trunk/src/site/xdoc/faq.xml

Modified: logging/log4j/log4j2/trunk/log4j-core/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/log4j-core/src/site/xdoc/index.xml?rev=1617306&r1=1617305&r2=1617306&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/log4j-core/src/site/xdoc/index.xml (original)
+++ logging/log4j/log4j2/trunk/log4j-core/src/site/xdoc/index.xml Mon Aug 11 15:19:26 2014
@@ -24,12 +24,10 @@
 
     <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">
@@ -38,6 +36,11 @@
                 <a href="dependencies.html">dependencies</a>. These dependencies
are specified in the
                 documentation for those features.
             </p>
+            <p>
+              Below is a list of Log4j features that 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>
             <ul>
                 <li>JSON configuration requires the Jackson Data Processor.</li>
                 <li>Async Loggers require the LMAX Disruptor.</li>

Modified: logging/log4j/log4j2/trunk/src/changes/changes.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/changes/changes.xml?rev=1617306&r1=1617305&r2=1617306&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/changes/changes.xml (original)
+++ logging/log4j/log4j2/trunk/src/changes/changes.xml Mon Aug 11 15:19:26 2014
@@ -22,6 +22,10 @@
   </properties>
   <body>
     <release version="2.0.2" date="2014-0?-??" description="Bug fixes and enhancements">
+      <action issue="LOG4J2-760" dev="rpopma" type="fix">
+        Documentation improvement: link to dependency tree from log4j-core component page,
+        link to log4j-component page from FAQ page.
+      </action>
       <action issue="LOG4J2-679" dev="rpopma" type="fix">
         Resolved race condition that caused log file rotation to fail with error: "Unable
to create directory ..."
       </action>

Modified: logging/log4j/log4j2/trunk/src/site/xdoc/faq.xml
URL: http://svn.apache.org/viewvc/logging/log4j/log4j2/trunk/src/site/xdoc/faq.xml?rev=1617306&r1=1617305&r2=1617306&view=diff
==============================================================================
--- logging/log4j/log4j2/trunk/src/site/xdoc/faq.xml (original)
+++ logging/log4j/log4j2/trunk/src/site/xdoc/faq.xml Mon Aug 11 15:19:26 2014
@@ -45,7 +45,11 @@
         <p>You can use the log4j-to-slf4j adapter jar when your application calls the
Log4j 2 API and you
         want to route logging calls to a SLF4J implementation.</p>
         <p><img src="images/whichjar-slf4j.png" alt="Diagram showing the dependency
flow to use Log4j 2 API with SLF4J" /></p>
-
+        <p>Some of the Log4j components have features with optional dependencies.
+          The component page will have more detail.
+          For example, the <a href="log4j-core/index.html">log4j-core component page</a>
+          has an outline of which log4j-core features have external dependencies.</p>
+        
 		<a name="config_location" />
         <h4>How do I specify the configuration file location?</h4>
         <p>By default, Log4j looks for a configuration file named <b>log4j2.xml</b>
(not log4j.xml) in the classpath.



Mime
View raw message