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

Default to non verbose javadoc generation logs #41

Merged
merged 1 commit into from
Jan 4, 2017
Merged

Conversation

batmat
Copy link
Member

@batmat batmat commented Dec 20, 2016

@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...

@alvarolobato
Copy link
Member

🐝

@andresrc
Copy link
Contributor

Please add the option to the README (in the changelog section, e.g.) as well. Thanks!

@KostyaSha
Copy link
Member

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

@ghost
Copy link

ghost commented Dec 20, 2016

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.

@batmat
Copy link
Member Author

batmat commented Dec 20, 2016

@KostyaSha you have a style, can't deny it.
Yes, I'm quite aware that this is feasible without it. As for every single other properties.
I tend to agree here. I only did that to make it possibly simpler to less Maven knowledgeable users to re-enable it.

@andresrc done.

@KostyaSha
Copy link
Member

Maven knowledgeable

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>
Copy link
Member

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!

Copy link
Member

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>
Copy link
Member

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.

Copy link
Member

@KostyaSha KostyaSha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

useless variable

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...
@batmat
Copy link
Member Author

batmat commented Dec 30, 2016

Agreed. Fixed.

@batmat batmat dismissed KostyaSha’s stale review December 30, 2016 19:17

Applied requested changes, so review must be done again. Thanks

@batmat
Copy link
Member Author

batmat commented Jan 3, 2017

@KostyaSha fine by you now? I would love to see that out and start propagating to raise signal/noise ratio :-).

@stephenc
Copy link
Member

stephenc commented Jan 3, 2017

🐝

Copy link
Contributor

@andresrc andresrc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🐝

@andresrc andresrc merged commit aba8062 into master Jan 4, 2017
@batmat
Copy link
Member Author

batmat commented Jan 14, 2017

@andresrc thanks for merging! Any plan to release? I would love to see it starting to propagate :-).
Gracias!

@oleg-nenashev
Copy link
Member

@batmat release is done

@batmat
Copy link
Member Author

batmat commented Jan 14, 2017

@oleg-nenashev thanks!

@batmat batmat deleted the quiet-javadoc branch April 13, 2017 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants