Muzzle improvements: docs, javadocs, renamings and minor refactoring #1379
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mateuszrzeszutek
requested review from
anuraaga,
iNikem,
jkwatson,
trask and
tylerbenson
as code owners
trask
reviewed
Oct 13, 2020
There was a problem hiding this comment.
Great stuff!
- 👍 Renamed almost all muzzle classes, moved some of them to two different packages (
collectorormatcher) depending on how and when they're used;- ❤️ Added/improved javadocs in classes that had no/poor documentation;
- ❤️ Documented compile-time and runtime muzzle functionality in
muzzle.md;- ❤️ Documented muzzle gradle plugin usage (as much as I understand it);
- 👍 Split
Reference.Flagto several different enums;- 👍 Refactored
HelperReferenceWrapperso that it uses Java 8 streams instead of Guava.
docs/contributing/muzzle.md
Outdated
| ./gradlew :instrumentation:google-http-client-1.19:printReferences | ||
| ``` | ||
|
|
||
| * `muzzle` task runs the runtime muzzle verification against different library versions: |
There was a problem hiding this comment.
I'd suggest putting muzzle before printReferences since most important
There was a problem hiding this comment.
not related to this PR, but should we rename the printReferences to something that includes muzzle in the task name? e.g. muzzlePrintReferences?
...ng/src/main/java/io/opentelemetry/javaagent/tooling/muzzle/collector/ReferenceCollector.java
Outdated
Show resolved
Hide resolved
...ng/src/main/java/io/opentelemetry/javaagent/tooling/muzzle/collector/ReferenceCollector.java
Outdated
Show resolved
Hide resolved
...ng/src/main/java/io/opentelemetry/javaagent/tooling/muzzle/collector/ReferenceCollector.java
Outdated
Show resolved
Hide resolved
...ng/src/main/java/io/opentelemetry/javaagent/tooling/muzzle/collector/ReferenceCollector.java
Outdated
Show resolved
Hide resolved
.../src/main/java/io/opentelemetry/javaagent/tooling/muzzle/matcher/HelperReferenceWrapper.java
Show resolved
Hide resolved
Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>
mateuszrzeszutek
force-pushed
the
muzzle-improvements
branch
from
f411c3c
to
d700aee
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contents:
collectorormatcher) depending on how and when they're used;muzzle.md;Reference.Flagto several different enums;HelperReferenceWrapperso that it uses Java 8 streams instead of Guava.This PR does not solve #536, but at least it clears up some of the questions that appeared there.