This is an automated email from the ASF dual-hosted git repository.
dongjoon pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/orc.git
The following commit(s) were added to refs/heads/main by this push:
new c3340f222 ORC-994: Updated javadoc generation location outside of
source tree
c3340f222 is described below
commit c3340f2227665059ab644a538085c1b497ef0467
Author: mystic-lama <[email protected]>
AuthorDate: Sat Dec 2 15:52:58 2023 -0800
ORC-994: Updated javadoc generation location outside of source tree
### 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 <[email protected]>
Signed-off-by: Dongjoon Hyun <[email protected]>
---
java/pom.xml | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/java/pom.xml b/java/pom.xml
index c7534804e..f7737d6cb 100644
--- a/java/pom.xml
+++ b/java/pom.xml
@@ -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>
@@ -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>
