Merge pull request #580 from marcwrobel/fix-typos-doc

fix typos in documentations
qos-ch · Jul 21, 2022 · 7c0b3a3 · 7c0b3a3
2 parents 5f37b31 + e17e3f5
commit 7c0b3a3
Show file tree

Hide file tree

Showing 105 changed files with 140 additions and 145 deletions.
diff --git a/README.md b/README.md
@@ -42,17 +42,16 @@ looks forward to your contribution. Please follow this process:
 2. Fork qos-ch/logback. Ideally, create a new branch from your fork for
    your contribution to make it easier to merge your changes back.
 
-3. Make your changes on the branch you hopefuly created in Step 2. Be
+3. Make your changes on the branch you hopefully created in Step 2. Be
    sure that your code passes existing unit tests.
 
 4. Please add unit tests for your work if appropriate. It usually is.
 
-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 logback from from your commit page on
-   github.
+6. Submit a pull request to logback from your commit page on GitHub.
 
 
 # Build Status

diff --git a/logback-access/keywords.html b/logback-access/keywords.html
@@ -109,9 +109,9 @@
         <td>o</td>
         <td>response header</td>
         <td></td>
-        <td>reponse.getHeader(name) [NS]</td>
+        <td>response.getHeader(name) [NS]</td>
         <td></td>
-        <td>not implemented altough response.setHeader() method is available</td>
+        <td>not implemented although response.setHeader() method is available</td>
       </tr>
 
       <tr>
@@ -138,7 +138,7 @@
         <td>response.getStatus() [NS] </td>
         <td>response.getStatusCode() [NS]</td>
         <td>response.getStatus() [NS]</td>
-        <td>suprisingly, not in the Servlet API</td>
+        <td>surprisingly, not in the Servlet API</td>
       </tr>
 
       <tr>
@@ -219,4 +219,4 @@
 
 
 
-</html>
+</html>
diff --git a/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java b/logback-access/src/main/java/ch/qos/logback/access/PatternLayout.java
@@ -180,7 +180,7 @@ public class PatternLayout extends PatternLayoutBase<IAccessEvent> {
     public PatternLayout() {
         // set a default value for pattern
         setPattern(CLF_PATTERN);
-        // by default postCompileProcessor the is an EnsureLineSeparation instance
+        // by default postCompileProcessor is an EnsureLineSeparation instance
         this.postCompileProcessor = new EnsureLineSeparation();
     }
 

diff --git a/logback-access/src/main/java/ch/qos/logback/access/jetty/RequestLogImpl.java b/logback-access/src/main/java/ch/qos/logback/access/jetty/RequestLogImpl.java
@@ -67,7 +67,7 @@
  * By default, RequestLogImpl looks for a logback configuration file called
  * logback-access.xml, in the same folder where jetty.xml is located, that is
  * <em>etc/logback-access.xml</em>. The logback-access.xml file is slightly
- * different than the usual logback classic configuration file. Most of it is
+ * different from the usual logback classic configuration file. Most of it is
  * the same: Appenders and Layouts are declared the exact same way. However,
  * loggers elements are not allowed.
  * <p>

diff --git a/logback-access/src/main/java/ch/qos/logback/access/joran/package.html b/logback-access/src/main/java/ch/qos/logback/access/joran/package.html
@@ -7,7 +7,7 @@
 
   <body>
 
-    <p>Contains the Joran configration classes</p>
+    <p>Contains the Joran configuration classes</p>
 
   </body> 
-</html>
+</html>
diff --git a/...access/src/main/java/ch/qos/logback/access/model/processor/ConfigurationModelHandler.java b/...access/src/main/java/ch/qos/logback/access/model/processor/ConfigurationModelHandler.java
@@ -41,7 +41,7 @@ protected Class<ConfigurationModel> getSupportedModelClass() {
     @Override
     public void handle(ModelInterpretationContext mic, Model model) throws ModelHandlerException {
         ConfigurationModel configurationModel = (ConfigurationModel) model;
-        // See LBCLASSIC-225 (the system property is looked up first. Thus, it overrides
+        // See LBCLASSIC-225 (the system property is looked up first). Thus, it overrides
         // the equivalent property in the config file. This reversal of scope priority
         // is justified
         // by the use case: the admin trying to chase rogue config file

diff --git a/logback-access/src/main/java/ch/qos/logback/access/sift/SiftingAppender.java b/logback-access/src/main/java/ch/qos/logback/access/sift/SiftingAppender.java
@@ -19,7 +19,7 @@
 import ch.qos.logback.core.sift.SiftingAppenderBase;
 
 /**
- * This appender can contains other appenders which it can build dynamically
+ * This appender can contain other appenders which it can build dynamically
  * depending on MDC values. The built appender is specified as part of a
  * configuration file.
  * 

diff --git a/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java b/logback-access/src/main/java/ch/qos/logback/access/spi/AccessEvent.java
@@ -338,7 +338,7 @@ public Map<String, String> getRequestHeaderMap() {
     }
 
     public void buildRequestHeaderMap() {
-        // according to RFC 2616 header names are case insensitive
+        // according to RFC 2616 header names are case-insensitive
         // latest versions of Tomcat return header names in lower-case
         requestHeaderMap = new TreeMap<String, String>(String.CASE_INSENSITIVE_ORDER);
         Enumeration<String> e = httpRequest.getHeaderNames();
@@ -551,7 +551,7 @@ public String getResponseContent() {
             responseContent = "[IMAGE CONTENTS SUPPRESSED]";
         } else {
 
-            // retreive the byte array previously placed by TeeFilter
+            // retrieve the byte array previously placed by TeeFilter
             byte[] outputBuffer = (byte[]) httpRequest.getAttribute(AccessConstants.LB_OUTPUT_BUFFER);
 
             if (outputBuffer != null) {

diff --git a/logback-access/src/main/java/ch/qos/logback/access/tomcat/LogbackValve.java b/logback-access/src/main/java/ch/qos/logback/access/tomcat/LogbackValve.java
@@ -76,7 +76,7 @@
  * <p>
  * For more information on using LogbackValve please refer to the online
  * documentation on
- * <a href="http://logback.qos.ch/access.html#tomcat">logback-acces and
+ * <a href="http://logback.qos.ch/access.html#tomcat">logback-access and
  * tomcat</a>.
  * 
  * @author Ceki G&uuml;lc&uuml;

diff --git a/logback-access/src/test/java/ch/qos/logback/access/dummy/DummyRequest.java b/logback-access/src/test/java/ch/qos/logback/access/dummy/DummyRequest.java
@@ -271,7 +271,7 @@ public Map<String, String[]> getParameterMap() {
 
     public Enumeration<String> getParameterNames() {
         return parameterMap.keys();
-        // eturn Collections.enumeration(parameterMap.keySet());
+        // return Collections.enumeration(parameterMap.keySet());
     }
 
     public String[] getParameterValues(String arg) {

diff --git a/logback-access/src/test/java/ch/qos/logback/access/net/SerializationPerfTest.java b/logback-access/src/test/java/ch/qos/logback/access/net/SerializationPerfTest.java
@@ -72,7 +72,7 @@ public void test1() throws Exception {
         Long total = 0L;
         resetCounter = 0;
         pauseCounter = 0;
-        // System.out.println("Beginning mesured run");
+        // System.out.println("Beginning measured run");
         for (int i = 0; i < loopNumber; i++) {
             try {
                 IAccessEvent ae = DummyAccessEventBuilder.buildNewAccessEvent();

diff --git a/logback-classic/integration.xml b/logback-classic/integration.xml
@@ -14,8 +14,8 @@
 	<echo message="hamcrest:  ${org.hamcrest:hamcrest-core:jar}" />
 
 	<path id="basicClasspath">
-		<!-- post junit version 4.12, we neeed to add hamcrest manually to the 
-		     classpath, even though the m-ant-plugin declares a dependecy on hamcrest! -->
+		<!-- post junit version 4.12, we need to add hamcrest manually to the
+		     classpath, even though the m-ant-plugin declares a dependency on hamcrest! -->
 		<pathelement location="${org.hamcrest:hamcrest-core:jar}" />
 		<pathelement location="../logback-core/target/classes/" />
 		<pathelement location="../logback-core/target/test-classes/" />
@@ -39,7 +39,7 @@
     <echo>Making lib/ folder in case it does not already exist.</echo>
   	<mkdir dir="lib/"/>
     <echo>Copying ${org.slf4j:slf4j-api:jar} to lib/</echo>
-    <!-- sneak in a clean up procedure of the ../logback-examples/lib/ folder-->
+    <!-- sneak in a cleanup procedure of the ../logback-examples/lib/ folder-->
     <delete quiet="true">
       <fileset dir="../logback-examples/lib/" includes="slf4j-*SNAPSHOT.jar" />
     </delete>

diff --git a/logback-classic/osgi-build.xml b/logback-classic/osgi-build.xml
@@ -55,7 +55,7 @@
     <echo>Making lib/ folder in case it does not already exist.</echo>
   	<mkdir dir="lib/"/>
     <echo>Copying ${org.slf4j:slf4j-api:jar} to lib/</echo>
-    <!-- sneak in a clean up procedure of the ../logback-examples/lib/ folder-->
+    <!-- sneak in a cleanup procedure of the ../logback-examples/lib/ folder-->
     <delete quiet="true">
       <fileset dir="../logback-examples/lib/" includes="slf4j-*SNAPSHOT.jar" />
     </delete>
@@ -97,7 +97,7 @@
 
 
    <!-- for some reason if mvn is invoked from the parent directory, junit gets
-        invoked from the parent dir, which messes up theseg tests. Hence, the
+        invoked from the parent dir, which messes up these tests. Hence, the
         fork="yes" dir="${basedir}" -->
 
 	<target name="logback" unless="maven.test.skip">

diff --git a/logback-classic/performance/records/ArrayListLogger/results.txt b/logback-classic/performance/records/ArrayListLogger/results.txt
@@ -4,11 +4,11 @@
   children in an ArrayList.
 
 - LoggerContext has a cache of existing loggers in a map. This
-  significantly improves the performance of retrival of existing
+  significantly improves the performance of retrieval of existing
   loggers.
 
 
-Memomy footprint for 1000 loggers:
+Memory footprint for 1000 loggers:
 ==================================
 
 The memory consumption of various logger implementations are shown
@@ -27,7 +27,7 @@ LOG4J implementation.
 The logger cache adds a memory overhead but very significantly
 improves the efficiency of retreiving an existing logger.
 
-The mem foorprint without the logger cache:
+The mem footprint without the logger cache:
 
  73 kB - 2,046 alloc. com.logback.LoggerCreation.testListLoggers
 
@@ -47,7 +47,7 @@ CategoryKey for every call to the Hierarchy.getLogger method.
 Speed of creating of a logger:
 ==============================
 
-Emtpy logger creation:  1229 nanoseconds per creation.
+Empty logger creation:  1229 nanoseconds per creation.
 List  logger creation: 13139 nanoseconds per creation.
 JUL   logger creation: 61990 nanoseconds per creation.
 LOG4J logger creation: 23503 nanoseconds per creation.

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/Level.java b/logback-classic/src/main/java/ch/qos/logback/classic/Level.java
@@ -235,7 +235,7 @@ public static Level toLevel(final String sArg, Level defaultLevel) {
     }
 
     /**
-     * Return the flyweight instance of the level received through serizalization,
+     * Return the flyweight instance of the level received through serialization,
      * i.e. 'this'.
      *
      * @return The appropriate flyweight instance

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java b/logback-classic/src/main/java/ch/qos/logback/classic/PatternLayout.java
@@ -53,7 +53,7 @@ public class PatternLayout extends PatternLayoutBase<ILoggingEvent> {
 
         DEFAULT_CONVERTER_MAP.put("d", DateConverter.class.getName());
         DEFAULT_CONVERTER_MAP.put("date", DateConverter.class.getName());
-        // used by PrefixComposite conventer
+        // used by PrefixComposite converter
         CONVERTER_CLASS_TO_KEY_MAP.put(DateConverter.class.getName(), "date");
 
         DEFAULT_CONVERTER_MAP.put("ms", MicrosecondConverter.class.getName());

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/helpers/MDCInsertingServletFilter.java b/logback-classic/src/main/java/ch/qos/logback/classic/helpers/MDCInsertingServletFilter.java
@@ -76,7 +76,7 @@ void clearMDC() {
         MDC.remove(ClassicConstants.REQUEST_REMOTE_HOST_MDC_KEY);
         MDC.remove(ClassicConstants.REQUEST_REQUEST_URI);
         MDC.remove(ClassicConstants.REQUEST_QUERY_STRING);
-        // removing possibly inexistent item is OK
+        // removing possibly nonexistent item is OK
         MDC.remove(ClassicConstants.REQUEST_REQUEST_URL);
         MDC.remove(ClassicConstants.REQUEST_METHOD);
         MDC.remove(ClassicConstants.REQUEST_USER_AGENT_MDC_KEY);

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/log4j/XMLLayout.java b/logback-classic/src/main/java/ch/qos/logback/classic/log4j/XMLLayout.java
@@ -52,7 +52,7 @@ public void start() {
     /**
      * The <b>LocationInfo</b> option takes a boolean value. By default, it is set
      * to false which means there will be no location information output by this
-     * layout. If the the option is set to true, then the file name and line number
+     * layout. If the option is set to true, then the file name and line number
      * of the statement at the origin of the log statement will be output.
      * 
      * <p>

diff --git a/...assic/src/main/java/ch/qos/logback/classic/model/processor/ConfigurationModelHandler.java b/...assic/src/main/java/ch/qos/logback/classic/model/processor/ConfigurationModelHandler.java
@@ -58,7 +58,7 @@ public void handle(ModelInterpretationContext mic, Model model) {
 
         ConfigurationModel configurationModel = (ConfigurationModel) model;
 
-        // See LOGBACK-527 (the system property is looked up first. Thus, it overrides
+        // See LOGBACK-527 (the system property is looked up first). Thus, it overrides
         // the equivalent property in the config file. This reversal of scope priority
         // is justified
         // by the use case: the admin trying to chase rogue config file

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/model/util/DefaultClassNameHelper.java b/logback-classic/src/main/java/ch/qos/logback/classic/model/util/DefaultClassNameHelper.java
@@ -25,7 +25,7 @@
  * Injects missing class names into ImplicitModel instances missing class name.
  * 
  * @author ceki
- * @since 1.3.0-aplha15
+ * @since 1.3.0-alpha15
  */
 public class DefaultClassNameHelper {
 

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/net/SimpleSSLSocketServer.java b/logback-classic/src/main/java/ch/qos/logback/classic/net/SimpleSSLSocketServer.java
@@ -31,7 +31,7 @@
  * </pre>
  * 
  * where <em>port</em> is a port number where the server listens and
- * <em>configFile</em> is an xml configuration file fed to
+ * <em>configFile</em> is an XML configuration file fed to
  * {@link JoranConfigurator}.
  * 
  * When running the SimpleSSLServerFactory as shown above, it is necessary to

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/net/SimpleSocketServer.java b/logback-classic/src/main/java/ch/qos/logback/classic/net/SimpleSocketServer.java
@@ -37,7 +37,7 @@
  * </pre>
  * 
  * where <em>port</em> is a port number where the server listens and
- * <em>configFile</em> is an xml configuration file fed to
+ * <em>configFile</em> is an XML configuration file fed to
  * {@link JoranConfigurator}.
  * 
  * </pre>
@@ -205,7 +205,7 @@ public void socketNodeClosing(SocketNode sn) {
 
         // don't allow simultaneous access to the socketNodeList
         // (e.g. removal whole iterating on the list causes
-        // java.util.ConcurrentModificationException
+        // java.util.ConcurrentModificationException)
         synchronized (socketNodeList) {
             socketNodeList.remove(sn);
         }

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java b/logback-classic/src/main/java/ch/qos/logback/classic/net/SyslogAppender.java
@@ -63,7 +63,7 @@ public SyslogOutputStream createOutputStream() throws SocketException, UnknownHo
 
     /**
      * Convert a level to equivalent syslog severity. Only levels for printing
-     * methods i.e DEBUG, WARN, INFO and ERROR are converted.
+     * methods i.e. DEBUG, WARN, INFO and ERROR are converted.
      *
      * @see ch.qos.logback.core.net.SyslogAppenderBase#getSeverityForEvent(java.lang.Object)
      */
@@ -172,7 +172,7 @@ public String getStackTracePattern() {
      * Stack trace lines are sent to the syslog server separately from the main
      * message For stack trace lines, the stackTracePattern is used instead of
      * {@link #suffixPattern}. The <b>stackTracePattern</b> option allows
-     * specification of a separately format for the non-standardized part of stack
+     * specification of a separate format for the non-standardized part of stack
      * trace lines.
      *
      * @param stackTracePattern
@@ -181,4 +181,4 @@ public String getStackTracePattern() {
     public void setStackTracePattern(String stackTracePattern) {
         this.stackTracePattern = stackTracePattern;
     }
-}
+}
diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/pattern/EnsureExceptionHandling.java b/logback-classic/src/main/java/ch/qos/logback/classic/pattern/EnsureExceptionHandling.java
@@ -59,7 +59,7 @@ public void process(Context context, Converter<ILoggingEvent> head) {
      * This method computes whether a chain of converters handles exceptions or not.
      * 
      * @param head The first element of the chain
-     * @return true if can handle throwables contained in logging events
+     * @return true if it can handle throwables contained in logging events
      */
     public boolean chainHandlesThrowable(Converter<ILoggingEvent> head) {
         Converter<ILoggingEvent> c = head;
@@ -79,8 +79,8 @@ public boolean chainHandlesThrowable(Converter<ILoggingEvent> head) {
     /**
      * This method computes whether a composite converter handles exceptions or not.
      *
-     * @param converter The composite converter
-     * @return true if can handle throwables contained in logging events
+     * @param compositeConverter The composite converter
+     * @return true if it can handle throwables contained in logging events
      */
     public boolean compositeHandlesThrowable(CompositeConverter<ILoggingEvent> compositeConverter) {
         Converter<ILoggingEvent> childConverter = compositeConverter.getChildConverter();

diff --git a/...ck-classic/src/main/java/ch/qos/logback/classic/pattern/LocalSequenceNumberConverter.java b/...ck-classic/src/main/java/ch/qos/logback/classic/pattern/LocalSequenceNumberConverter.java
@@ -17,7 +17,7 @@
 import java.util.concurrent.atomic.AtomicLong;
 
 /**
- * A converters based on a a locally incremented sequence number. The sequence
+ * A converters based on a locally incremented sequence number. The sequence
  * number is initialized to the number of milliseconds elapsed since 1970-01-01
  * until this instance is initialized.
  *

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/pattern/NamedConverter.java b/logback-classic/src/main/java/ch/qos/logback/classic/pattern/NamedConverter.java
@@ -223,9 +223,8 @@ void updateMilestones() {
             int effectiveTotal = NamedConverter.this.totalCalls - totalsMilestone;
 
             if (effectiveTotal < MIN_SAMPLE_SIZE) {
-                // cache miss rate cannot be negative. Woth a negative value, we signal the
-                // caller of
-                // insufficient sample size.
+                // cache miss rate cannot be negative. With a negative value, we signal the
+                // caller of insufficient sample size.
                 return NEGATIVE;
             }
 

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/sift/SiftingAppender.java b/logback-classic/src/main/java/ch/qos/logback/classic/sift/SiftingAppender.java
@@ -24,7 +24,7 @@
 import org.slf4j.Marker;
 
 /**
- * This appender can contains other appenders which it can build dynamically
+ * This appender can contain other appenders which it can build dynamically
  * depending on MDC values. The built appender is specified as part of a
  * configuration file.
  * 

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/spi/ILoggingEvent.java b/logback-classic/src/main/java/ch/qos/logback/classic/spi/ILoggingEvent.java
@@ -77,7 +77,7 @@ public interface ILoggingEvent extends DeferredProcessingAware {
      * 
      * This method is deprecated and exists solely for backward compatibility
      * reasons. Logback components should use {@link #getMarkerList()} and cater for
-     * all available markers and not the only the first one.
+     * all available markers and not only the first one.
      * 
      * @deprecated Replaced by {@link #getMarkerList()}
      * @return the first marker in the marker list or null if no markers are

diff --git a/logback-classic/src/main/java/ch/qos/logback/classic/spi/LoggerContextVO.java b/logback-classic/src/main/java/ch/qos/logback/classic/spi/LoggerContextVO.java
@@ -25,7 +25,7 @@
  * 
  * <p>
  * Some of the LoggerContext or Logger attributes MUST not survive
- * serialization, e.g appenders, level values etc, as these attributes may have
+ * serialization, e.g. appenders, level values etc., as these attributes may have
  * other values on the remote platform. LoggerContextVO class exposes the
  * minimal and relevant attributes to the remote host, instead of having to deal
  * with an incomplete LoggerContext with many null references.
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,7 +7,7 @@ @@
       <body>
-        <p>Contains the Joran configration classes</p>
+        <p>Contains the Joran configuration classes</p>
       </body>
-    </html>
+    </html>