Discussion:
mahout git commit: MAHOUT-2041 Add Scala/Java Doc Plugin
r***@apache.org
2018-06-18 15:26:22 UTC
Permalink
Repository: mahout
Updated Branches:
refs/heads/branch-0.14.0 0fca1c0f6 -> abcc64567


MAHOUT-2041 Add Scala/Java Doc Plugin


Project: http://git-wip-us.apache.org/repos/asf/mahout/repo
Commit: http://git-wip-us.apache.org/repos/asf/mahout/commit/abcc6456
Tree: http://git-wip-us.apache.org/repos/asf/mahout/tree/abcc6456
Diff: http://git-wip-us.apache.org/repos/asf/mahout/diff/abcc6456

Branch: refs/heads/branch-0.14.0
Commit: abcc6456756b45f2ed14ff6c8ffecf893d679cc7
Parents: 0fca1c0
Author: Trevor a.k.a @rawkintrevo <***@gmail.com>
Authored: Mon Jun 18 10:25:41 2018 -0500
Committer: Trevor a.k.a @rawkintrevo <***@gmail.com>
Committed: Mon Jun 18 10:25:41 2018 -0500

----------------------------------------------------------------------
core/pom.xml | 2 +
.../org/apache/mahout/math/map/OpenHashMap.java | 2 +
engine/spark/pom.xml | 33 +-----
pom.xml | 114 +++++++++++++++++--
website/developers/buildingmahout.md | 17 ++-
5 files changed, 126 insertions(+), 42 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mahout/blob/abcc6456/core/pom.xml
----------------------------------------------------------------------
diff --git a/core/pom.xml b/core/pom.xml
index e555ae6..7d15458 100644
--- a/core/pom.xml
+++ b/core/pom.xml
@@ -230,6 +230,8 @@
</filesets>
</configuration>
</plugin>
+
+
</plugins>
</build>
</project>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/mahout/blob/abcc6456/core/src/main/java/org/apache/mahout/math/map/OpenHashMap.java
----------------------------------------------------------------------
diff --git a/core/src/main/java/org/apache/mahout/math/map/OpenHashMap.java b/core/src/main/java/org/apache/mahout/math/map/OpenHashMap.java
index b7c16d6..271abc1 100644
--- a/core/src/main/java/org/apache/mahout/math/map/OpenHashMap.java
+++ b/core/src/main/java/org/apache/mahout/math/map/OpenHashMap.java
@@ -33,6 +33,8 @@ import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
+// Error building Javadocs if java.util.Map.Entry not explictly included... (?)
+import java.util.Map.Entry;

import org.apache.mahout.math.function.ObjectObjectProcedure;
import org.apache.mahout.math.function.ObjectProcedure;

http://git-wip-us.apache.org/repos/asf/mahout/blob/abcc6456/engine/spark/pom.xml
----------------------------------------------------------------------
diff --git a/engine/spark/pom.xml b/engine/spark/pom.xml
index 0fadac3..df9737d 100644
--- a/engine/spark/pom.xml
+++ b/engine/spark/pom.xml
@@ -48,9 +48,9 @@
</plugin>

<!-- Pre-refactor plugins start here -->
- <plugin>
- <artifactId>maven-javadoc-plugin</artifactId>
- </plugin>
+ <!--<plugin>-->
+ <!--<artifactId>maven-javadoc-plugin</artifactId>-->
+ <!--</plugin>-->

<plugin>
<artifactId>maven-source-plugin</artifactId>
@@ -249,31 +249,4 @@

</dependencies>

- <profiles>
- <profile>
- <id>mahout-release</id>
- <build>
- <plugins>
- <plugin>
- <groupId>net.alchim31.maven</groupId>
- <artifactId>scala-maven-plugin</artifactId>
- <executions>
- <execution>
- <id>generate-scaladoc</id>
- <goals>
- <goal>doc</goal>
- </goals>
- </execution>
- <execution>
- <id>attach-scaladoc-jar</id>
- <goals>
- <goal>doc-jar</goal>
- </goals>
- </execution>
- </executions>
- </plugin>
- </plugins>
- </build>
- </profile>
- </profiles>
</project>

