svn commit: r1410815 - in /maven/maven-3/trunk/maven-embedder: pom.xml src/site/apt/index.apt src/site/apt/logging.apt

[hb...@apache.org]

Author: hboutemy
Date: Sun Nov 18 02:23:48 2012
New Revision: 1410815

URL: http://svn.apache.org/viewvc?rev=1410815&view=rev
Log:
added developer documentation about logging APIs

Added:
    maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt   (with props)
Modified:
    maven/maven-3/trunk/maven-embedder/pom.xml
    maven/maven-3/trunk/maven-embedder/src/site/apt/index.apt

Modified: maven/maven-3/trunk/maven-embedder/pom.xml
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-embedder/pom.xml?rev=1410815&r1=1410814&r2=1410815&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-embedder/pom.xml (original)
+++ maven/maven-3/trunk/maven-embedder/pom.xml Sun Nov 18 02:23:48 2012
@@ -22,7 +22,7 @@
   <artifactId>maven-embedder</artifactId>
 
   <name>Maven Embedder</name>
-  <description>Maven embeddable component, with CLI support.</description>
+  <description>Maven embeddable component, with CLI and logging support.</description>
 
   <dependencies>
     <dependency>

Modified: maven/maven-3/trunk/maven-embedder/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-embedder/src/site/apt/index.apt?rev=1410815&r1=1410814&r2=1410815&view=diff
==============================================================================
--- maven/maven-3/trunk/maven-embedder/src/site/apt/index.apt (original)
+++ maven/maven-3/trunk/maven-embedder/src/site/apt/index.apt Sun Nov 18 02:23:48 2012
@@ -10,4 +10,8 @@ ${project.name}
 
  ${project.description}
 
- See {{{./cli.html}CLI options}} reference.
\ No newline at end of file
+* References
+
+ * {{{./cli.html}CLI options}},
+
+ * {{{./logging.html}logging API}}.

Added: maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt
URL: http://svn.apache.org/viewvc/maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt?rev=1410815&view=auto
==============================================================================
--- maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt (added)
+++ maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt Sun Nov 18 02:23:48 2012
@@ -0,0 +1,39 @@
+ -----
+ Maven Logging
+ -----
+ Hervé Boutemy
+ -----
+ 2012-04-29
+ -----
+
+Maven Logging
+
+ 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}}.
+
+* Getting Logger Instance
+
+ Plexus Logger can be injected in Plexus component using Plexus annotations
+
++------
+import org.codehaus.plexus.logging.Logger;
+import org.codehaus.plexus.component.annotations.Component;
+import org.codehaus.plexus.component.annotations.Requirement;
+
+@Component( role = MyComponent.class )
+public class DefaultMyComponent
+    implements MyComponent
+{
+    @Requirement
+    private Logger logger;
+}
++------

Propchange: maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: maven/maven-3/trunk/maven-embedder/src/site/apt/logging.apt
------------------------------------------------------------------------------
    svn:keywords = Author Date Id Revision