From 4b710c8238b8acd240f43a9097cc223a1a0c0d21 Mon Sep 17 00:00:00 2001 From: "Craig P. Motlin" Date: Sat, 14 Dec 2013 19:01:57 -0500 Subject: [PATCH] Fix typos. --- integration/pom.xml | 4 +-- .../org/apache/commons/logging/package.html | 2 +- .../test/java/org/slf4j/dummyExt/package.html | 2 +- slf4j-migrator/LIMITATIONS.txt | 3 +- slf4j-site/src/site/pages/bug-reporting.html | 2 +- slf4j-site/src/site/pages/codes.html | 7 ++-- slf4j-site/src/site/pages/compatibility.html | 2 +- slf4j-site/src/site/pages/css/site.css | 2 +- slf4j-site/src/site/pages/extensions.html | 18 +++++------ slf4j-site/src/site/pages/faq.html | 32 +++++++++---------- slf4j-site/src/site/pages/legacy.html | 4 +-- slf4j-site/src/site/pages/localization.html | 8 ++--- slf4j-site/src/site/pages/mailing-lists.html | 2 +- slf4j-site/src/site/pages/manual.html | 4 +-- slf4j-site/src/site/pages/migrator.html | 2 +- slf4j-site/src/site/pages/news.html | 10 +++--- 16 files changed, 51 insertions(+), 53 deletions(-) mode change 100644 => 100755 integration/pom.xml mode change 100644 => 100755 jcl-over-slf4j/src/main/java/org/apache/commons/logging/package.html mode change 100644 => 100755 slf4j-ext/src/test/java/org/slf4j/dummyExt/package.html mode change 100644 => 100755 slf4j-migrator/LIMITATIONS.txt mode change 100644 => 100755 slf4j-site/src/site/pages/bug-reporting.html mode change 100644 => 100755 slf4j-site/src/site/pages/codes.html mode change 100644 => 100755 slf4j-site/src/site/pages/compatibility.html mode change 100644 => 100755 slf4j-site/src/site/pages/css/site.css mode change 100644 => 100755 slf4j-site/src/site/pages/extensions.html mode change 100644 => 100755 slf4j-site/src/site/pages/faq.html mode change 100644 => 100755 slf4j-site/src/site/pages/localization.html mode change 100644 => 100755 slf4j-site/src/site/pages/mailing-lists.html mode change 100644 => 100755 slf4j-site/src/site/pages/migrator.html diff --git a/integration/pom.xml b/integration/pom.xml old mode 100644 new mode 100755 index b3999e87..2a3d6b1d --- a/integration/pom.xml +++ b/integration/pom.xml @@ -25,13 +25,13 @@ slf4j-api - + junit junit 3.8.1 - + ant ant-junit diff --git a/jcl-over-slf4j/src/main/java/org/apache/commons/logging/package.html b/jcl-over-slf4j/src/main/java/org/apache/commons/logging/package.html old mode 100644 new mode 100755 index 04ca2d78..014e85a6 --- a/jcl-over-slf4j/src/main/java/org/apache/commons/logging/package.html +++ b/jcl-over-slf4j/src/main/java/org/apache/commons/logging/package.html @@ -67,7 +67,7 @@ convention) after the calling class:

In this version of JCL, the selection of the logging system to use is chosen by the underlying SLF4J API. Consequently, all JCL-specific -configration parameters are ignored. +configuration parameters are ignored.

Choosing a LogFactory Implementation

