You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ki...@apache.org on 2018/08/25 10:40:59 UTC

[12/14] commons-imaging git commit: IMAGING-103: add information about logging (IMAGING-154) and remove stale information

IMAGING-103: add information about logging (IMAGING-154) and remove stale information


Project: http://git-wip-us.apache.org/repos/asf/commons-imaging/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-imaging/commit/d2e50af5
Tree: http://git-wip-us.apache.org/repos/asf/commons-imaging/tree/d2e50af5
Diff: http://git-wip-us.apache.org/repos/asf/commons-imaging/diff/d2e50af5

Branch: refs/heads/master
Commit: d2e50af54ee89daae5907a3388cc6c83b10b2a74
Parents: d403648
Author: Bruno P. Kinoshita <ki...@apache.org>
Authored: Sat Aug 25 22:23:39 2018 +1200
Committer: Bruno P. Kinoshita <ki...@apache.org>
Committed: Sat Aug 25 22:23:39 2018 +1200

----------------------------------------------------------------------
 src/site/xdoc/gettingstarted.xml | 22 ++++++++++++---
 src/site/xdoc/index.xml          | 53 +----------------------------------
 2 files changed, 19 insertions(+), 56 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-imaging/blob/d2e50af5/src/site/xdoc/gettingstarted.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/gettingstarted.xml b/src/site/xdoc/gettingstarted.xml
index f0fe615..7cc4333 100644
--- a/src/site/xdoc/gettingstarted.xml
+++ b/src/site/xdoc/gettingstarted.xml
@@ -24,12 +24,9 @@ limitations under the License.
 <!-- ================================================== -->
 <section name="Requirements">
 
-  <strong>Outdated:</strong> This page contains information which is not up to date. Help making this page more useful
-  by contributing a patch.
-
 <p>
   <ul>
-      <li>Commons Imaging requires Java 1.5 or higher.</li>
+      <li>Commons Imaging requires Java 1.7 or higher.</li>
       <li>The questions of porting to J2ME and Android have been raised, but not yet pursued.</li>
       <li>Commons Imaging has no dependencies.</li>
       <li>AWT is required. ImageIO is only required to compile and used optionally
@@ -74,5 +71,22 @@ limitations under the License.
 </p>
 </section>
 
+<section name="Logging">
+<p>
+  Commons Imaging uses the JDK java.util.logging (JUL) classes for logging. You can find out more about
+  JUL in its <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html">documentation</a>,
+  or reading the <a href="https://docs.oracle.com/javase/8/docs/api/java/util/logging/package-summary.html">logging API documentation</a>.
+</p>
+
+<p>
+  <ul>
+    <li>A more verbose output is available by enabling the log level <strong>FINE</strong></li>
+    <li>Information that is useful for debug and troubleshooting is being logged with the <strong>FINEST</strong> log level</li>
+    <li>Some exceptions that are not re-thrown are being logged with the <strong>SEVERE</strong> log level</li>
+    <li>Commons Imaging loggers are created using the class name, so you should be able to filter the log output with the class or package names</li>
+  </ul>
+</p>
+</section>
+
 </body>
 </document>

http://git-wip-us.apache.org/repos/asf/commons-imaging/blob/d2e50af5/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 001a6f5..93c1df1 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -75,8 +75,7 @@
  <!-- ================================================== -->
  <section name="Release Information">
      <subsection name="Help Needed!">
-       There is currently no stable release of Imaging available, because there are a lot of outstanding issues.
-       If you want to help getting out a release you may:
+       If you want to help out you may:
        <ul>
          <li>Look through the <a href="https://issues.apache.org/jira/issues/?jql=project%20%3D%20IMAGING%20AND%20resolution%20%3D%20Unresolved%20AND%20fixVersion%20%3D%20%22Patch%20Needed%22%20ORDER%20BY%20priority%20DESC">issues waiting for a patch</a></li>
          <li>Look through the <em>Needs Work</em> tags in the <a href="taglist.html">TagList report</a></li>
@@ -85,56 +84,6 @@
        </ul>
        Make sure to read through our <a href="http://commons.apache.org/patches.html">guide lines for contributing patches</a> before you start coding. This will stream line the process of getting your contributions into the code.
      </subsection>
-     <subsection name="Latest Imaging SNAPSHOT">
-         <p>There is currently no stable release of Imaging. You may: </p>
-         <ul>
-             <li>Build Imaging from sources by checking out the source code from the <a href="source-repository.html">SVN repository</a>.</li>
-             <li>Pull the latest snapshot from the Apache snapshot repository</li>
-             <!--<li>Download <a href="download_imaging.cgi">1.0</a></li>-->
-         </ul>
-
-       <p>
-         For pulling the latest snapshot via maven you need to add the Apache snapshot repository to your pom.xml:
-         <pre>
-&lt;repository&gt;
-  &lt;id&gt;apache.snapshots&lt;/id&gt;
-  &lt;name&gt;Apache Development Snapshot Repository&lt;/name&gt;
-  &lt;url&gt;https://repository.apache.org/content/repositories/snapshots/&lt;/url&gt;
-  &lt;releases&gt;
-    &lt;enabled&gt;false&lt;/enabled&gt;
-  &lt;/releases&gt;
-  &lt;snapshots&gt;
-    &lt;enabled&gt;true&lt;/enabled&gt;
-  &lt;/snapshots&gt;
-&lt;/repository&gt;                      
-         </pre>
-         Then you can use the SNAPSHOT version of Commons Imaging in your pom.xml:
-         <pre>
-&lt;dependency&gt;
-  &lt;groupId&gt;org.apache.commons&lt;/groupId&gt;
-  &lt;artifactId&gt;commons-imaging&lt;/artifactId&gt;
-  &lt;version&gt;1.0-SNAPSHOT&lt;/version&gt;
-&lt;/dependency&gt;
-         </pre>
-       </p>
-     </subsection>
-     <subsection name="Final Sanselan Release">
-         <p>The last stable release of Sanselan, before it was renamed to Imaging, was 0.97 You may: </p>
-         <ul>
-             <li>Download <a href="download_sanselan.cgi">0.97</a></li>
-         </ul>
-
-         <p>
-             Alternatively you can pull it from the central Maven repositories:
-             <pre>
-&lt;dependency&gt;
-  &lt;groupId&gt;org.apache.sanselan&lt;/groupId&gt;
-  &lt;artifactId&gt;sanselan&lt;/artifactId&gt;
-  &lt;version&gt;0.97-incubator&lt;/version&gt;
-&lt;/dependency&gt;
-             </pre>
-         </p>
-     </subsection>
 
      <p>
          For information on previous releases see the <a href="release-history.html">Release History</a>, and to download previous releases see the <a href="http://archive.apache.org/dist/commons/sanselan/">Commons Sanselan Archive</a>.