You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by an...@apache.org on 2012/11/27 13:58:52 UTC
svn commit: r1414163 - in /maven/site/trunk/src/site/markdown:
maven-jsr330.md maven-logging.md
Author: andham
Date: Tue Nov 27 12:58:51 2012
New Revision: 1414163
URL: http://svn.apache.org/viewvc?rev=1414163&view=rev
Log:
Some minor text fixes.
Modified:
maven/site/trunk/src/site/markdown/maven-jsr330.md
maven/site/trunk/src/site/markdown/maven-logging.md
Modified: maven/site/trunk/src/site/markdown/maven-jsr330.md
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/markdown/maven-jsr330.md?rev=1414163&r1=1414162&r2=1414163&view=diff
==============================================================================
--- maven/site/trunk/src/site/markdown/maven-jsr330.md (original)
+++ maven/site/trunk/src/site/markdown/maven-jsr330.md Tue Nov 27 12:58:51 2012
@@ -7,14 +7,14 @@ Maven has a long history of using depend
uses - since 3.0-beta-3 - is based on [Guice 3.x][guice], which directly supports JSR-330.
If you are using [Plexus annotations and APIs][plexus-container] currently,
-there is no rush switch and no big bang conversions are necessary: Plexus, JSR-330 and Guice APIs all happily
-co-exist within Maven's core and you can choose to use JSR-330 when you wish. There are hundreds of components
+there is no rush to switch and no big bang conversions are necessary: Plexus, JSR-330 and Guice APIs all happily
+co-exist within Maven\'s core and you can choose to use JSR-330 when you wish. There are hundreds of components
written using the Plexus APIs, particularly components and plugins compatible with Maven 2,
then those APIs will be supported forever, or at least until Maven fully drops Maven 2 support.
-If you want to use JSR-330, you must understand that your code won't be compatible with Maven 2 or 3.0.x
-but only with Maven 3.1: even if JSR-330 is available in core since Maven 3.0-beta-3, it was made available to plugins and
-extensions only in Maven 3.1 (see [MNG-5343][MNG-5343] for more details).
+If you want to use JSR-330, you must understand that your code won\'t be compatible with Maven 2 or 3.0.x
+but only with Maven 3.1.0+: even if JSR-330 is available in core since Maven 3.0-beta-3, it was made available to plugins and
+extensions only in Maven 3.1.0 (see [MNG-5343][MNG-5343] for more details).
If you are interested the background of moving from Plexus to Guice and JSR-330, you can refer to the following articles:
@@ -24,7 +24,7 @@ If you are interested the background of
## How to use JSR-330
-When you use JSR-330 in Maven plugins or extensions, there are two things need to setup in your build.
+When you use JSR-330 in Maven plugins or extensions, there are two things you need to setup in your build.
First you want a dependency on `javax.inject` so you can use the `@Inject`, `@Named`, and `@Singleton` annotations
in your plugins and extensions. Second you need to setup the [`sisu-maven-plugin`][sisu-maven-plugin] to index the JSR-330 components
you want made available to Maven. The `sisu-maven-plugin` creates its index in `META-INF/sisu/javax.inject.Named`.
@@ -36,19 +36,19 @@ org.apache.maven.lifecycle.profiler.inte
org.apache.maven.lifecycle.profiler.internal.DefaultTimer
```
-Enumerating the implementations means that no classpath scanning is required to find them, which keeps Maven's
+Enumerating the implementations means that no classpath scanning is required in runtime to find them, which keeps Maven\'s
startup time fast. Note that our container is configured by default to only use the index. While this keeps things fast,
if you use JSR-330 components in dependencies that do not contain an index, those implementations will currently
not be discovered. This is a compromise that is reasonable given Maven is a command-line tool where startup speed
is important.
-## How to use JSR330 in extensions
+## How to use JSR-330 in extensions
-Let's take a look at an example extension. We'll take a look at the POM, and a little bit of the implementation
-so you can get an idea of how JSR-330 extensions work. Really it's just a simple JSR-330 components.
+Let\'s take a look at an example extension. We\'ll take a look at the POM, and a little bit of the implementation
+so you can get an idea of how JSR-330 extensions work. Really, it\'s just a simple JSR-330 component.
If you want to look at the full implementation, you can find it [here][tesla-profiler] on Github.
-Ok so let's take a look at the POM:
+Ok, so let\'s take a look at the POM:
```
<?xml version="1.0"?>
@@ -101,8 +101,8 @@ Ok so let's take a look at the POM:
```
So, as mentioned, we have the `javax.inject` dependency and the `sisu-maven-plugin` configured to create
-the JSR-330 component index. When you build and place the extension JAR in the `${MAVEN_HOME}/lib/ext`,
-it will automatically get picked up by the core. In the case of example, we have an implementation of
+the JSR-330 component index. When you build and place the extension JAR in the `${MAVEN_HOME}/lib/ext` folder,
+it will automatically get picked up by Maven. In the case of this example, we have an implementation of
an `EventSpy` that times the executions of individual mojos within a phase in the lifecycle.
```
@@ -196,11 +196,11 @@ public class LifecycleProfiler extends A
}
```
-## How to use JSR330 in plugins
+## How to use JSR-330 in plugins
-Let's take a look at an example plugin. The POM is setup in a similar way to an extension, but we add a dependency
-for the `maven-plugin-api` and the `maven-plugin-annotations` to extend the `AbstractMojo` and use
-the Java5 plugin annotations in our example.
+Let\'s take a look at an example plugin. The POM is setup in a similar way to an extension, but we add a dependency
+to `maven-plugin-api` and `maven-plugin-annotations` to extend the `AbstractMojo` and use the Java 5 plugin
+annotations in our example.
```
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -288,7 +288,7 @@ the Java5 plugin annotations in our exam
</project>
```
-Now let's take a look at the plugin code. You'll notice that we're using constructor injection
+Now let\'s take a look at the plugin code. You\'ll notice that we\'re using constructor injection
which makes testing a lot easier. If you want to test your `Jsr330Component`, you do not need the container
to instantiate the `Mojo`. In this simple case, you can actually test this plugin without using the plugin
testing harness because you can instantiate the `Jsr330Component` and `Jsr330Mojo` directly and wire
Modified: maven/site/trunk/src/site/markdown/maven-logging.md
URL: http://svn.apache.org/viewvc/maven/site/trunk/src/site/markdown/maven-logging.md?rev=1414163&r1=1414162&r2=1414163&view=diff
==============================================================================
--- maven/site/trunk/src/site/markdown/maven-logging.md (original)
+++ maven/site/trunk/src/site/markdown/maven-logging.md Tue Nov 27 12:58:51 2012
@@ -22,8 +22,8 @@ Maven 2.x and 3.0.x use [Plexus logging
to stdout.
We have reached the decision that [SLF4J][1] is the best option for a logging API.
-SLF4J has reached a certain level of Ubiquity and while SLF4J may not be perfect,
-it's the de facto standard and it's pointless to try and remake another one.
+SLF4J has reached a certain level of ubiquity and while SLF4J may not be perfect,
+it\'s the de facto standard and it\'s pointless to try and remake another one.
SLF4J is used by many prominent Java OSS projects including 15 Apache projects already.
There are many implementations to choose from, including [Logback][4] and [Log4j2][3].
@@ -36,8 +36,8 @@ combined with the [SLF4J Simple][2] impl
implementation, but we chose to start simple.
Looking at the distribution you will
-see the following layout where the `simplelogger.properties`, `slf4j-api-1.7.2-jar` and
-`slf4j-simple-1.7.2.jar` specifically relate to the SLF4J implementation:
+see the following layout where the `simplelogger.properties`, `slf4j-api-x.y.z-jar` and
+`slf4j-simple-x.y.z.jar` specifically relate to the SLF4J implementation:
<div class="source"><pre>
m2
@@ -54,15 +54,16 @@ m2
â  âââ settings.xml
âââ lib
âââ ...
- âââ slf4j-api-1.7.2.jar
- âââ slf4j-simple-1.7.2.jar
+ âââ slf4j-api-x.y.z.jar
+ âââ slf4j-simple-x.y.z.jar
âââ ...
</pre></div>
## Configuring logging
To configure logging with the [SLF4J Simple][2], you can edit the properties in the
-`${MAVEN_HOME}/conf/logging/simplelogger.properties` file.
+`${MAVEN_HOME}/conf/logging/simplelogger.properties` file. The following table lists
+the available configuration properties along with the SLF4J Simple defaults.
<table border="0" class="bodyTable">
<tr class="b">
@@ -114,7 +115,7 @@ of milliseconds since start up will be o
</tr>
</table>
-The default configuration looks like the following:
+The default configuration for Maven looks like the following:
<div class="source"><pre>
# Default Maven logging configuration
@@ -132,11 +133,11 @@ org.slf4j.simpleLogger.warnLevelString=W
## Changing the SLF4J implementation
If you want use a different logging implementation it is simply a matter of removing the slf4j-simple JAR
-from `lib` directory and replacing it with one of the alternative implementations, like [Log4j2][3] or [Logback][4].
+from the `lib` directory and replacing it with one of the alternative implementations, like [Log4j2][3] or [Logback][4].
[1]: http://slf4j.org
[2]: http://www.slf4j.org/apidocs/org/slf4j/impl/SimpleLogger.html
-[3]: http://logging.apache.org/log4j/2.x/slf4j-impl/
+[3]: http://logging.apache.org/log4j/2.x/log4j-slf4j-impl/
[4]: http://logback.qos.ch
[5]: http://slf4j.org/apidocs/
[6]: http://plexus.codehaus.org/plexus-containers/plexus-container-default/apidocs/org/codehaus/plexus/logging/package-summary.html