Log4cxx
  1. Log4cxx
  2. LOGCXX-192

Suggested improvements to log4cxx webpages

    Details

    • Type: Improvement Improvement
    • Status: Resolved
    • Priority: Trivial Trivial
    • Resolution: Fixed
    • Affects Version/s: 0.10.0
    • Fix Version/s: 0.10.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      Here are a few suggestions for the current (as of 3-Sep-07) web pages for log4cxx...

      http://logging.apache.org/log4cxx/
      In the following paragraph, the "INSTALL" link appears to be non-functional. Also, suggest replacing "at this moment" with today's date.
      -----------------------------------------------------------
      Build instructions are contained in the INSTALL. An Ant build which uses the <cc> and <foreach> tasks from the Ant-Contrib Project is used for most day-to-day development. The Ant build can produce IDE project files for Microsoft Visual Studio 6, Borland CBuilderX and Apple XCode on request. The Ant build can also download and build APR and CppUnit. An autotools build file is also provided but at this moment is incompatible with some versions of autotools (LOGCXX-44).

      http://logging.apache.org/log4cxx/manual.html
      In the following paragraph, the "Apache license" link appears to be non-functional.
      ----------------------------------------------------------
      The log4cxx framework is patterned after log4j. log4cxx is licensed under the Apache License, an open source license certified by the Open Source Initiative.

      IS:

      Experience indicates that logging was an important component of the development cycle. It offeres several advantages. It provides precise context about a run of the application. Once inserted into the code, the generation of logging output requires no human intervention. Moreover, log output can be saved in persistent medium to be studied at a later time. In addition to its use in the development cycle, a sufficiently rich logging package can also be viewed as an auditing tool.
      SHOULD BE:
      ----------
      Experience indicates that logging is an important component of the development cycle. It offers several advantages. It provides precise context about a run of the application. Once inserted into the code, the generation of logging output requires no human intervention. Moreover, log output can be saved in persistent medium to be studied at a later time. In addition to its use in the development cycle, a sufficiently rich logging package can also be viewed as an auditing tool.

      IS:

      #define LOG4CXX_TRACE(logger, msg) ...
      #define LOG4CXX_DEBUG(logger, msg) ...
      #define LOG4CXX_INFO(logger, msg) ...
      #define LOG4CXX_WARN(logger, msg) ...
      #define LOG4CXX_ERROR(logger, msg) ...
      #define LOG4CXX_FATAL(logger, msg) ...

      Loggers may be assigned levels. The pre-defined levels: TRACE, DEBUG, INFO, WARN, ERROR and FATAL are defined in the log4cxx::Level class which provides accessor functions.
      SUGGESTION:
      ----------
      Eliminate references to "trace": It's my understanding that "trace" is not implemented in log4cxx. (If I'm mistaken, ignore this suggestion.) There are other references to "trace" elsewhere on the webpage, which should be eliminated also.

      PARAGRAPH "Default Initialization Procedure"
      --------------------------------------------
      Has a Section 1, but missing the Section 2 number.

      IS:

      The typical cost of walking the hierarchy is typically 3 times slower than when logging is turned off entirely.
      SHOULD BE:
      ----------
      The cost of walking the hierarchy is typically 3 times slower than when logging is turned off entirely.

        Activity

        No work has yet been logged on this issue.

          People

          • Assignee:
            Curt Arnold
            Reporter:
            Paul Wilfong
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development