ankitsultana opened a new issue, #13718:
URL: https://github.com/apache/pinot/issues/13718

   While doing the Pinot 1.2 Release, the `mvn javadoc:javadoc` goal is failing 
with the following error:
   
   ```
   [ERROR] Failed to execute goal 
org.apache.maven.plugins:maven-javadoc-plugin:3.2.0:javadoc (default-cli) on 
project pinot-common: An error has occurred in Javadoc report generation:
   [ERROR] Exit code: 2 - javadoc: error - Illegal package name: 
"protobuf.grpc-java.org.apache.pinot.common.proto"
   [ERROR]
   [ERROR] Command line was: /usr/lib/jvm/java-11-openjdk-amd64/bin/javadoc 
@options @packages
   [ERROR]
   [ERROR] Refer to the generated Javadoc files in 
'/root/pinot-release/pinot-copy/pinot/pinot-common/target/site/apidocs' dir.
   [ERROR]
   [ERROR] -> [Help 1]
   ```
   
   I verified that this is caused by #12737 by checking out both that commit 
and the one before it.
   
   ### Why did #12737 cause this?
   
   The error above is coming because javacc thinks that the directory 
`pinot-common/target/generated-sources` is a sources root. The FMPP PR added 
`<outputDirectory>${project.build.directory}/generated-sources</outputDirectory>`
 in the configuration, and the FMPP Plugin adds the output path to "compile 
source root". 
([ref](https://github.com/rongfengliang/fmpp-maven-plugin/blob/02b1f18cf580434071aa0c2a4445a64ecb3df08c/src/main/java/com/rongfengliang/FMPPMojo.java#L106)).
   
   This is further verified by the options file that the `maven-javadoc-plugin` 
generates which has:
   
   ```
   -sourcepath
   
'/root/pinot-release/pinot-copy/pinot/pinot-common/src/main/java:/root/pinot-release/pinot-copy/pinot/pinot-common/target/generated-sources/protobuf/java:/root/pinot-release/pinot-copy/pinot/pinot-common/target/generated-sources/protobuf/grpc-java:/root/pinot-release/pinot-copy/pinot/pinot-common/target/generated-sources'
   ```
   
   ### How do we fix this?
   
   I don't know of any maven plugin that can help us remove a path from 
[compileSourceRoots](https://github.com/apache/maven/blob/master/maven-core/src/main/java/org/apache/maven/project/MavenProject.java).
   
   Looking at the `maven-javadoc-plugin` implementation, it looks like it first 
computes the files after applying the exclusion rule and then calls the javadoc 
executable.
   
   I am trying to use `sourceFileExcludes` to fix this.


-- 
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.

To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org
For additional commands, e-mail: commits-h...@pinot.apache.org

Reply via email to