You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lens.apache.org by pr...@apache.org on 2015/08/11 14:20:48 UTC

[25/50] [abbrv] incubator-lens git commit: LENS-370 : Fix Lombok javadoc issue

LENS-370 : Fix Lombok javadoc issue


Project: http://git-wip-us.apache.org/repos/asf/incubator-lens/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-lens/commit/882182a9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-lens/tree/882182a9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-lens/diff/882182a9

Branch: refs/heads/current-release-line
Commit: 882182a9ccb89f71613fa8c8872048255cc571ad
Parents: 40cedfb
Author: Rajat Khandelwal <pr...@apache.org>
Authored: Thu Jul 30 17:32:31 2015 +0530
Committer: Amareshwari Sriramadasu <am...@apache.org>
Committed: Thu Jul 30 17:32:31 2015 +0530

----------------------------------------------------------------------
 pom.xml                               | 142 ++++++++++++++++++++++-------
 src/site/apt/user/cli.apt             |   4 +-
 tools/scripts/generate-site-public.sh |   2 +-
 3 files changed, 112 insertions(+), 36 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/882182a9/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index b395658..99f8c30 100644
--- a/pom.xml
+++ b/pom.xml
@@ -19,7 +19,8 @@
   under the License.
 
 -->
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
 
   <parent>
@@ -55,6 +56,7 @@
     <joda.time.version>2.0</joda.time.version>
     <guava.version>13.0.1</guava.version>
     <lombok.version>1.12.4</lombok.version>
+    <lombok.maven.plugin.version>1.16.4.1</lombok.maven.plugin.version>
     <typesafe.config.version>1.2.1</typesafe.config.version>
 
     <jackson.asl.version>1.9.13</jackson.asl.version>
@@ -90,7 +92,7 @@
     <exec.plugin.version>1.2.1</exec.plugin.version>
     <enunciate.plugin.version>1.28</enunciate.plugin.version>
     <reports.plugin.version>2.7</reports.plugin.version>
-    <javadoc.plugin.version>2.9.1</javadoc.plugin.version>
+    <javadoc.plugin.version>2.10.3</javadoc.plugin.version>
     <surefire.plugin.version>2.15</surefire.plugin.version>
     <jdeb.plugin.version>1.0.1</jdeb.plugin.version>
     <checkstyle.plugin.version>2.9.1</checkstyle.plugin.version>
@@ -108,6 +110,7 @@
     <mvn.lens.install.dir>/usr/local/lens</mvn.lens.install.dir>
     <mvn.lens.webapp.dir>${mvn.lens.install.dir}/server/webapp</mvn.lens.webapp.dir>
     <mvn.lens.server.dir>${mvn.lens.webapp.dir}/lens-server</mvn.lens.server.dir>
+    <src.dir>src/main/java</src.dir>
 
   </properties>
 
@@ -345,7 +348,7 @@
               <show>public</show>
               <groups>
                 <group>
-                  <title>Clien api</title>
+                  <title>Client api</title>
                   <packages>org.apache.lens.api*:org.apache.lens.client*</packages>
                 </group>
                 <group>
@@ -364,7 +367,7 @@
   </reporting>
 
   <build>
-
+    <sourceDirectory>${src.dir}</sourceDirectory>
     <resources>
       <resource>
         <directory>${basedir}/src/deb/control</directory>
@@ -403,8 +406,8 @@
         </plugin>
         <plugin>
           <groupId>org.apache.maven.plugins</groupId>
-	  <artifactId>maven-site-plugin</artifactId>
-	  <configuration>
+          <artifactId>maven-site-plugin</artifactId>
+          <configuration>
             <generateReports>true</generateReports>
           </configuration>
         </plugin>
@@ -449,6 +452,11 @@
           <version>${checkstyle.plugin.version}</version>
         </plugin>
         <plugin>
+          <groupId>org.projectlombok</groupId>
+          <artifactId>lombok-maven-plugin</artifactId>
+          <version>${lombok.maven.plugin.version}</version>
+        </plugin>
+        <plugin>
           <groupId>org.jvnet.jaxb2.maven2</groupId>
           <artifactId>maven-jaxb2-plugin</artifactId>
           <version>${jaxb2.plugin.version}</version>
@@ -600,22 +608,22 @@
         <artifactId>findbugs-maven-plugin</artifactId>
         <configuration>
           <xmlOutput>true</xmlOutput>
-	  <excludeFilterFile>${project.basedir}/../checkstyle/src/main/resources/findbugs-exclude.xml</excludeFilterFile>
+          <excludeFilterFile>${basedir}/../checkstyle/src/main/resources/findbugs-exclude.xml
+          </excludeFilterFile>
           <failOnError>true</failOnError>
           <skip>${skipCheck}</skip>
         </configuration>
         <executions>
           <execution>
-             <id>findbugs-check</id>
-             <goals>
-               <goal>check</goal>
-             </goals>
-             <phase>verify</phase>
-           </execution>
+            <id>findbugs-check</id>
+            <goals>
+              <goal>check</goal>
+            </goals>
+            <phase>verify</phase>
+          </execution>
         </executions>
       </plugin>
     </plugins>
-
   </build>
   <repositories>
     <repository>
@@ -1287,24 +1295,24 @@
           </plugin>
 
           <plugin>
