-
-
Notifications
You must be signed in to change notification settings - Fork 76
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
Default to non verbose javadoc generation logs #41
Conversation
🐝 |
Please add the option to the README (in the changelog section, e.g.) as well. Thanks! |
While there is no any other configuration this variables useless. You can disable or change configuration downstream without any variables. That's maven mess introducing so many useless variables. cc @stephenc |
This pull request originates from a CloudBees employee. At CloudBees, we require that all pull requests be reviewed by other CloudBees employees before we seek to have the change accepted. If you want to learn more about our process please see this explanation. |
@KostyaSha you have a style, can't deny it. @andresrc done. |
That's the problem that more and more variables makes everything difficult. As soon as you decide to add additional configuration setting you would need to play with child-merges magic that is not so simple. |
@@ -340,6 +341,9 @@ | |||
<plugin> | |||
<artifactId>maven-javadoc-plugin</artifactId> | |||
<version>2.10.1</version> | |||
<configuration> | |||
<quiet>${javadoc.quiet}</quiet> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why not either just define the standard property quiet
to have a default value of true
or just force it true and doc how to turn it back. You are breaking the javadoc plugin's docs by introducing a new property.
We seem to go property mad to avoid people having to "learn Maven" and all we do is raise the bar for people who want to learn it!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, I see no particular use case for making it verbose, so it would be simply and better to just say
<quiet>true</quiet>
and if someone really wants the opposite, they can add a configuration fragment in their POM to override.
@@ -340,6 +341,9 @@ | |||
<plugin> | |||
<artifactId>maven-javadoc-plugin</artifactId> | |||
<version>2.10.1</version> | |||
<configuration> | |||
<quiet>${javadoc.quiet}</quiet> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, I see no particular use case for making it verbose, so it would be simply and better to just say
<quiet>true</quiet>
and if someone really wants the opposite, they can add a configuration fragment in their POM to override.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
useless variable
4990f64
to
55bb124
Compare
That changes switches the javadoc plugin to quiet mode (https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#quiet) This means it will only output errors & warnings, and will stop showing hundreds of lines, one per file basically, for successful ones. This is an issue for non trivially small plugins because this will somehow hide real errors in a sea of success/happy path logs. I still introduced a property for people who would like to keep that behaviour...
55bb124
to
284d82d
Compare
Agreed. Fixed. |
Applied requested changes, so review must be done again. Thanks
@KostyaSha fine by you now? I would love to see that out and start propagating to raise signal/noise ratio :-). |
🐝 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🐝
@andresrc thanks for merging! Any plan to release? I would love to see it starting to propagate :-). |
@batmat release is done |
@oleg-nenashev thanks! |
@reviewbybees
That change switches the javadoc plugin to quiet mode
(https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#quiet)
This means it will only output errors & warnings, and will stop showing
hundreds of lines, one per file basically, for successful ones.
This is an issue for non trivially small plugins because this will somehow
hide real errors in a sea of success/happy path logs.
I still introduced a property for people who would like to keep that behaviour...