This is an automated email from the ASF dual-hosted git repository. swebb2066 pushed a commit to branch fix_web_site_formatting in repository https://gitbox.apache.org/repos/asf/logging-log4cxx.git
commit 33447d3625d468f868e86fe7d5dcc59984aaa59c Author: Stephen Webb <[email protected]> AuthorDate: Sun Feb 15 14:36:22 2026 +1100 Improve some web site formatting and grammar --- src/main/include/log4cxx/db/dbappender.h | 2 +- src/main/include/log4cxx/fileappender.h | 11 +++++------ src/site/markdown/concepts.md | 26 +++++++++++++------------- src/site/markdown/configuration-samples.md | 8 ++++---- src/site/markdown/example-programs.md | 10 +++++----- 5 files changed, 28 insertions(+), 29 deletions(-) diff --git a/src/main/include/log4cxx/db/dbappender.h b/src/main/include/log4cxx/db/dbappender.h index ce27a52c..d7d494d6 100644 --- a/src/main/include/log4cxx/db/dbappender.h +++ b/src/main/include/log4cxx/db/dbappender.h @@ -51,7 +51,7 @@ namespace db * Once you have defined the table, you must define the order in which the columns are formatted when they are inserted * along with the insert statement. * - * Using APR, the following insert statement can be used to insert log statements: <code>INSERT INTO logs (logger, time, level, file, line_number, message) VALUES (%s, %pDa, %s, %s, %d, %s)</code> + * Using APR, the following insert statement can be used to insert log statements: <code>INSERT INTO logs (logger, time, level, file, line_number, message) VALUES (%%s, %%pDa, %%s, %%s, %%d, %%s)</code> * The values to insert must be formatted appropriately and in the correct order. In order to do this, the parameter <code>ColumnMapping</code> must be specified as many times * as there are columns to insert. * diff --git a/src/main/include/log4cxx/fileappender.h b/src/main/include/log4cxx/fileappender.h index eb72f58d..48d01c6c 100644 --- a/src/main/include/log4cxx/fileappender.h +++ b/src/main/include/log4cxx/fileappender.h @@ -137,10 +137,10 @@ class LOG4CXX_EXPORT FileAppender : public WriterAppender ImmediateFlush | True,False | False | BufferSize | (\ref fileSz1 "1") | 8 KB | - \anchor fileSz1 (1) An integer in the range 0 - 2^63. - You can specify the value with the suffixes "KB", "MB" or "GB" so that the integer is - interpreted being expressed respectively in kilobytes, megabytes - or gigabytes. For example, the value "10KB" will be interpreted as 10240. + \anchor fileSz1 (1) An integer in the range 0 - 2^32. + You can specify the value with the suffixes "KB" or "MB" so that the integer is + interpreted being expressed respectively in kilobytes or megabytes. + For example, the value "10KB" will be interpreted as 10240. \sa AppenderSkeleton::setOption() */ @@ -149,8 +149,7 @@ class LOG4CXX_EXPORT FileAppender : public WriterAppender /** Get the value of the <b>BufferedIO</b> option. - <p>BufferedIO will significatnly increase performance on heavily - loaded systems. + <p>Using buffered output will significantly reduce logging overhead. */ bool getBufferedIO() const; diff --git a/src/site/markdown/concepts.md b/src/site/markdown/concepts.md index 4611239d..2c2e6830 100644 --- a/src/site/markdown/concepts.md +++ b/src/site/markdown/concepts.md @@ -41,7 +41,7 @@ A Log4cxx category is a name and it is held by a log4cxx::Logger instance. The name of the class in which the logging request appears is a commonly used naming scheme but any category naming scheme may be used. -Logging category names (or equivalently logger name) +Logging category names (or equivalently, logger name) are case-sensitive. ## Naming {#naming} @@ -53,7 +53,7 @@ a useful and straightforward method of defining loggers. As the log output bears the name of the generating logger, this naming strategy makes it easy to identify the origin of a log message. However, this is only one possible, albeit common, strategy for naming loggers. Log4cxx -does not restrict the possible set of loggers. The developer is free to +does not constrain the set of possible loggers. The developer is free to name the loggers as desired. Nevertheless, naming loggers after the class where they are located @@ -70,7 +70,7 @@ named `com.foo.Bar`. Similarly, `java` is a parent of `java.util` and an ancestor of `java.util.Vector`. This naming scheme should be familiar to most developers. -Sometimes a per object logger is useful. +Sometimes a per-object logger is useful. When each class instance has a identifiable name (e.g. when it is instantiated from configuration data) add a member variable to hold a log4cxx::LoggerInstancePtr @@ -140,14 +140,14 @@ For example, in Thus, it is possible to configure a logger and then to retrieve the same instance somewhere else in the code without passing around references. In fundamental contradiction to biological parenthood, where parents -always preceed their children, Log4cxx loggers can be created and +always precede their children, Log4cxx loggers can be created and configured in any order. In particular, a "parent" logger will find and link to its descendants even if it is instantiated after them. ## Requests {#requests} Logging requests are made by invoking a method of a logger instance, -preferrably through the use of LOG4CXX\_INFO or similar macros which +preferably through the use of LOG4CXX\_INFO or similar macros which support short-circuiting if the threshold is not satisfied and use of the insertion operator (\<\<) in the message parameter. @@ -240,12 +240,12 @@ can generate thousands of log requests. Much effort was spent measuring and tweaking logging performance. Log4cxx claims to be fast and flexible: speed first, flexibility second. -For performance sensitive applications, you should be aware of the following. +For performance-sensitive applications, you should be aware of the following. 1. **Logging performance when logging is turned off.** The LOG4CXX\_DEBUG and similar macros have a - cost of an in-lined null pointer check plus an integer comparison + cost of an inlined null pointer check plus an integer comparison when the logger not currently enabled for that level. The other terms inside the macro are not evaluated. @@ -263,10 +263,10 @@ For performance sensitive applications, you should be aware of the following. 3. **The cost of changing a logger's level.** The threshold value stored in any child logger is updated. - This is done iterating over the map of all known logger objects + This is done by iterating over the map of all known logger objects and walking the hierarchy of each. - There has been a serious effort to make this hierarchy walk to be as + There has been a serious effort to make this hierarchy walk as fast as possible. For example, child loggers link only to their existing ancestors. In the *BasicConfigurator* example shown earlier, the logger named *com.foo.Bar* is linked directly to the @@ -309,7 +309,7 @@ The levels are set as follows: (1) The `LOG4CXX_ASSERT` macro is the same level as `LOG4CXX_ERROR` -Note that this has no effect on other macros, such as using the +Note that this does not effect other macros, such as the `LOG4CXX_LOG`, `LOG4CXX_LOGLS`, or `LOG4CXX_L7DLOG` family of macros. ### Removing location information {#removing-location-information} @@ -319,7 +319,7 @@ logging statement is captured as well through the preprocessor. This includes the file name, the method name, and the line number. If you would not like to include this information in your build but you still wish to keep the log statements, define `LOG4CXX_DISABLE_LOCATION_INFO` in your build system. This -will allow log messages to still be created, but the location information +will allow log message creation, but the location information will be invalid. ## Levels {#levels} @@ -475,7 +475,7 @@ See \ref async-example.xml for a configuration file example. ## Additivity {#appender-additivity} The logger used in each enabled logging request sends a logging event -to the all the appenders attached to it. +to all the the appenders attached to it. The logger also forwards the event to loggers higher in the hierarchy, and therefore the event is also sent to the appenders attached to those loggers. For example, if a console appender is added to the root logger, then all @@ -560,7 +560,7 @@ and a sample output message. ## Pattern 1 {#pattern1} -This pattern contains the date in an ISO-8601 format(without fractional seconds), +This pattern contains the date in an ISO-8601 format (without fractional seconds), followed by the logger name, the level, and then the message. ~~~ diff --git a/src/site/markdown/configuration-samples.md b/src/site/markdown/configuration-samples.md index 48741276..e884dc98 100644 --- a/src/site/markdown/configuration-samples.md +++ b/src/site/markdown/configuration-samples.md @@ -68,7 +68,7 @@ A full example can be seen in the \ref com/foo/config4.cpp file. # Runtime Property Values {#runtime-property-values} -The value of an enviroment variable can be used in a property value. +The value of an environment variable can be used in a property value. Instances of the form <b>${VarName}</b> will be replaced with the value of the environment variable <b>VarName</b>. A warning message is output to stderr if the closing brace is absent. @@ -88,7 +88,7 @@ relative to the executable location, not just the current working directory. The variable names are [documented here](@ref log4cxx.spi.Configurator.properties). -To check the correct values are used when your configuration file is loaded, +To check that the correct values are used when your configuration file is loaded, use [Log4cxx internal debugging]. # Configuring a logger to use asynchronous output {#asynch-output} @@ -98,8 +98,8 @@ to a logger using a configuration file. - If using a properties file, add the line <code>log4j.asynchronous.{LOGGER_NAME}=true</code> to your file - If using an XML file, add the <code>asynchronous="true"</code> attribute in the <code>\<logger></code> element. -The "asynchronous" attribute is only relevent for a logger with attached appenders. -The attribute is ignored if the logger does not have any directly attached appenders. +The "asynchronous" attribute is only relevant for a logger with attached appenders. +The attribute is ignored if the logger has no directly attached appenders. The "asynchronous" attribute results in the configured appender(s) being attached an [AsyncAppender](@ref log4cxx.AsyncAppender) diff --git a/src/site/markdown/example-programs.md b/src/site/markdown/example-programs.md index ea17b662..4ef777ea 100644 --- a/src/site/markdown/example-programs.md +++ b/src/site/markdown/example-programs.md @@ -30,15 +30,15 @@ application *MyApp* that uses Log4cxx. # A Simple Example {#example1} -In order to start using Log4cxx, a simple example program is shown below. -This program does nothing useful, but it shows the basics of how to start using Log4cxx. +A simple example program using Log4cxx is shown below. +This program does nothing useful, but it exhibits basic usage of Log4cxx. Using the [BasicConfigurator](@ref log4cxx.BasicConfigurator) class, we are able to quickly configure the library -to output DEBUG, INFO, etc level messages to standard output. +to output DEBUG, INFO, etc., level messages to standard output. \include MyApp1.cpp The above application does nothing useful except to show how to initialize logging with the BasicConfigurator and do logging with different loggers. -Note that file based configurations are also possible - +Note that file-based configurations are also possible - see [DOMConfigurator](@ref log4cxx.xml.DOMConfigurator.configure) and [PropertyConfigurator](@ref log4cxx.PropertyConfigurator.configure). @@ -186,7 +186,7 @@ Note that to obtain these different logging behaviors we did not need to recompile code. We could just as easily have logged to a UNIX Syslog daemon, redirected all *com.foo* output to an NT Event logger, or forwarded logging events to a remote Log4cxx server, which would log -according to local server policy, for example by forwarding the log +according to local server policy, for example, by forwarding the log event to a second Log4cxx server. For more runtime configuration examples, see [Configuration Samples].
