You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by Dennis Lundberg <de...@mdh.se> on 2004/02/15 20:15:12 UTC
[PATCH][logging] Patches for the mavenized website
Here are some patches for the mavenized website. Here's what has been done:
* Corrected spelling and made some clarifications
* Updated the links to Log4J and Avalon LogKit, to their new location
* Includes the navigation-file from the new commons-build directory
* Removed duplicate logo-tag from project.xml
--
Dennis Lundberg
Re: [PATCH][logging] Patches for the mavenized website
Posted by robert burrell donkin <ro...@blueyonder.co.uk>.
committed. many thanks.
you won't see any differences on the main website yet because i'm
trying to refrain from regenerating right now (i'm using a very of
maven that produces a different L&F from the rest).
- robert
On 15 Feb 2004, at 19:15, Dennis Lundberg wrote:
> Here are some patches for the mavenized website. Here's what has been
> done:
> * Corrected spelling and made some clarifications
> * Updated the links to Log4J and Avalon LogKit, to their new location
> * Includes the navigation-file from the new commons-build directory
> * Removed duplicate logo-tag from project.xml
>
> --
> Dennis Lundberg
> Index: project.xml
> ===================================================================
> RCS file: /home/cvspublic/jakarta-commons/logging/project.xml,v
> retrieving revision 1.11
> diff -u -r1.11 project.xml
> --- project.xml 15 Feb 2004 09:38:22 -0000 1.11
> +++ project.xml 15 Feb 2004 19:01:31 -0000
> @@ -4,7 +4,6 @@
> <extend>../commons-build/project.xml</extend>
> <name>Logging</name>
> <id>commons-logging</id>
> - <logo></logo>
> <currentVersion>1.0-dev</currentVersion>
>
> <organization>
> @@ -16,7 +15,7 @@
> <inceptionYear>2001</inceptionYear>
> <shortDescription>Commons Logging</shortDescription>
> <description>
> -Commons Logging is a thin adapter allowing configurable bridging to
> other,
> +Commons Logging is a thin adapter allowing configurable bridging to
> other,
> well known logging systems.
> </description>
>
> @@ -51,7 +50,7 @@
> </developer>
> <developer>
> <name>Scott Sanders</name>
> - <id>sanders</id>
> + <id>sanders</id>
> <email>sanders at apache dot org</email>
> <organization>Apache Software Foundation</organization>
> </developer>
> Index: xdocs/guide.xml
> ===================================================================
> RCS file: /home/cvspublic/jakarta-commons/logging/xdocs/guide.xml,v
> retrieving revision 1.1
> diff -u -r1.1 guide.xml
> --- xdocs/guide.xml 15 Feb 2004 10:28:56 -0000 1.1
> +++ xdocs/guide.xml 15 Feb 2004 19:03:21 -0000
> @@ -13,7 +13,7 @@
> <p>
> The Jakarta Commons Logging (JCL) provides a Log interface that
> is intended to be both light-weight and independent of numerous
> logging toolkits.
> -It provides the middleware/tooling developer a simple
> +It provides the middleware/tooling developer with a simple
> logging abstraction, that allows the user (application developer) to
> plug in
> a specific logging implementation.
> </p>
> @@ -25,8 +25,8 @@
> <p>
> The Jakarta Commons Logging provides a Log interface with
> thin-wrapper implementations for
> other logging tools, including
> -<a href="http://jakarta.apache.org/log4j/docs/index.html">Log4J</a>,
> -<a href="http://jakarta.apache.org/avalon/logkit/index.html">Avalon
> LogKit</a>,
> +<a href="http://logging.apache.org/log4j/docs/index.html">Log4J</a>,
> +<a href="http://avalon.apache.org/logkit/index.html">Avalon
> LogKit</a>,
> and
> <a>JDK 1.4</a>.
> The interface maps closely to Log4J and LogKit.
> @@ -35,7 +35,7 @@
> </section>
> <section name="Users Quick Start">
> <p>
> -As far as possible, <em>Commons-Logging</em> tries to be as
> unobtrusive as possible.
> +As far as possible, <em>Commons-Logging</em> tries to be as
> unobtrusive as possible.
> In most cases, including the (full) <code>commons-logging.jar</code>
> in the classpath
> should result in <em>Commons-Logging</em> configuring itself in a
> reasonable manner.
> There's a good chance that it'll guess your preferred logging system
> and you won't
> @@ -43,10 +43,10 @@
> </p>
> <subsection name='Configuration'>
> <p>
> -There are two base abstractions used by <em>Commons-Logging</em>:
> <code>Log</code>
> +There are two base abstractions used by <em>Commons-Logging</em>:
> <code>Log</code>
> (the basic logger) and <code>LogFactory</code> (which knows how to
> create <code>Log</code>
> -instances). Using <code>LogFactory</code> implementations other than
> the default is a
> -subject for advanced users only, so let's concentrate on configuring
> the default
> +instances). Using <code>LogFactory</code> implementations other than
> the default is a
> +subject for advanced users only, so let's concentrate on configuring
> the default
> implementation.
> </p>
> <p>
> @@ -104,7 +104,7 @@
> </code>
> </ul>
> <p>
> -Note that some components using commons-logging may
> +Note that some components using commons-logging may
> either extend Log,
> or provide a component-specific LogFactory implementation.
> Review the component documentation for guidelines
> @@ -165,7 +165,7 @@
> </ul>
> <subsection name='Best Practices'>
> <p>
> -Best practices for programming/planning are presented in two
> categories:
> +Best practices for programming/planning are presented in two
> categories:
> General and Enterprise.
> The general principles are fairly clear. Enterprise practices are a
> bit more involved
> and it is not always as clear as to why they are important.
> @@ -187,7 +187,7 @@
> that otherwise introduces undesirable runtime overhead
> in the general case (logging disabled).
> Examples are multiple parameters, or expressions (i.e. string + "
> more") for parameters.
> -Use the guard methods of the form
> <code>log.is<<i>Priority</i>>()</code> to verify
> +Use the guard methods of the form
> <code>log.is<<i>Priority</i>>()</code> to verify
> that logging should be performed, before incurring the overhead of
> the logging method call.
> Yes, the logging methods will perform the same check, but only after
> resolving parameters.
> </p>
> @@ -223,7 +223,7 @@
> See also <a HREF="#Internationalization">Internationalization</a>.
> </li>
> <li>
> -<b>debug</b> - detailed information on flow of through the system.
> +<b>debug</b> - detailed information on the flow through the system.
> Expect these to be written to logs only.
> </li>
> <li>
> @@ -246,7 +246,7 @@
> Since any problems that result are going to be assigned to you,
> it's in your best interest to be prepared with the proactive
> tools necessary to demonstrate that your component works correctly,
> -or at worst that the problem analyzed from your logs.
> +or at worst that the problem can be analyzed from your logs.
> For this discussion, we must make a distinction between different
> types of exceptions
> based on what kind of boundaries they cross:
> </p>
> @@ -344,7 +344,7 @@
> </p>
> <p>
> NLS enabled components are particularly appreciated
> -(thats an open-source-correct term for 'required by corporate
> end-users' :-)
> +(that's an open-source-correct term for 'required by corporate
> end-users' :-)
> for <strong>tooling</strong> and <strong>middleware</strong>
> components.
> </p>
> <p>
> @@ -391,7 +391,7 @@
> </p>
> <ul>
> <li>
> -<a href="http://jakarta.apache.org/log4j/docs/index.html">Log4J</a>
> +<a href="http://logging.apache.org/log4j/docs/index.html">Log4J</a>
> </li>
> <li>
> JDK 1.4
> @@ -443,13 +443,13 @@
> Configuration of the behavior of the JCL ultimately depends upon the
> logging toolkit being used.
> The JCL SPI uses
> -<a href="http://jakarta.apache.org/log4j/docs/index.html">Log4J</a>
> +<a href="http://logging.apache.org/log4j/docs/index.html">Log4J</a>
> by default if it is available (in the CLASSPATH).
> </p>
> <subsection name='Log4J'>
> <p>
> As
> -<a href="http://jakarta.apache.org/log4j/docs/index.html">Log4J</a>
> +<a href="http://logging.apache.org/log4j/docs/index.html">Log4J</a>
> is the default logger,
> a <i>few</i> details are presented herein to get the
> developer/integrator going.
> </p>
> @@ -510,14 +510,14 @@
> </section>
> <section name='Frequently Asked Questions'>
> <subsection name='Is JCL Thread Safe?'>
> - <p>
> -JCL doesn't (and cannot) impose any requirement on thread safety on
> the underlying implementation
> -and thus its SPI contract doesn't guarantee thread safety.
> -However, JCL can be safely used a multi-threaded environment
> + <p>
> +JCL doesn't (and cannot) impose any requirement on thread safety on
> the underlying implementation
> +and thus its SPI contract doesn't guarantee thread safety.
> +However, JCL can be safely used in a multi-threaded environment
> as long as the underlying implementation is thread-safe.
> </p>
> <p>
> -It would be very unusual for a logging system to be thread unsafe.
> +It would be very unusual for a logging system to be thread unsafe.
> Certainly, JCL is thread safe when used with the distributed Log
> implementations.
> </p>
> </subsection>
> Index: xdocs/index.xml
> ===================================================================
> RCS file: /home/cvspublic/jakarta-commons/logging/xdocs/index.xml,v
> retrieving revision 1.1
> diff -u -r1.1 index.xml
> --- xdocs/index.xml 15 Feb 2004 10:25:48 -0000 1.1
> +++ xdocs/index.xml 15 Feb 2004 19:03:53 -0000
> @@ -31,7 +31,7 @@
> included in the latest release.</p>
>
> <p>The <a
> href="http://jakarta.apache.org/commons/logging/api/index.html">
> -JavaDoc API documents</a> for the latest release are available online.
> +JavaDoc API documents</a> for the latest release are available online.
> In particular, you should read the package overview of the
> <code>org.apache.commons.logging</code>
> package. In addition, there is a (short)
> <a href="guide.html">User Guide</a>.</p>
> @@ -42,13 +42,13 @@
> <section name="Releases">
> <subsection name='Mirrored Releases'>
> <p>
> -Releases after 1.0.2 should be downloaded from a mirror. Please
> remember to verify the
> -sigature of the release from the
> +Releases after 1.0.2 should be downloaded from a mirror. Please
> remember to verify the
> +signature of the release from the
> <a href='http://www.apache.org/dist/jakarta/commons/logging/'>main
> apache site</a>
> when downloading from a mirror.
> </p>
> <p>
> - Binary releases are available
> + Binary releases are available
> <a href="http://jakarta.apache.org/site/binindex.cgi">here</a>.
> Source releases are available
> <a
> href="http://jakarta.apache.org/site/sourceindex.cgi">here</a>
> Index: xdocs/navigation.xml
> ===================================================================
> RCS file:
> /home/cvspublic/jakarta-commons/logging/xdocs/navigation.xml,v
> retrieving revision 1.1
> diff -u -r1.1 navigation.xml
> --- xdocs/navigation.xml 15 Feb 2004 10:23:21 -0000 1.1
> +++ xdocs/navigation.xml 15 Feb 2004 19:04:37 -0000
> @@ -1,7 +1,7 @@
> <?xml version="1.0" encoding="ISO-8859-1"?>
>
> <!DOCTYPE project [
> -<!ENTITY commons-nav SYSTEM "../../incl_nav.xml">
> +<!ENTITY commons-nav SYSTEM "../../commons-build/incl_nav.xml">
> ]>
>
> <project name="Logging">
> @@ -13,7 +13,7 @@
>
> <body>
> <links>
> - <item name="Jakarta Commons"
> + <item name="Jakarta Commons"
> href="http://jakarta.apache.org/commons/"/>
> </links>
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: commons-dev-help@jakarta.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org