http://git-wip-us.apache.org/repos/asf/mahout/blob/abcc6456/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 9a404c7..f978e87 100644
--- a/pom.xml
+++ b/pom.xml
@@ -112,6 +112,7 @@
<apache-rat.plugin.version>0.12</apache-rat.plugin.version>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
+ <mjavadoc.version>2.10.3</mjavadoc.version>
<slf4j.version>1.7.22</slf4j.version>
<scala.version>2.11.6</scala.version>
<scala.compat.version>2.11</scala.compat.version>
@@ -125,7 +126,7 @@
<mpmd.version>3.4</mpmd.version>
<mcheckstyle.version>2.15</mcheckstyle.version>
<mfindbugs.version>3.0.1</mfindbugs.version>
- <mjavadoc.version>2.10.3</mjavadoc.version>
+
<mscala.version>3.2.0</mscala.version>
<hbase.version>1.0.0</hbase.version>
<lucene.version>5.5.2</lucene.version>
@@ -585,20 +586,18 @@
<optimize>true</optimize>
</configuration>
</plugin>
- <!-- TODO This isn't done (release plugin)-->
+
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
<version>2.5.2</version>
<configuration>
- <!--<useReleaseProfile>true</useReleaseProfile>-->
- <!--<releaseProfiles>viennacl,viennacl-omp,distribution,mahout-release,apache-release</releaseProfiles>-->
<goals>deploy</goals>
<autoVersionSubmodules>true</autoVersionSubmodules>
<arguments>${arguments}</arguments>
</configuration>
</plugin>
- <!-- TODO ^^ not done -->
+
</plugins>
<pluginManagement>
<plugins>
@@ -669,6 +668,59 @@
</filesets>
</configuration>
</plugin>
+
+ <!--&lt;!&ndash; Javadocs &ndash;&gt;-->
+ <!--<plugin>-->
+ <!--<groupId>org.apache.maven.plugins</groupId>-->
+ <!--<artifactId>maven-javadoc-plugin</artifactId>-->
+ <!--<version>3.0.1</version>-->
+ <!--<executions>-->
+ <!--<execution>-->
+ <!--<id>aggregate</id>-->
+ <!--<phase>site</phase>-->
+ <!--<goals>-->
+ <!--<goal>aggregate</goal>-->
+ <!--</goals>-->
+ <!--</execution>-->
+ <!--</executions>-->
+ <!--</plugin>-->
+
+ <!-- Scaladocs -->
+ <!--<plugin>-->
+ <!--<groupId>org.apache.maven.plugins</groupId>-->
+ <!--<artifactId>maven-site-plugin</artifactId>-->
+ <!--<version>3.0</version>-->
+ <!--<configuration>-->
+ <!--<reportPlugins>-->
+ <!--<plugin>-->
+ <!--<artifactId>maven-project-info-reports-plugin</artifactId>-->
+ <!--<version>2.2</version>-->
+ <!--</plugin>-->
+ <!--<plugin>-->
+ <!--<groupId>net.alchim31.maven</groupId>-->
+ <!--<artifactId>scala-maven-plugin</artifactId>-->
+ <!--<version>3.4.1</version>-->
+ <!--<configuration>-->
+ <!--<jvmArgs>-->
+ <!--<jvmArg>-Xms64m</jvmArg>-->
+ <!--<jvmArg>-Xmx1024m</jvmArg>-->
+ <!--</jvmArgs>-->
+ <!--<args>-->
+ <!--<arg>-target:jvm-${maven.compiler.target}</arg>-->
+ <!--<arg>-deprecation</arg>-->
+ <!--<arg>-feature</arg>-->
+ <!--<arg>-language:existentials</arg>-->
+ <!--<arg>-language:implicitConversions</arg>-->
+ <!--<arg>-language:postfixOps</arg>-->
+ <!--</args>-->
+ <!--<sourceDir>src/main/scala</sourceDir>-->
+ <!--<testSourceDir>src/test/scala</testSourceDir>-->
+ <!--</configuration>-->
+ <!--</plugin>-->
+ <!--</reportPlugins>-->
+ <!--</configuration>-->
+ <!--</plugin>-->
+
</plugins>
</pluginManagement>

@@ -719,6 +771,48 @@
<module>experimental</module>
</modules>
</profile>
+
+
+ <profile>
+ <id>docs</id>
+ <reporting>
+ <plugins>
+ <!-- generate java doc -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${mjavadoc.version}</version>
+ </plugin>
+ </plugins>
+ </reporting>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-site-plugin</artifactId>
+ <configuration>
+ <reportPlugins>
+ <plugin>
+ <artifactId>maven-project-info-reports-plugin</artifactId>
+ <!--<version>2.2</version>-->
+ </plugin>
+ <plugin>
+ <groupId>net.alchim31.maven</groupId>
+ <artifactId>scala-maven-plugin</artifactId>
+ <!--<version>3.4.1</version>-->
+ <configuration>
+ <jvmArgs>
+ <jvmArg>-Xms64m</jvmArg>
+ <jvmArg>-Xmx1024m</jvmArg>
+ </jvmArgs>
+ </configuration>
+ </plugin>
+ </reportPlugins>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
</profiles>
<!--<defaultGoal>install</defaultGoal>-->
<!--<pluginManagement>-->
@@ -1334,12 +1428,7 @@
<!--<generateHtml>true</generateHtml>-->
<!--</configuration>-->
<!--</plugin>-->
- <!--&lt;!&ndash; generate java doc &ndash;&gt;-->
- <!--<plugin>-->
- <!--<groupId>org.apache.maven.plugins</groupId>-->
- <!--<artifactId>maven-javadoc-plugin</artifactId>-->
- <!--<version>${mjavadoc.version}</version>-->
- <!--</plugin>-->
+ <!--&lt;!&ndash; code duplication - copy and paste detection &ndash;&gt;-->
<!--<plugin>-->
<!--<groupId>org.apache.maven.plugins</groupId>-->
@@ -1429,4 +1518,7 @@
<!--</plugin>-->
<!--</plugins>-->
<!--</reporting>-->
+
+
</project>
+

http://git-wip-us.apache.org/repos/asf/mahout/blob/abcc6456/website/developers/buildingmahout.md
----------------------------------------------------------------------
diff --git a/website/developers/buildingmahout.md b/website/developers/buildingmahout.md
index 68d068a..0fbf608 100644
--- a/website/developers/buildingmahout.md
+++ b/website/developers/buildingmahout.md
@@ -180,6 +180,9 @@ The following profiles are available for building optional components:
<td>Build Experimental ViennaCL-OpenMP (CPU) BLAS Pack</td>
<tr>
<tr>
+ <td><code>docs</code></td>
+ <td>Profile for building Java/Scala Docs</td>
+ <tr>
<th>Mahout Specific Option</th>
<th>Description</th>
</tr>
@@ -198,4 +201,16 @@ command to build:
```bash
mvn clean package -Pviennacl-omp -DskipCli
```
-
\ No newline at end of file
+
+#### Building Java/Scala Docs
+
+To build the Java/Scala docs use the maven `site` goal and the `docs` profile.
+
+Additionally, passing the `-Ddependency.locations.enabled=false` option will skip checking the dependency location and allow a much faster build.
+
+```bash
+mvn clean site -Pall,docs -Ddependency.locations.enabled=false
+```
+
+
+

Loading...