Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Javadoc returns a non-zero exit code but success is reported #414

Closed
raboof opened this issue Sep 26, 2017 · 5 comments
Closed

Javadoc returns a non-zero exit code but success is reported #414

raboof opened this issue Sep 26, 2017 · 5 comments

Comments

@raboof
Copy link
Contributor

raboof commented Sep 26, 2017

In sbt.inc.Doc, the javadoc JavaTool is invoked.

When javadoc fails it produces a non-zero exit code, which leads to run returning false. In Doc, however, the return value is ignored.

@raboof raboof changed the title return value is ignored javadoc return value is ignored Sep 26, 2017
@jvican
Copy link
Member

jvican commented Sep 28, 2017

Thanks for filing this bug @raboof. Please, next time you file a ticket, choose a meaningful title that explains clearly the issue, we try to keep the issue tracker clean and easy to read. 😄

@jvican jvican changed the title javadoc return value is ignored Javadoc returns a non-zero exit code but success is reported Sep 28, 2017
@raboof
Copy link
Contributor Author

raboof commented Sep 29, 2017

What would be the proper way to report the error here? Is throwing acceptable or is there a better mechanism?

@jvican
Copy link
Member

jvican commented Sep 29, 2017

An exception would be the way to go. I encourage you to whip up a quick PR and we move forward from there. I guess that if Javadoc produces a non-zero exit code it also produces some kind of error messages. Is that displayed to the console as expected?

@raboof
Copy link
Contributor Author

raboof commented Sep 29, 2017

Will do!

The Javadoc error messages are indeed mostly-correctly printed to the console (but #415 ;) )

@raboof
Copy link
Contributor Author

raboof commented Mar 12, 2019

Fixed with #625 which should be released with sbt 1.3.0

@raboof raboof closed this as completed Mar 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants