You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by ol...@apache.org on 2013/08/10 14:25:49 UTC
[08/22] git commit: improved logging documentation
improved logging documentation
Project: http://git-wip-us.apache.org/repos/asf/maven/repo
Commit: http://git-wip-us.apache.org/repos/asf/maven/commit/03489ffa
Tree: http://git-wip-us.apache.org/repos/asf/maven/tree/03489ffa
Diff: http://git-wip-us.apache.org/repos/asf/maven/diff/03489ffa
Branch: refs/heads/guice-from-google
Commit: 03489ffa549dd5466a8c674879e579fab49e7fc8
Parents: 3641991
Author: Hervé Boutemy <hb...@apache.org>
Authored: Fri Aug 2 01:27:07 2013 +0200
Committer: Olivier Lamy <ol...@apache.org>
Committed: Sat Aug 10 21:46:50 2013 +1000
----------------------------------------------------------------------
maven-embedder/src/site/apt/logging.apt | 32 ++++++++++++++++++++++------
1 file changed, 25 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/maven/blob/03489ffa/maven-embedder/src/site/apt/logging.apt
----------------------------------------------------------------------
diff --git a/maven-embedder/src/site/apt/logging.apt b/maven-embedder/src/site/apt/logging.apt
index 1f1c4ed..0e84041 100644
--- a/maven-embedder/src/site/apt/logging.apt
+++ b/maven-embedder/src/site/apt/logging.apt
@@ -20,22 +20,39 @@
-----
Hervé Boutemy
-----
- 2012-04-29
+ 2013-08-02
-----
Maven Logging
+ End-user logging documentation is available {{{/maven-logging.html}in Maven site}}.
+ This documentation is focused on internal implementation details.
+
+* Logging API
+
Maven uses
{{{http://plexus.codehaus.org/plexus-containers/plexus-container-default/apidocs/org/codehaus/plexus/logging/package-summary.html}Plexus
Container logging API}}, like any other Plexus components, ie
{{{http://plexus.codehaus.org/plexus-containers/plexus-container-default/apidocs/org/codehaus/plexus/logging/LoggerManager.html}LoggerManager}}
/ {{{http://plexus.codehaus.org/plexus-containers/plexus-container-default/apidocs/org/codehaus/plexus/logging/Logger.html}Logger}}.
- Starting with Maven 3.1.0, instead of implementing the API itself,
- Maven maps to {{{http://slf4j.org/apidocs/}SLF4J API}}'s {{{http://slf4j.org/apidocs/org/slf4j/ILoggerFactory.html}ILoggerFactory}}
- / {{{http://slf4j.org/apidocs/org/slf4j/Logger.html}Logger}} through
- {{{./apidocs/org/apache/maven/cli/logging/Slf4jLoggerManager.html}Slf4jLoggerManager}}
- / {{{./apidocs/org/apache/maven/cli/logging/Slf4jLogger.html}Slf4jLogger}}.
+ Starting with Maven 3.1.0:
+
+ * Maven supports SLF4J API logging API too, ie {{{http://slf4j.org/apidocs/org/slf4j/LoggerFactory.html}LoggerFactory}} /
+ {{{http://slf4j.org/apidocs/org/slf4j/Logger.html}Logger}},
+
+ * instead of implementing Plexus logging API itself with basic output to console, Maven implements it using SLF4J API in
+ {{{./apidocs/org/apache/maven/cli/logging/Slf4jLoggerManager.html}Slf4jLoggerManager}}
+ / {{{./apidocs/org/apache/maven/cli/logging/Slf4jLogger.html}Slf4jLogger}}.
+
+
+* Logging Implementation
+
+ Maven 3.1.0 ships bundled with {{{http://www.slf4j.org/apidocs/org/slf4j/impl/SimpleLogger.html}SLF4J simple logger}},
+ but is ready to use other logging implementations:
+ {{{./apidocs/org/apache/maven/cli/logging/Slf4jConfigurationFactory.html}Slf4jConfigurationFactory}} /
+ {{{./apidocs/org/apache/maven/cli/logging/Slf4jConfiguration.html}Slf4jConfiguration}} brings extensions to slf4j API
+ necessary to Maven.
* Getting Logger Instance
@@ -59,7 +76,8 @@ public class DefaultMyComponent
+------+
Starting with Maven 3.1.0, SLF4J Logger can be used directly too, without Plexus. Of course, this will only work when run under
- Maven 3.1.0, then this technique can be used safely only in Maven core components.
+ Maven 3.1.0, then this technique can be used safely only in Maven core components or in plugins/component not requiring
+ compatibility with previous Maven versions.
+-----+
import org.slf4j.Logger;