Merge pull request #12 from rossabaker/docs

Docs
jsuereth · Nov 14, 2012 · d3b4854 · d3b4854
2 parents 5d70901 + 2e0e34e
commit d3b4854
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -5,12 +5,26 @@ Write maven plugins in Scala.
 
 See [documentation site](http://jsuereth.com/scala-mojo-support)
 
-
+Stable version:
 
     <dependency>
       <groupId>com.jsuereth</groupId>
       <artifactId>scala-mojo-support</artifactId>
       <version>0.4</version>
     </dependency>
 
+Development version, Scala 2.9.x:
+
+    <dependency>
+      <groupId>com.jsuereth</groupId>
+      <artifactId>scala-mojo-support_2.9</artifactId>
+      <version>0.5-SNAPSHOT</version>
+    </dependency>
 
+Development version, Scala 2.10.0-RC2:
+
+    <dependency>
+      <groupId>com.jsuereth</groupId>
+      <artifactId>scala-mojo-support_2.10.0-RC2</artifactId>
+      <version>0.5-SNAPSHOT</version>
+    </dependency>
diff --git a/pom-2.10.0-RC2.xml b/pom-2.10.0-RC2.xml
diff --git a/pom-2.9.xml b/pom-2.9.xml
diff --git a/parent-pom.xml → pom.xml b/parent-pom.xml → pom.xml
@@ -3,11 +3,12 @@
   <modelVersion>4.0.0</modelVersion>
   <properties>
     <maven.version>3.0</maven.version>
+    <scala.version>2.9.0</scala.version>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   </properties>
   <groupId>com.jsuereth</groupId>
-  <artifactId>scala-mojo-support</artifactId>
-  <packaging>pom</packaging>
+  <artifactId>scala-mojo-support_2.9</artifactId>
+  <packaging>jar</packaging>
   <version>0.5-SNAPSHOT</version>
   <name>Scala Mojo Support</name>
   <description>The scala-mojo-support project contains helper code for creating Mojos in scala.</description>
@@ -68,20 +69,20 @@
         <version>0.9.94</version>
     </dependency>
     <dependency>
-      <groupId>org.scala-lang</groupId>
-      <artifactId>scala-library</artifactId>
-      <version>${scala.version}</version>
+      <groupId>junit</groupId>
+      <artifactId>junit</artifactId>
+      <version>4.8.1</version>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>org.scala-lang</groupId>
       <artifactId>scala-compiler</artifactId>
       <version>${scala.version}</version>
     </dependency>
     <dependency>
-      <groupId>junit</groupId>
-      <artifactId>junit</artifactId>
-      <version>4.8.1</version>
-      <scope>test</scope>
+      <groupId>org.scala-lang</groupId>
+      <artifactId>scala-library</artifactId>
+      <version>${scala.version}</version>
     </dependency>
   </dependencies>
   <licenses>
@@ -128,7 +129,7 @@
         <configuration>
           <scalaVersion>${scala.version}</scalaVersion>
           <args>
-            <arg>-target:jvm-${target.jvm}</arg>
+            <arg>-target:jvm-1.5</arg>
             <arg>-no-specialization</arg>
             <arg>-deprecation</arg>
             <!--<arg>-Ystop:erasure</arg>-->

diff --git a/src/it/test-mojo-project/pom.xml b/src/it/test-mojo-project/pom.xml
@@ -8,9 +8,10 @@
 	<name>test-scala-plugin Maven Mojo</name>
 
     <properties>
-      <scala.version>2.8.0</scala.version>
-      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    </properties>
+      <scala.version>2.9.0</scala.version>
+      <scala-mojo-support.artifactId>scala-mojo-support_2.9</scala-mojo-support.artifactId>
+      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> 
+   </properties>
 
 	<dependencies>
 		<dependency>
@@ -19,8 +20,8 @@
 			<version>@maven.version@</version>
 		</dependency>
 		<dependency>
-			<groupId>org.scala-tools</groupId>
-			<artifactId>scala-mojo-support</artifactId>
+			<groupId>com.jsuereth</groupId>
+			<artifactId>${scala-mojo-support.artifactId}</artifactId>
 			<version>@project.version@</version>
 		</dependency>
 		<dependency>
@@ -35,6 +36,7 @@
 			<plugin>
 				<groupId>org.scala-tools</groupId>
 				<artifactId>maven-scala-plugin</artifactId>
+				<version>2.15.2</version>
 				<executions>
 					<execution>
 						<goals>
@@ -49,8 +51,8 @@
 				<version>2.6</version>
         <dependencies>
 					<dependency>
-						<groupId>org.scala-tools</groupId>
-						<artifactId>scala-mojo-support</artifactId>
+						<groupId>com.jsuereth</groupId>
+						<artifactId>${scala-mojo-support.artifactId}</artifactId>
 						<version>@project.version@</version>
 					</dependency>
 				</dependencies>

diff --git a/src/site/site.xml b/src/site/site.xml
@@ -22,14 +22,12 @@
 
   <body>
     <links>
-      <item name="scala-tools" href="http://scala-tools.org/"/>
       <item name="scala-blogs" href="http://scala-blogs.org/"/>
     </links>
     <menu name="Overview">
       <item name="Introduction" href="index.html" />
       <item name="Creating Scala Mojos" href="usage.html" />
     </menu>
     <menu ref="reports" />
-    <menu ref="modules" />
   </body>
 </project>
diff --git a/src/site/xdoc/usage.xml b/src/site/xdoc/usage.xml
@@ -9,7 +9,11 @@
   <body>
     <h1>Creating a Scala Mojo</h1>
     <section name="Configuration">
-      <p>to create a scala mojo you need to add scala support into your pom.xml for a normal mojo project</p>
+      <p>To create a scala mojo you need to add scala support into
+      your pom.xml for a normal mojo project.  The binary-compatible
+      Scala version is appended to scala-mojo-support's artifactId.
+      See <a href="#Changing_the_Scala_version">Changing the Scala
+      version</a> for more.</p>
       <source>
         <![CDATA[
 <project>
@@ -22,7 +26,7 @@
 		</dependency>
 		<dependency>
 			<groupId>com.jsuereth</groupId>
-			<artifactId>scala-mojo-support</artifactId>
+			<artifactId>scala-mojo-support_2.9</artifactId>
 			<version>0.4</version>
 		</dependency>
         ...
@@ -113,9 +117,33 @@ class TestMojo extends AbstractMojo {
       </source>
     </section>
 
-    <section name="Changing the scala version">
-      <p>Scala Mojos are tied to using the version of scala that the scala-mojo-support is compiled with, and
-      therefore should <b>not</b> depend on any other scala versions.</p>
+    <section name="Changing the Scala version">
+      <p>Scala Mojos are tied to using the version of scala that the
+      scala-mojo-support is compiled with, and therefore should
+      <b>not</b> depend on any other scala versions.</p>
+
+      <p>Beginning with 0.5, scala-mojo-support is cross built.  You
+      must specify an artifactId compatible with your Scala
+      version.</p>
+
+      <table>
+	<thead>
+	  <tr>
+	    <th>Scala version</th>
+	    <th>Artifact Id</th>
+	  </tr>
+	</thead>
+	<tbody>
+	  <tr>
+	    <td>2.9.x</td>
+	    <td>scala-mojo-plugin_2.9</td>
+	  </tr>
+	  <tr>
+	    <td>2.10.0-RC2</td>
+	    <td>scala-mojo-plugin_2.10.0-RC2</td>
+	  </tr>
+	</tbody>
+      </table>
     </section>
 
   </body>