-          <groupId>org.apache.maven.plugins</groupId>
-          <artifactId>maven-antrun-plugin</artifactId>
-          <executions>
-            <execution>
-              <phase>process-classes</phase>
-              <configuration>
-                <failOnError>false</failOnError>
-                <tasks>
-                  <propertyfile file="target/generated-classes/cobertura/cobertura.properties">
-                    <entry key="net.sourceforge.cobertura.datafile" value="${mvn.lens.install.dir}" />
-                  </propertyfile>
-                </tasks>
-              </configuration>
-              <goals>
-                <goal>run</goal>
-              </goals>
-            </execution>
-          </executions>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-antrun-plugin</artifactId>
+            <executions>
+              <execution>
+                <phase>process-classes</phase>
+                <configuration>
+                  <failOnError>false</failOnError>
+                  <tasks>
+                    <propertyfile file="target/generated-classes/cobertura/cobertura.properties">
+                      <entry key="net.sourceforge.cobertura.datafile" value="${mvn.lens.install.dir}"/>
+                    </propertyfile>
+                  </tasks>
+                </configuration>
+                <goals>
+                  <goal>run</goal>
+                </goals>
+              </execution>
+            </executions>
           </plugin>
 
           <plugin>
@@ -1318,7 +1326,7 @@
 
         </plugins>
       </build>
-   </profile>
+    </profile>
     <profile>
       <id>no-checkstyle</id>
       <build>
@@ -1403,5 +1411,73 @@
         <skipCheck>true</skipCheck>
       </properties>
     </profile>
+    <profile>
+      <id>lombok-needs-tools-jar</id>
+      <activation>
+        <file>
+          <exists>${java.home}/../lib/tools.jar</exists>
+        </file>
+      </activation>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok-maven-plugin</artifactId>
+            <version>${lombok.maven.plugin.version}</version>
+            <dependencies>
+              <dependency>
+                <groupId>sun.jdk</groupId>
+                <artifactId>tools</artifactId>
+                <version>1.6</version>
+                <scope>system</scope>
+                <systemPath>${java.home}/../lib/tools.jar</systemPath>
+              </dependency>
+            </dependencies>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+    <profile>
+      <id>javadoc</id>
+      <properties>
+        <src.dir>target/generated-sources/delombok</src.dir>
+      </properties>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok-maven-plugin</artifactId>
+            <executions>
+              <execution>
+                <id>delombok</id>
+                <phase>generate-sources</phase>
+                <goals>
+                  <goal>delombok</goal>
+                </goals>
+                <configuration>
+                  <formatPreferences>
+                    <javaLangAsFQN>skip</javaLangAsFQN>
+                  </formatPreferences>
+                  <verbose>true</verbose>
+                  <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
+                  <addOutputDirectory>true</addOutputDirectory>
+                </configuration>
+              </execution>
+              <execution>
+                <id>test-delombok</id>
+                <phase>generate-sources</phase>
+                <goals>
+                  <goal>testDelombok</goal>
+                </goals>
+                <configuration>
+                  <verbose>true</verbose>
+                  <addOutputDirectory>true</addOutputDirectory>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
   </profiles>
 </project>

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/882182a9/src/site/apt/user/cli.apt
----------------------------------------------------------------------
diff --git a/src/site/apt/user/cli.apt b/src/site/apt/user/cli.apt
index a28d8a4..5dd0bfb 100644
--- a/src/site/apt/user/cli.apt
+++ b/src/site/apt/user/cli.apt
@@ -92,7 +92,7 @@ User CLI Commands
 *--+--+
 |close/bye|Releases all resources of the server session and exits the shell|
 *--+--+
-|debug [[--enable] To print all logs on cli for debugging purpose]|prints all class level logs and verbose logs on cli for debugging purpose. 'debug false'  to turn off all class level logging and verbose level logging |
+|debug [[--enable] To print all logs on cli for debugging purpose]|prints all class level logs and verbose logs on cli for debugging purpose. 'debug false' to turn off all class level logging and verbose level logging |
 *--+--+
 |get [--key] \<key\>|Fetches and prints session parameter specified with name <<<key>>> from lens server|
 *--+--+
@@ -108,7 +108,7 @@ User CLI Commands
 *--+--+
 |show params|Fetches and prints all session parameter from lens server|
 *--+--+
-|verbose [[--enable] Print the clilogger logs on cli]|Show cliLogger logs on cli'verbose false'  turns off the cliLogger logs on console|
+|verbose [[--enable] Print the clilogger logs on cli]|Show cliLogger logs on cli. 'verbose false'  turns off the cliLogger logs on console|
 *--+--+
   <<Lens Connection Commands>>
 

http://git-wip-us.apache.org/repos/asf/incubator-lens/blob/882182a9/tools/scripts/generate-site-public.sh
----------------------------------------------------------------------
diff --git a/tools/scripts/generate-site-public.sh b/tools/scripts/generate-site-public.sh
index 0f2e45c..777245b 100755
--- a/tools/scripts/generate-site-public.sh
+++ b/tools/scripts/generate-site-public.sh
@@ -44,7 +44,7 @@ CURR_BRANCH=`git branch | sed -n '/\* /s///p'`
 echo "Running site in current lens branch" $CURR_BRANCH
 mvn clean test -Dtest=org.apache.lens.doc.TestGenerateConfigDoc,org.apache.lens.cli.doc.TestGenerateCLIUserDoc -DskipCheck || die "Unable to generate config docs"
 mvn install -DskipTests -DskipCheck
-mvn site site:stage -Ddependency.locations.enabled=false -Ddependency.details.enabled=false || die "unable to generate site"
+mvn site site:stage -Ddependency.locations.enabled=false -Ddependency.details.enabled=false -Pjavadoc || die "unable to generate site"
 
 echo "Site gen complete"