diff --git a/slf4j-ext/src/test/java/org/slf4j/dummyExt/package.html b/slf4j-ext/src/test/java/org/slf4j/dummyExt/package.html old mode 100644 new mode 100755 index 4ed5eaa9..be198fb4 --- a/slf4j-ext/src/test/java/org/slf4j/dummyExt/package.html +++ b/slf4j-ext/src/test/java/org/slf4j/dummyExt/package.html @@ -1,6 +1,6 @@ -Tests related to the org.slfj.ext package. However, location information code +Tests related to the org.slf4j.ext package. However, location information code required the caller class (XLogger) to have a different prefix than the test class XLoggerTest. This is ensured by having the test class placed in a different package. diff --git a/slf4j-migrator/LIMITATIONS.txt b/slf4j-migrator/LIMITATIONS.txt old mode 100644 new mode 100755 index 7770f242..39e5d024 --- a/slf4j-migrator/LIMITATIONS.txt +++ b/slf4j-migrator/LIMITATIONS.txt @@ -10,7 +10,7 @@ General limitations very few log statements bearing the FATAL level. -- if a method declares multipe loggers on the same line, the conversion will not be complete. Example: +- if a method declares multiple loggers on the same line, the conversion will not be complete. Example: public void someMethod(Log l1, Log l2) { @@ -32,4 +32,3 @@ When migrating from log4j - Calls to PropertyConfigurator or DomConfigurator cannot be migrated since SLF4J the equivalents. - \ No newline at end of file diff --git a/slf4j-site/src/site/pages/bug-reporting.html b/slf4j-site/src/site/pages/bug-reporting.html old mode 100644 new mode 100755 index 64cce0de..2b361c1b --- a/slf4j-site/src/site/pages/bug-reporting.html +++ b/slf4j-site/src/site/pages/bug-reporting.html @@ -71,7 +71,7 @@

Reporting with Bugzilla

-

Onlly after you have exhausted the aforementioned steps, should +

Only after you have exhausted the aforementioned steps, should you file a formal report in bugzilla.

diff --git a/slf4j-site/src/site/pages/codes.html b/slf4j-site/src/site/pages/codes.html old mode 100644 new mode 100755 index 934fa9ab..cfbbf9c6 --- a/slf4j-site/src/site/pages/codes.html +++ b/slf4j-site/src/site/pages/codes.html @@ -71,7 +71,7 @@ [suchAndSuch] is not supported in jcl-over-slf4j. -

An UnsuportedOperationException is thrown whenever +

An UnsupportedOperationException is thrown whenever one of the protected methods introduced in JCL 1.1 are invoked. These methods are invoked by LogFactory implementations shipping with @@ -127,7 +127,7 @@ at org.slf4j.LoggerFactory.<clinit>(LoggerFactory.java:60) ...

-

The error is caused by the static initilizer of the +

The error is caused by the static initializer of the LoggerFactory class attempting to directly access the SINGLETON field of org.slf4j.impl.StaticLoggerBinder. While this was @@ -148,7 +148,7 @@ -

SLF4J API is desinged to bind with one and only one underlying +

SLF4J API is designed to bind with one and only one underlying logging framework at a time. If more than one binding is present on the class path, SLF4J will emit a warning, listing the location of those bindings.

@@ -441,4 +441,3 @@ - \ No newline at end of file diff --git a/slf4j-site/src/site/pages/compatibility.html b/slf4j-site/src/site/pages/compatibility.html old mode 100644 new mode 100755 index 1af10ea4..cf4afb9c --- a/slf4j-site/src/site/pages/compatibility.html +++ b/slf4j-site/src/site/pages/compatibility.html @@ -69,7 +69,7 @@ prefix='';

The SubstituteLoggerFactory class is used internally by the LoggerFactory class. Changes to the constructor of - SubstituteLoggerFactory should have stricly no affect on users. + SubstituteLoggerFactory should have strictly no effect on users.

Version 1.5.5 compared to 1.5.4

diff --git a/slf4j-site/src/site/pages/css/site.css b/slf4j-site/src/site/pages/css/site.css old mode 100644 new mode 100755 index a4f8ddfc..415949e1 --- a/slf4j-site/src/site/pages/css/site.css +++ b/slf4j-site/src/site/pages/css/site.css @@ -422,7 +422,7 @@ dt:hover .anchor { } -/* ------------ twitter botton ------- */ +/* ------------ twitter button ------- */ .twitter_button { vertical-align: text-bottom; padding-top: 3px; diff --git a/slf4j-site/src/site/pages/extensions.html b/slf4j-site/src/site/pages/extensions.html old mode 100644 new mode 100755 index 7506d5b5..d4695810 --- a/slf4j-site/src/site/pages/extensions.html +++ b/slf4j-site/src/site/pages/extensions.html @@ -162,11 +162,11 @@ 8 static String NESTED_PROFILER_NAME = "SORT_AND_PRUNE"; 9 10 final int[] originalArray; -11 final int originalArrrayLength; +11 final int originalArrayLength; 12 13 public SortAndPruneComposites(int[] randomArray) { 14 this.originalArray = randomArray; -15 this.originalArrrayLength = randomArray.length; +15 this.originalArrayLength = randomArray.length; 16 17 } 18 @@ -343,7 +343,7 @@
  • aid in problem diagnosis in production where no debugging is possible
    • -
  • help educate new deveopers in learning the application.
    • +
  • help educate new developers in learning the application.
    • @@ -369,7 +369,7 @@

    The throwing() method can be used by an application when it is throwing an exception that is unlikely to be handled, such as a - RuntimeExcpetion. This will insure that proper diagnostics are + RuntimeException. This will insure that proper diagnostics are available if needed. The logging event generated will have a level of ERROR and will have an associated Marker with a name of "THROWING" which is also an "EXCEPTION" Marker. @@ -394,7 +394,7 @@ utility class.

    The following example shows a simple application using these - methods in a fairly typcial manner. The throwing() + methods in a fairly typical manner. The throwing() method is not present since no Exceptions are explicitly thrown and not handled.

    @@ -585,14 +585,14 @@ java.lang.ArrayIndexOutOfBoundsException: 3

    Event Logging

    -

    The EventLogger class provides a simple mechansim for logging events that occur in an application. +

    The EventLogger class provides a simple mechanism for logging events that occur in an application. While the EventLogger is useful as a way of initiating events that should be processed by an audit Logging system, it does not implement any of the features an audit logging system would require such as guaranteed delivery.

    The recommended way of using the EventLogger in a typical web application is to populate the SLF4J MDC with data that is related to the entire lifespan of the request such as the user's id, - the user's ip address, the product name, etc. This can easily be done in a servlet fileter where + the user's ip address, the product name, etc. This can easily be done in a servlet filter where the MDC can also be cleared at the end of the request. When an event that needs to be recorded occurs an EventData object should be created and populated. Then call EventLogger.logEvent(data) where data is a reference to the EventData object.

    @@ -695,7 +695,7 @@ public class MyApp { }

    The EventLogger class uses a Logger named "EventLogger". EventLogger uses a logging level - of INFO. The following shows a configuraton using Logback.

    + of INFO. The following shows a configuration using Logback.

    <configuration>
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
     <layout class="ch.qos.logback.classic.PatternLayout">
@@ -867,7 +867,7 @@ Hello World
     printed, may be silently swallowed by the JVM.
     
  • The javaagent only logs to System.err.
    • 
     
  • The name of the logger variable is fixed (to a value unlikely to be used) so if that
-    name is already used, a failure occures.  This should be changed to determine
+    name is already used, a failure occurs.  This should be changed to determine
     an unused name and use that instead.
    • 
     
  • Empty methods are not instrumented (an incorrect check for an interface).  They should be
    • 
     
diff --git a/slf4j-site/src/site/pages/faq.html b/slf4j-site/src/site/pages/faq.html
old mode 100644
new mode 100755
index bef02f62..1767e2b2
--- a/slf4j-site/src/site/pages/faq.html
+++ b/slf4j-site/src/site/pages/faq.html
@@ -141,7 +141,7 @@
     LoggerFactory?  
 
     
  • In the presence of an
-    exception/throwable, is it possible to parametizere a logging
+    exception/throwable, is it possible to parameterize a logging
     statement?
    • 
     
   
@@ -394,7 +394,7 @@
 org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory
    at org.slf4j.LoggerFactory.<clinit>(LoggerFactory.java:60)
    -

    This error is caused by the static initilizer of the +

    This error is caused by the static initializer of the LoggerFactory class attempting to directly access the SINGLETON field of org.slf4j.impl.StaticLoggerBinder. While this was @@ -406,7 +406,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    If you get the exception shown above, then you are using an older version of slf4j-api, e.g. 1.4.3, with a new version of a slf4j binding, e.g. 1.5.6. Typically, this occurs when your - Maven pom.ml file incoprporates hibernate 3.3.0 which + Maven pom.ml file incorporates hibernate 3.3.0 which declares a dependency on slf4j-api version 1.4.2. If your pom.xml declares a dependency on an slf4j binding, say slf4j-log4j12 version 1.5.6, then you will get illegal access @@ -418,12 +418,12 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    mvn dependency:tree

    -

    If you are usig Eclipse, please do not rely on the dependency +

    If you are using Eclipse, please do not rely on the dependency tree shown by m2eclipse.

    -

    In your pom.xml file, excplicitly declaring a - dependecy on slf4j-api matching the version of the declared +

    In your pom.xml file, explicitly declaring a + dependency on slf4j-api matching the version of the declared binding will make the problem go away.

    @@ -574,7 +574,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    Some projects try to detect the presence of SLF4J on the class path and switch to it if present. While this approach - seems transperent enough, it will result in erroneous location + seems transparent enough, it will result in erroneous location information. Underlying logging frameworks will print the location (class name and line number) of the wrapper instead of the real caller. Then there is the question of API coverage as @@ -648,7 +648,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    -

    alternative 1) explicit exlusion

    +

    alternative 1) explicit exclusion

    Many software projects using Maven declare commons-logging as a dependency. Therefore, if you wish to migrate to SLF4J or use @@ -686,7 +686,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    The first dependency declaration essentially states that commons-logging will be "somehow" provided by your - environment. The second decleration includes jcl-over-slf4j into + environment. The second declaration includes jcl-over-slf4j into your project. As jcl-over-slf4j is a perfect binary-compatible replacement for commons-logging, the first assertion becomes true. @@ -694,7 +694,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    Unfortunately, while declaring commons-logging in the provided scope gets the job done, your IDE, e.g. Eclipse, will - still place commons-logging.jar on your projet's class + still place commons-logging.jar on your project's class path as seen by your IDE. You would need to make sure that jcl-over-slf4j.jar is visible before commons-logging.jar by your IDE. @@ -714,7 +714,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory high-availability Maven repository, replicated on several hosts located in different geographical regions.

    -

    The following decleration adds the version99 repository to +

    The following declaration adds the version99 repository to the set of remote repositories searched by Maven. This repository contains empty artifacts for commons-logging and log4j. By the way, if you use the version99 repository, please @@ -731,7 +731,7 @@ org.slf4j.impl.StaticLoggerBinder.SINGLETON from class org.slf4j.LoggerFactory

    Declaring version 99-empty of commons-logging in the <dependencyManagement> section of your project - will direct all transtive dependencies for commons-logging to + will direct all transitive dependencies for commons-logging to import version 99-empty, thus nicely addressing the commons-logging exclusion problem. The classes for commons-logging will be provided by jcl-over-slf4j. The following lines declare @@ -1022,7 +1022,7 @@ logger.debug("The new entry is {}.", entry); 

    logger.debug("Set \\{} differs from {}", "3");

    will print as "Set {} differs from 3". Note that within - Java code, the backslash cracacter needs to be written as + Java code, the backslash character needs to be written as '\\'.

    In the rare case where the "\{}" occurs naturally in the @@ -1224,7 +1224,7 @@ class Bar {

    In the presence of an - exception/throwable, is it possible to parametizere a logging + exception/throwable, is it possible to parameterize a logging statement?
    @@ -1392,7 +1392,7 @@ try { participates in version checks.

    As of SLF4J 1.5.5, all bindings shipped within the - SLF4J distribution, e.g. slf4j-logj12, slf4j-simple and + SLF4J distribution, e.g. slf4j-log4j12, slf4j-simple and slf4j-jdk14, declare the REQUESTED_API_VERSION field with a value equal to their SLF4J version. It follows that, for example if slf4j-simple-1.5.8.jar is mixed with slf4j-api-1.6.0.jar, @@ -1563,7 +1563,7 @@ try {

    In summary, declaring logger members as static variables requires less CPU time and have a slightly smaller memory footprint. On the other hand, declaring logger members as - instance variables requires more CPU time and have a slighlty + instance variables requires more CPU time and have a slightly higher memory overhead. However, instance variables make it possible to create a distinct logger environment for each application, even for loggers declared in shared diff --git a/slf4j-site/src/site/pages/legacy.html b/slf4j-site/src/site/pages/legacy.html index f24fd501..1dfe6c55 100755 --- a/slf4j-site/src/site/pages/legacy.html +++ b/slf4j-site/src/site/pages/legacy.html @@ -193,10 +193,10 @@

    log4j-over-slf4j.jar - and slf4j-logj12.jar cannot be present simultaneously + and slf4j-log4j12.jar cannot be present simultaneously

    -

    The presence of slf4j-logj12.jar, that is the log4j +

    The presence of slf4j-log4j12.jar, that is the log4j binding for SLF4J, will force all SLF4J calls to be delegated to log4j. The presence of log4j-over-slf4j.jar will in turn delegate all log4j API calls to their SLF4J equivalents. If both diff --git a/slf4j-site/src/site/pages/localization.html b/slf4j-site/src/site/pages/localization.html old mode 100644 new mode 100755 index 186f7839..b321c63c --- a/slf4j-site/src/site/pages/localization.html +++ b/slf4j-site/src/site/pages/localization.html @@ -49,7 +49,7 @@

    Let us assume that you have defined localized message in your - application. In accordance with the CAL10N's philopshopy, you have + application. In accordance with the CAL10N's philosophy, you have the declared the keys for those messages in the enum type Production.

    @@ -79,8 +79,8 @@ APPLICATION_STOPPED=Application {0} has stopped. ...

    Then, you - can instantiate a IMessageCoveyor, inject it into a - LogLoggerFactory, retreive multiple + can instantiate a IMessageConveyor, inject it into a + LogLoggerFactory, retrieve multiple LogLogger instances by name and log away, as the next sample code illustrates.

    @@ -148,7 +148,7 @@ public class MyApplication { locLogger.info(Production.APPLICATION_STARTED, "fooApp"); // follows the {} convention - logLogger.ingo("Hello {}", name); + logLogger.info("Hello {}", name); ... } } diff --git a/slf4j-site/src/site/pages/mailing-lists.html b/slf4j-site/src/site/pages/mailing-lists.html old mode 100644 new mode 100755 index b56f7368..5a5a6f88 --- a/slf4j-site/src/site/pages/mailing-lists.html +++ b/slf4j-site/src/site/pages/mailing-lists.html @@ -42,7 +42,7 @@

    Please do your best to ensure that you are not sending HTML or - "Stylelized" email to the list. If you are using Outlook or Outlook + "Stylized" email to the list. If you are using Outlook or Outlook Express or Eudora, chances are that you are sending HTML email by default. There is usually a setting that will allow you to send "Plain Text" email. diff --git a/slf4j-site/src/site/pages/manual.html b/slf4j-site/src/site/pages/manual.html index 7ca997b5..ec082d6e 100755 --- a/slf4j-site/src/site/pages/manual.html +++ b/slf4j-site/src/site/pages/manual.html @@ -272,7 +272,7 @@ SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further detail on any SLF4J binding but only depend on slf4j-api. When a library declares a transitive dependency on a specific binding, that binding is imposed on the end-user negating the purpose of - SLF4J. Note that declaring a non-transitve dependecy on a + SLF4J. Note that declaring a non-transitive dependency on a binding, for example for testing, does not affect the end-user.

    @@ -469,7 +469,7 @@ SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further detail Due to the way that classes are loaded by the JVM, the framework binding will be verified automatically very early on. If SLF4J cannot find a binding on the class path it - will emit a signle warning message and default to + will emit a single warning message and default to no-operation implementation. diff --git a/slf4j-site/src/site/pages/migrator.html b/slf4j-site/src/site/pages/migrator.html old mode 100644 new mode 100755 index de7eb7d1..ec344fb6 --- a/slf4j-site/src/site/pages/migrator.html +++ b/slf4j-site/src/site/pages/migrator.html @@ -183,7 +183,7 @@ will be converted as