GauthamBanasandra opened a new pull request, #5688:
URL: https://github.com/apache/hadoop/pull/5688
* This PR changes `destDir` attribute of the maven-javadoc-plugin to have a
relative path instead of an absolute path, which would otherwise lead to an
incorrect output path for javadoc.
<!--
Thanks for sending a pull request!
1. If this is your first time, please read our contributor guidelines:
https://cwiki.apache.org/confluence/display/HADOOP/How+To+Contribute
2. Make sure your PR title starts with JIRA issue id, e.g.,
'HADOOP-17799. Your PR title ...'.
-->
### Description of PR
The javadoc build phase fails with the following error -
```
[ERROR] Failed to execute goal
org.apache.maven.plugins:maven-javadoc-plugin:3.0.1:javadoc-no-fork
(default-cli) on project hadoop-common:
An error has occurred in Javadoc report generation:
Unable to write 'options' temporary file for command execution:
H:\hadoop-common-project\hadoop-common\target\site\H:\hadoop-common-project\hadoop-common\target\api\options
(The filename, directory name, or volume label syntax is incorrect) -> [Help
1]
```
As called out by the error message the path
`H:\hadoop-common-project\hadoop-common\target\site\H:\hadoop-common-project\hadoop-common\target\api\options`
is invalid.
The culprit being -
https://github.com/apache/hadoop/blob/e9740cb17aef157a615dc36ae08cd224ce1672f0/hadoop-project-dist/pom.xml#L109
As per the [docs from
maven-javadoc-plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/examples/output-configuration.html),
`destDir` attribute's value gets appended to that of `reportOutputDirectory`.
This implies that `destDir` must be a relative path, although not called out in
the documentation. Since this isn't the case here,
1. In Linux, this yields an unintended path (albeit a valid one) and doesn't
fail.
2. In Windows, it yields an incorrect path and thus fails since there's a
colon ( : ) for the drive letter in the middle of the incorrectly concatenated
path -
H:\hadoop-common-project\hadoop-common\target\site\H`:`\hadoop-common-project\hadoop-common\target\api\options
Thus, fixing this would fix the build failure on Windows and put the docs in
the appropriate directory in Linux.
### How was this patch tested?
Jenkins CI validation.
### For code changes:
- [x] Does the title or this PR starts with the corresponding JIRA issue id
(e.g. 'HADOOP-17799. Your PR title ...')?
- [ ] Object storage: have the integration tests been executed and the
endpoint declared according to the connector-specific documentation?
- [ ] If adding new dependencies to the code, are these dependencies
licensed in a way that is compatible for inclusion under [ASF
2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE`, `LICENSE-binary`,
`NOTICE-binary` files?
--
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: common-issues-unsubscr...@hadoop.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: common-issues-unsubscr...@hadoop.apache.org
For additional commands, e-mail: common-issues-h...@hadoop.apache.org
