Skip to content

Commit

Permalink
ORC-994: Updated javadoc generation location outside of source tree
Browse files Browse the repository at this point in the history
### What changes were proposed in this pull request?
The PR Proposes to generate the javadoc to a location inside target folder, outside of source tree.
The location can be specified in properties inside pom.xml

### Why are the changes needed?
The changes are needed to avoid RAT check issues

### How was this patch tested?
Ran the build and manually verified the javadoc generation using `mvn javadoc:javadoc`
The javadoc's were generated inside `projectDir/target/javadoc` as configured

Closes #1663 from mystic-lama/javadoc_location.

Authored-by: mystic-lama <mysticlama000@gmail.com>
Signed-off-by: Dongjoon Hyun <dongjoon@apache.org>
  • Loading branch information
paliwalashish authored and dongjoon-hyun committed Dec 2, 2023
1 parent 60be0a6 commit c3340f2
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions java/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
<example.dir>${project.basedir}/../../examples</example.dir>
<hadoop.version>3.3.6</hadoop.version>
<java.version>17</java.version>
<javadoc.location>${project.basedir}/../target/javadoc</javadoc.location>
<junit.version>5.10.1</junit.version>
<maven-assembly-plugin.version>3.6.0</maven-assembly-plugin.version>
<maven-dependency-plugin.version>3.6.0</maven-dependency-plugin.version>
Expand Down Expand Up @@ -658,18 +659,18 @@
<offlineLinks>
<offlineLink>
<url>https://orc.apache.org/api/hive-storage-api</url>
<location>${project.basedir}/../../site/api/hive-storage-api</location>
<location>${javadoc.location}/api/hive-storage-api</location>
</offlineLink>
<offlineLink>
<url>https://orc.apache.org/api/orc-core</url>
<location>${project.basedir}/../../site/api/orc-core</location>
<location>${javadoc.location}/api/orc-core</location>
</offlineLink>
<offlineLink>
<url>https://orc.apache.org/api/orc-mapreduce</url>
<location>${project.basedir}/../../site/api/orc-mapreduce</location>
<location>${javadoc.location}/api/orc-mapreduce</location>
</offlineLink>
</offlineLinks>
<reportOutputDirectory>${project.basedir}/../../site/api</reportOutputDirectory>
<reportOutputDirectory>${javadoc.location}/api</reportOutputDirectory>
<notimestamp>true</notimestamp>
</configuration>
</plugin>
Expand Down

0 comments on commit c3340f2

Please sign in to comment.