You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2018/04/08 19:17:33 UTC
[1/2] logging-log4j2 git commit: LOG4J2-1802: Convert scala api
manual page to asciidoc
Repository: logging-log4j2
Updated Branches:
refs/heads/master 71b1f20f6 -> 04daf2a7d
LOG4J2-1802: Convert scala api manual page to asciidoc
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/d39e4751
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/d39e4751
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/d39e4751
Branch: refs/heads/master
Commit: d39e4751fbdad254138de44292aeea22a418eaad
Parents: 71b1f20
Author: Matt Sicker <bo...@gmail.com>
Authored: Sun Apr 8 14:08:02 2018 -0500
Committer: Matt Sicker <bo...@gmail.com>
Committed: Sun Apr 8 14:08:02 2018 -0500
----------------------------------------------------------------------
src/site/asciidoc/manual/scala-api.adoc | 80 ++++++++++++++++++++++++
src/site/xdoc/manual/scala-api.xml | 93 ----------------------------
2 files changed, 80 insertions(+), 93 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/d39e4751/src/site/asciidoc/manual/scala-api.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/manual/scala-api.adoc b/src/site/asciidoc/manual/scala-api.adoc
new file mode 100644
index 0000000..d02f964
--- /dev/null
+++ b/src/site/asciidoc/manual/scala-api.adoc
@@ -0,0 +1,80 @@
+////
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ https://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+////
+= Log4j 2 Scala API
+Mikael Ståldal <mi...@apache.org>
+
+Log4j 2 has a companion Log4j Scala project that contains a convenient
+Scala wrapper for the
+link:../log4j-api/apidocs/org/apache/logging/log4j/Logger.html[`Logger`]
+API.
+
+== Requirements
+
+Log4j 2 Scala API is dependent on the Log4j 2 API, Scala runtime library
+and reflection. It currently supports Scala 2.10, 2.11 and 2.12. See
+link:../maven-artifacts.html#Scala_API[instructions] on including this
+in an SBT, Maven, Ivy, or Gradle project.
+
+== Example
+
+[source,scala]
+----
+import org.apache.logging.log4j.scala.Logging
+import org.apache.logging.log4j.Level
+
+class MyClass extends BaseClass with Logging {
+ def doStuff(): Unit = {
+ logger.info("Doing stuff")
+ }
+ def doStuffWithLevel(level: Level): Unit = {
+ logger(level, "Doing stuff with arbitrary level")
+ }
+}
+----
+
+The output from the call to `logger.info()` will vary significantly
+depending on the configuration used. See the
+link:./configuration.html[Configuration] section for more details.
+
+== Substituting Parameters
+
+Frequently the purpose of logging is to provide information about what
+is happening in the system, which requires including information about
+the objects being manipulated. In Scala, you can use
+http://docs.scala-lang.org/overviews/core/string-interpolation.html[string
+interpolation] to achieve this:
+
+[source,scala]
+----
+logger.debug(s"Logging in user ${user.getName} with birthday ${user.calcBirthday}")
+----
+
+Since the Scala Logger is implemented with macros, the String
+construction and method invocations will only occur when debug logging
+is enabled.
+
+== Logger Names
+
+Most logging implementations use a hierarchical scheme for matching
+logger names with logging configuration. In this scheme the logger name
+hierarchy is represented by '.' characters in the logger name, in a
+fashion very similar to the hierarchy used for Java/Scala package names.
+The Logging trait will automatically name the Logger accordingly to the
+class it is being used in.
+
+Please see the http://logging.apache.org/log4j/scala/index.html[Log4j
+Scala] project for more details.
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/d39e4751/src/site/xdoc/manual/scala-api.xml
----------------------------------------------------------------------
diff --git a/src/site/xdoc/manual/scala-api.xml b/src/site/xdoc/manual/scala-api.xml
deleted file mode 100644
index 61e3222..0000000
--- a/src/site/xdoc/manual/scala-api.xml
+++ /dev/null
@@ -1,93 +0,0 @@
-<?xml version="1.0"?>
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<document xmlns="http://maven.apache.org/XDOC/2.0"
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
- <properties>
- <title>Log4j 2 Scala API</title>
- <author email="mikes@apache.org">Mikael Ståldal</author>
- </properties>
-
- <body>
- <section name="Log4j 2 API">
- <a name="ScalaAPI"/>
- <subsection name="Scala API">
- <p>
- Log4j 2 has a companion Log4j Scala project that contains a convenient Scala wrapper for the
- <a class="javadoc" href="../log4j-api/apidocs/org/apache/logging/log4j/Logger.html">Logger</a>
- API.
- </p>
-
- <h4>Requirements</h4>
- <p>
- Log4j 2 Scala API is dependent on the Log4j 2 API, Scala runtime library and reflection.
- It currently supports Scala 2.10, 2.11 and 2.12. See <a href="../maven-artifacts.html#Scala_API">instructions</a>
- on including this in an SBT, Maven, Ivy, or Gradle project.
- </p>
-
- <h4>Example</h4>
- <pre class="prettyprint linenums">
-import org.apache.logging.log4j.scala.Logging
-import org.apache.logging.log4j.Level
-
-class MyClass extends BaseClass with Logging {
- def doStuff(): Unit = {
- logger.info("Doing stuff")
- }
- def doStuffWithLevel(level: Level): Unit = {
- logger(level, "Doing stuff with arbitrary level")
- }
-}
- </pre>
- <p>
- The output from the call to logger.info() will vary significantly depending on the configuration
- used. See the
- <a href="./configuration.html">Configuration</a>
- section for more details.
- </p>
- <h4>Substituting Parameters</h4>
- <p>
- Frequently the purpose of logging is to provide information about what is happening in the system,
- which requires including information about the objects being manipulated. In Scala, you can use
- <a href="http://docs.scala-lang.org/overviews/core/string-interpolation.html">string interpolation
- </a>
- to achieve this:
- </p>
- <pre class="prettyprint">
-logger.debug(s"Logging in user ${user.getName} with birthday ${user.calcBirthday}")
- </pre>
- <p>
- Since the Scala Logger is implemented with macros, the String construction and method invocations
- will only occur when debug logging is enabled.
- </p>
-
- <h4>Logger Names</h4>
- <p>
- Most logging implementations use a hierarchical scheme for matching logger names with logging
- configuration. In this scheme the logger name hierarchy is represented by '.' characters in the
- logger name, in a fashion very similar to the hierarchy used for Java/Scala package names.
- The Logging trait will automatically name the Logger accordingly to the class it is being used in.
- </p>
-
- <p>Please see the <a href="http://logging.apache.org/log4j/scala/index.html">Log4j Scala</a> project for more details.</p>
-
- </subsection>
- </section>
- </body>
-</document>
[2/2] logging-log4j2 git commit: Fix typo
Posted by ma...@apache.org.
Fix typo
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j2/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j2/commit/04daf2a7
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j2/tree/04daf2a7
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j2/diff/04daf2a7
Branch: refs/heads/master
Commit: 04daf2a7de0084e95eac1568dd9d6c2ebde688ac
Parents: d39e475
Author: Matt Sicker <bo...@gmail.com>
Authored: Sun Apr 8 14:17:28 2018 -0500
Committer: Matt Sicker <bo...@gmail.com>
Committed: Sun Apr 8 14:17:28 2018 -0500
----------------------------------------------------------------------
src/site/asciidoc/manual/index.adoc | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j2/blob/04daf2a7/src/site/asciidoc/manual/index.adoc
----------------------------------------------------------------------
diff --git a/src/site/asciidoc/manual/index.adoc b/src/site/asciidoc/manual/index.adoc
index 746607f..a2313b2 100644
--- a/src/site/asciidoc/manual/index.adoc
+++ b/src/site/asciidoc/manual/index.adoc
@@ -59,7 +59,7 @@ judiciously-placed displays. It takes less time to decide where to put
print statements than to single-step to the critical section of code,
even assuming we know where that is. More important, debugging
statements stay with the program; debugging sessions are transient.
-____d
+____
Logging does have its drawbacks. It can slow down an application. If too
verbose, it can cause scrolling blindness. To alleviate these concerns,