diff --git a/README.md b/README.md index f2d86712f..ed94f64dc 100644 --- a/README.md +++ b/README.md @@ -40,14 +40,14 @@ for your work if appropriate. It usually is. 4. All commits must have signed off by the contributor attesting to [Developer Certificate of Origin (DCO)](https://developercertificate.org/). Commits without sign off -will be automatically rejected by the [DCO github +will be automatically rejected by the [DCO GitHub check](https://probot.github.io/apps/dco/) application. -5. Push your changes to your fork/branch in github. Don't push it to +5. Push your changes to your fork/branch in GitHub. Don't push it to your master! If you do it will make it harder to submit new changes later. -6. Submit a pull request to SLF4J from your commit page on github. +6. Submit a pull request to SLF4J from your commit page on GitHub. 7. Did we mention that you will be asked to link your pull request with a Jira ticket? diff --git a/integration/osgi-build.xml b/integration/osgi-build.xml index 57771684b..8d0c17ce5 100755 --- a/integration/osgi-build.xml +++ b/integration/osgi-build.xml @@ -66,7 +66,7 @@ - These are some of the targets supported by this ANT build scpript: + These are some of the targets supported by this ANT build script: all - run all available tests refresh - copy required jar files to the lib directory diff --git a/log4j-over-slf4j/compatibility/readme.txt b/log4j-over-slf4j/compatibility/readme.txt index a62297ddc..86bbc820e 100644 --- a/log4j-over-slf4j/compatibility/readme.txt +++ b/log4j-over-slf4j/compatibility/readme.txt @@ -5,7 +5,7 @@ that uses either log4j 1.2.x, or log4j 1.3.x. In the same directory is a build.xml file that uses ant to compile the test cases with the corresponding log4j version, -and to runs these tests without log4j in the classpath but with +and to run these tests without log4j in the classpath but with logback jars instead. To run the tests, one must have ant installed. Issuing the following command, diff --git a/log4j-over-slf4j/src/main/java/org/apache/log4j/Appender.java b/log4j-over-slf4j/src/main/java/org/apache/log4j/Appender.java index 9d35070cc..fcc099949 100644 --- a/log4j-over-slf4j/src/main/java/org/apache/log4j/Appender.java +++ b/log4j-over-slf4j/src/main/java/org/apache/log4j/Appender.java @@ -114,7 +114,7 @@ public interface Appender { * Configurators call this method to determine if the appender * requires a layout. If this method returns true, * meaning that layout is required, then the configurator will - * configure an layout using the configuration information at its + * configure a layout using the configuration information at its * disposal. If this method returns false, meaning that * a layout is not required, then layout configuration will be * skipped even if there is available layout configuration diff --git a/log4j-over-slf4j/src/main/java/org/apache/log4j/Priority.java b/log4j-over-slf4j/src/main/java/org/apache/log4j/Priority.java index 706e80748..08eebca94 100644 --- a/log4j-over-slf4j/src/main/java/org/apache/log4j/Priority.java +++ b/log4j-over-slf4j/src/main/java/org/apache/log4j/Priority.java @@ -187,7 +187,7 @@ public static Priority toPriority(int val) { * * @param val an integer value * @param defaultPriority a default priority value - * @return correspoding Priority value + * @return corresponding Priority value */ @Deprecated public static Priority toPriority(int val, Priority defaultPriority) { @@ -204,4 +204,4 @@ public static Priority toPriority(int val, Priority defaultPriority) { public static Priority toPriority(String sArg, Priority defaultPriority) { return Level.toLevel(sArg, (Level) defaultPriority); } -} \ No newline at end of file +} diff --git a/log4j-over-slf4j/src/main/java/org/apache/log4j/PropertyConfigurator.java b/log4j-over-slf4j/src/main/java/org/apache/log4j/PropertyConfigurator.java index baf4c1363..6af30d061 100644 --- a/log4j-over-slf4j/src/main/java/org/apache/log4j/PropertyConfigurator.java +++ b/log4j-over-slf4j/src/main/java/org/apache/log4j/PropertyConfigurator.java @@ -23,7 +23,7 @@ import org.apache.log4j.spi.LoggerRepository; /** - * An nop implementation of PropertyConfigurator. + * A no-op implementation of PropertyConfigurator. */ public class PropertyConfigurator implements Configurator { public static void configure(Properties properties) { diff --git a/log4j-over-slf4j/src/main/java/org/apache/log4j/helpers/LogLog.java b/log4j-over-slf4j/src/main/java/org/apache/log4j/helpers/LogLog.java index f9a45aea9..0270e4180 100644 --- a/log4j-over-slf4j/src/main/java/org/apache/log4j/helpers/LogLog.java +++ b/log4j-over-slf4j/src/main/java/org/apache/log4j/helpers/LogLog.java @@ -25,7 +25,7 @@ log4j.configDebug variable.

All log4j internal debug calls go to System.out - where as internal error messages are sent to + whereas internal error messages are sent to System.err. All internal messages are prepended with the string "log4j: ". @@ -40,7 +40,7 @@ public class LogLog {

The value of this string is log4j.debug. -

Note that the search for all option names is case sensitive. */ +

Note that the search for all option names is case-sensitive. */ public static final String DEBUG_KEY = "log4j.debug"; /** @@ -49,7 +49,7 @@ public class LogLog {

The value of this string is log4j.configDebug. -

Note that the search for all option names is case sensitive. +

Note that the search for all option names is case-sensitive. @deprecated Use {@link #DEBUG_KEY} instead. */ diff --git a/log4j-over-slf4j/src/main/java/org/apache/log4j/spi/LoggerFactory.java b/log4j-over-slf4j/src/main/java/org/apache/log4j/spi/LoggerFactory.java index c3e756d76..0f008bfa4 100644 --- a/log4j-over-slf4j/src/main/java/org/apache/log4j/spi/LoggerFactory.java +++ b/log4j-over-slf4j/src/main/java/org/apache/log4j/spi/LoggerFactory.java @@ -21,7 +21,7 @@ /** Implement this interface to create new instances of Logger or - a sub-class of Logger. + a subclass of Logger.

See examples/subclass/MyLogger.java for an example. diff --git a/slf4j-api/src/main/java/org/slf4j/Logger.java b/slf4j-api/src/main/java/org/slf4j/Logger.java index 7341676b0..f759f0188 100644 --- a/slf4j-api/src/main/java/org/slf4j/Logger.java +++ b/slf4j-api/src/main/java/org/slf4j/Logger.java @@ -83,7 +83,7 @@ public interface Logger { /** - * Case insensitive String constant used to retrieve the name of the root logger. + * Case-insensitive String constant used to retrieve the name of the root logger. * * @since 1.3 */ @@ -510,7 +510,8 @@ default public LoggingEventBuilder atDebug() { * data is also taken into consideration. * * @param marker The marker data to take into consideration - * @return true if this logger is warn enabled, false otherwise + * @return true if this Logger is enabled for the INFO level, + * false otherwise. */ public boolean isInfoEnabled(Marker marker); diff --git a/slf4j-api/src/main/java/org/slf4j/LoggerFactory.java b/slf4j-api/src/main/java/org/slf4j/LoggerFactory.java index c3f2b0ff0..5b2a6bbce 100755 --- a/slf4j-api/src/main/java/org/slf4j/LoggerFactory.java +++ b/slf4j-api/src/main/java/org/slf4j/LoggerFactory.java @@ -363,7 +363,7 @@ public static Logger getLogger(String name) { * using the statically bound {@link ILoggerFactory} instance. * *

- * In case the the clazz parameter differs from the name of the + * In case the clazz parameter differs from the name of the * caller as computed internally by SLF4J, a logger name mismatch warning * will be printed but only if the * slf4j.detectLoggerNameMismatch system property is set to diff --git a/slf4j-api/src/main/java/org/slf4j/LoggerFactoryFriend.java b/slf4j-api/src/main/java/org/slf4j/LoggerFactoryFriend.java index 4f6dbcf16..06ca2017e 100755 --- a/slf4j-api/src/main/java/org/slf4j/LoggerFactoryFriend.java +++ b/slf4j-api/src/main/java/org/slf4j/LoggerFactoryFriend.java @@ -27,7 +27,7 @@ /** * All methods in this class are reserved for internal use, for testing purposes. * - *

They can can be modified, renamed or removed at any time without notice. + *

They can be modified, renamed or removed at any time without notice. * *

You are strongly discouraged calling any of the methods of this class. * diff --git a/slf4j-api/src/main/java/org/slf4j/helpers/BasicMDCAdapter.java b/slf4j-api/src/main/java/org/slf4j/helpers/BasicMDCAdapter.java index 8cba70315..95cb904a2 100644 --- a/slf4j-api/src/main/java/org/slf4j/helpers/BasicMDCAdapter.java +++ b/slf4j-api/src/main/java/org/slf4j/helpers/BasicMDCAdapter.java @@ -92,7 +92,7 @@ public String get(String key) { } /** - * Remove the the context identified by the key parameter. + * Remove the context identified by the key parameter. */ public void remove(String key) { Map map = inheritableThreadLocalMap.get(); diff --git a/slf4j-api/src/main/java/org/slf4j/helpers/MessageFormatter.java b/slf4j-api/src/main/java/org/slf4j/helpers/MessageFormatter.java index ad7779ee7..707b4c6f3 100755 --- a/slf4j-api/src/main/java/org/slf4j/helpers/MessageFormatter.java +++ b/slf4j-api/src/main/java/org/slf4j/helpers/MessageFormatter.java @@ -81,7 +81,7 @@ * will return the string "File name is C:\file.zip". * *

- * The formatting conventions are different than those of {@link MessageFormat} + * The formatting conventions are different from those of {@link MessageFormat} * which ships with the Java platform. This is justified by the fact that * SLF4J's implementation is 10 times faster than that of {@link MessageFormat}. * This local performance difference is both measurable and significant in the diff --git a/slf4j-api/src/main/java/org/slf4j/helpers/NOPLoggerFactory.java b/slf4j-api/src/main/java/org/slf4j/helpers/NOPLoggerFactory.java index 0c98f7531..7cc83914f 100644 --- a/slf4j-api/src/main/java/org/slf4j/helpers/NOPLoggerFactory.java +++ b/slf4j-api/src/main/java/org/slf4j/helpers/NOPLoggerFactory.java @@ -28,7 +28,7 @@ import org.slf4j.Logger; /** - * NOPLoggerFactory is an trivial implementation of {@link + * NOPLoggerFactory is a trivial implementation of {@link * ILoggerFactory} which always returns the unique instance of * NOPLogger. * diff --git a/slf4j-api/src/main/java/org/slf4j/helpers/NormalizedParameters.java b/slf4j-api/src/main/java/org/slf4j/helpers/NormalizedParameters.java index c7b69e1c0..ec278f463 100644 --- a/slf4j-api/src/main/java/org/slf4j/helpers/NormalizedParameters.java +++ b/slf4j-api/src/main/java/org/slf4j/helpers/NormalizedParameters.java @@ -3,7 +3,7 @@ import org.slf4j.event.LoggingEvent; /** - * Holds normalized calling call parameters. + * Holds normalized call parameters. * * Includes utility methods such as {@link #normalize(String, Object[], Throwable)} to help the normalization of parameters. * diff --git a/slf4j-api/src/main/java/org/slf4j/spi/MDCAdapter.java b/slf4j-api/src/main/java/org/slf4j/spi/MDCAdapter.java index 0ed147282..924849d14 100644 --- a/slf4j-api/src/main/java/org/slf4j/spi/MDCAdapter.java +++ b/slf4j-api/src/main/java/org/slf4j/spi/MDCAdapter.java @@ -56,7 +56,7 @@ public interface MDCAdapter { public String get(String key); /** - * Remove the the context identified by the key parameter. + * Remove the context identified by the key parameter. * The key parameter cannot be null. * *

diff --git a/slf4j-api/src/test/java/org/slf4j/helpers/StringPrintStream.java b/slf4j-api/src/test/java/org/slf4j/helpers/StringPrintStream.java index e230967e1..68a762577 100755 --- a/slf4j-api/src/test/java/org/slf4j/helpers/StringPrintStream.java +++ b/slf4j-api/src/test/java/org/slf4j/helpers/StringPrintStream.java @@ -30,13 +30,11 @@ import java.util.List; /** - * - * Copied from org.slfj.helpers. + * Copied from org.slfj.helpers. * - * Currently it is not possible to use test-jar from tests running on the module-path. + * Currently it is not possible to use test-jar from tests running on the module-path. * * @author ceki - * */ public class StringPrintStream extends PrintStream { @@ -73,4 +71,4 @@ public void println(Object o) { other.println(o); stringList.add(o.toString()); } -} \ No newline at end of file +} diff --git a/slf4j-api/src/test/java/org/slf4j/helpers/SubstitutableLoggerTest.java b/slf4j-api/src/test/java/org/slf4j/helpers/SubstitutableLoggerTest.java index c43a82acf..f82c4f5db 100644 --- a/slf4j-api/src/test/java/org/slf4j/helpers/SubstitutableLoggerTest.java +++ b/slf4j-api/src/test/java/org/slf4j/helpers/SubstitutableLoggerTest.java @@ -45,7 +45,7 @@ */ public class SubstitutableLoggerTest { - // NOTE: previous implementations of this class performed a hand crafted conversion of + // NOTE: previous implementations of this class performed a handcrafted conversion of // a method to a string. In this implementation we just invoke method.toString(). // WARNING: if you need to add an excluded method to have tests pass, ask yourself whether you diff --git a/slf4j-ext/src/main/java/org/slf4j/instrumentation/JavassistHelper.java b/slf4j-ext/src/main/java/org/slf4j/instrumentation/JavassistHelper.java index 8799e563d..5f4c1f262 100644 --- a/slf4j-ext/src/main/java/org/slf4j/instrumentation/JavassistHelper.java +++ b/slf4j-ext/src/main/java/org/slf4j/instrumentation/JavassistHelper.java @@ -41,7 +41,7 @@ public class JavassistHelper { /** * Create a javassist source snippet which either is empty (for anything - * which does not return a value) or a explanatory text around the $_ + * which does not return a value) or an explanatory text around the $_ * javassist return value variable. * * @param method diff --git a/slf4j-ext/src/main/java/org/slf4j/instrumentation/package.html b/slf4j-ext/src/main/java/org/slf4j/instrumentation/package.html index 76001498c..6816e8f23 100644 --- a/slf4j-ext/src/main/java/org/slf4j/instrumentation/package.html +++ b/slf4j-ext/src/main/java/org/slf4j/instrumentation/package.html @@ -9,7 +9,7 @@

Java instrumentation routines for SLF4J.

-

Byte code instrumentation is an way to change behaviour of java +

Byte code instrumentation is a way to change behaviour of java classes at load time. This is done in-between the original byte codes are retrieved and the class object is constructed by the class loader. Currently this depends on the javassist library from JBoss diff --git a/slf4j-jdk-platform-logging/src/main/java/org/slf4j/jdk/platform/logging/SLF4JPlatformLogger.java b/slf4j-jdk-platform-logging/src/main/java/org/slf4j/jdk/platform/logging/SLF4JPlatformLogger.java index b79a85177..b782f099e 100644 --- a/slf4j-jdk-platform-logging/src/main/java/org/slf4j/jdk/platform/logging/SLF4JPlatformLogger.java +++ b/slf4j-jdk-platform-logging/src/main/java/org/slf4j/jdk/platform/logging/SLF4JPlatformLogger.java @@ -105,7 +105,7 @@ public void log(Level jplLevel, ResourceBundle bundle, String format, Object... } /** - * Single point of processing taking all possible paramets. + * Single point of processing taking all possible parameters. * * @param jplLevel * @param bundle diff --git a/slf4j-migrator/src/main/java/org/slf4j/migrator/helper/Abbreviator.java b/slf4j-migrator/src/main/java/org/slf4j/migrator/helper/Abbreviator.java index 34bebda29..519a3f047 100644 --- a/slf4j-migrator/src/main/java/org/slf4j/migrator/helper/Abbreviator.java +++ b/slf4j-migrator/src/main/java/org/slf4j/migrator/helper/Abbreviator.java @@ -44,7 +44,7 @@ public String abbreviate(String filename) { int firstIndex = filename.indexOf(folderSeparator, invariantPrefixLength); if (firstIndex == -1) { - // we cant't process this string + // we can't process this string return filename; } StringBuilder buf = new StringBuilder(desiredLength); diff --git a/slf4j-migrator/src/main/java/org/slf4j/migrator/internal/MigratorFrame.java b/slf4j-migrator/src/main/java/org/slf4j/migrator/internal/MigratorFrame.java index aa7c46d6c..3ab15c603 100644 --- a/slf4j-migrator/src/main/java/org/slf4j/migrator/internal/MigratorFrame.java +++ b/slf4j-migrator/src/main/java/org/slf4j/migrator/internal/MigratorFrame.java @@ -128,7 +128,7 @@ private void createComponents() { */ private void constrainAll() { - // contrain migration label + // constraints migration label layoutManager.putConstraint(SpringLayout.WEST, migrationLabel, BASIC_PADDING, SpringLayout.EAST, this); layoutManager.putConstraint(SpringLayout.NORTH, migrationLabel, BASIC_PADDING, SpringLayout.NORTH, this); diff --git a/slf4j-migrator/src/test/java/org/slf4j/migrator/AternativeApproach.java b/slf4j-migrator/src/test/java/org/slf4j/migrator/AternativeApproach.java index d530a6ca4..0626b871b 100644 --- a/slf4j-migrator/src/test/java/org/slf4j/migrator/AternativeApproach.java +++ b/slf4j-migrator/src/test/java/org/slf4j/migrator/AternativeApproach.java @@ -34,7 +34,7 @@ public class AternativeApproach extends TestCase { /** - * In this test we see that we cans use more simple Pattern to do the + * In this test we see that we can use more simple Pattern to do the * conversion * */ diff --git a/slf4j-migrator/src/test/java/org/slf4j/migrator/line/TrivialMatcher.java b/slf4j-migrator/src/test/java/org/slf4j/migrator/line/TrivialMatcher.java index c9b0fa71b..032bddcaa 100644 --- a/slf4j-migrator/src/test/java/org/slf4j/migrator/line/TrivialMatcher.java +++ b/slf4j-migrator/src/test/java/org/slf4j/migrator/line/TrivialMatcher.java @@ -41,15 +41,15 @@ public TrivialMatcher() { // simple rule no capturing group is defined, we use default capturing group which is group zero SingleConversionRule cr = new SingleConversionRule(Pattern.compile("import org.slf4j.converter"), "simple replacement with an unique capturing group"); - // we define 4 differents capturing groups + // we define 4 different capturing groups MultiGroupConversionRule cr1 = new MultiGroupConversionRule(Pattern.compile("(first group)( second group)( third group)( 4th group)")); // group zero is ignored during treatment // replacement for the first cr1.addReplacement(1, "1st group"); - // no replacement for the second group it will remains the same + // no replacement for the second group it will remain the same // empty string for the third group it will be deleted cr1.addReplacement(3, ""); - // no replacement for the third group it will remains the same + // no replacement for the third group it will remain the same conversionRuleList = new ArrayList<>(); conversionRuleList.add(cr); @@ -60,4 +60,4 @@ public Iterator iterator() { return conversionRuleList.iterator(); } -} \ No newline at end of file +} diff --git a/slf4j-simple/src/test/java/org/slf4j/simple/multiThreadedExecution/MultithereadedExecutionTest.java b/slf4j-simple/src/test/java/org/slf4j/simple/multiThreadedExecution/MultithereadedExecutionTest.java index f40468ab7..bb79ac542 100755 --- a/slf4j-simple/src/test/java/org/slf4j/simple/multiThreadedExecution/MultithereadedExecutionTest.java +++ b/slf4j-simple/src/test/java/org/slf4j/simple/multiThreadedExecution/MultithereadedExecutionTest.java @@ -33,7 +33,7 @@ import org.slf4j.LoggerFactory; /** - * Tests that output in multi-threaded environments is not mingled. + * Tests that output in multithreaded environments is not mingled. * * See also https://jira.qos.ch/browse/SLF4J-515 */