You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hudi.apache.org by GitBox <gi...@apache.org> on 2020/01/07 07:19:39 UTC

[GitHub] [incubator-hudi] yihua opened a new pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

yihua opened a new pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195
 
 
   ## What is the purpose of the pull request
   
   This PR adds a new maven profile to generate unified Javadoc for all Java and Scala classes.  Given that most modules have Java classes only, and only two modules, `hudi-spark` and `hudi-cli`, have Scala source code (only a few files), it is better to put the apidocs of all classes in one place.
   
   Since most classes are in Java, the Javadoc is chosen to generate the apidocs, with [genjavadoc-plugin](https://github.com/lightbend/genjavadoc) to translate Scaladoc comments into Java source so that the `javadoc` tool can recognize it.
   
   ## Brief change log
   
     - Add a new maven profile `unijavadoc` to generate unified Javadoc at the project root.  By running `mvn clean javadoc:aggregate -Punijavadoc`, the apidocs pages are generated under `target/site/apidocs`.
     - Fix one issue in `IncrementalRelation.scala` that caused the following error while generating the Javadoc:
      ```
   [ERROR] /Users/yihua/tech/repo/incubator-hudi/hudi-spark/target/genjavadoc/org/apache/hudi/IncrementalRelation.java:[17,58] type argument scala.runtime.Nothing$ is not within bounds of type-variable T
      ```
   
   ## Verify this pull request
   
   This PR only adds new maven profile and can be verified by running: `mvn clean javadoc:aggregate -Punijavadoc`
   
   ## Committer checklist
   
    - [ ] Has a corresponding JIRA in PR title & commit
    
    - [ ] Commit message is descriptive of the change
    
    - [ ] CI is green
   
    - [ ] Necessary doc changes done or have another open PR
          
    - [ ] For large changes, please consider breaking it into sub-tasks under an umbrella JIRA.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] vinothchandar commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
vinothchandar commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#discussion_r363823740
 
 

 ##########
 File path: pom.xml
 ##########
 @@ -938,6 +940,99 @@
         <mr.bundle.avro.shade.prefix>org.apache.hudi.</mr.bundle.avro.shade.prefix>
       </properties>
     </profile>
+    <profile>
+      <id>unijavadoc</id>
 
 Review comment:
   rename to just `javadocs` ? 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] yihua commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
yihua commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#discussion_r364116626
 
 

 ##########
 File path: pom.xml
 ##########
 @@ -938,6 +940,99 @@
         <mr.bundle.avro.shade.prefix>org.apache.hudi.</mr.bundle.avro.shade.prefix>
       </properties>
     </profile>
+    <profile>
+      <id>unijavadoc</id>
 
 Review comment:
   Done.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] lamber-ken commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
lamber-ken commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#issuecomment-571958021
 
 
   👍 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] hmatu commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
hmatu commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#discussion_r364001275
 
 

 ##########
 File path: pom.xml
 ##########
 @@ -938,6 +940,99 @@
         <mr.bundle.avro.shade.prefix>org.apache.hudi.</mr.bundle.avro.shade.prefix>
       </properties>
     </profile>
+    <profile>
+      <id>unijavadoc</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+            <configuration>
+              <source>1.8</source>
 
 Review comment:
   hard code `1.8`

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] vinothchandar merged pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
vinothchandar merged pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] yihua commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
yihua commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#issuecomment-572198205
 
 
   Yes, this PR is ready to merge.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] yihua commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
yihua commented on a change in pull request #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#discussion_r364119123
 
 

 ##########
 File path: pom.xml
 ##########
 @@ -938,6 +940,99 @@
         <mr.bundle.avro.shade.prefix>org.apache.hudi.</mr.bundle.avro.shade.prefix>
       </properties>
     </profile>
+    <profile>
+      <id>unijavadoc</id>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-compiler-plugin</artifactId>
+            <configuration>
+              <source>1.8</source>
 
 Review comment:
   Good catch.  Made this config in one place with a property.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] vinothchandar commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
vinothchandar commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#issuecomment-571655264
 
 
   Can merge once we resolve the naming... and also please add a line in `README` in the building section on how to generate the javadocs using the profile.. 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [incubator-hudi] vinothchandar commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes

Posted by GitBox <gi...@apache.org>.
vinothchandar commented on issue #1195: [HUDI-319] Add a new maven profile to generate unified Javadoc for all Java and Scala classes
URL: https://github.com/apache/incubator-hudi/pull/1195#issuecomment-572197774
 
 
   @yihua  I assume this is good to go?

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services