add clarity around distros' use of aliases #250
Merged
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
Signed-off-by: Dan Luhring <[email protected]>
docs/schema.md
Outdated
| follow this definition. | ||
| Two vulnerabilities can be described as aliases if they affect any given | ||
| software component the same way: either both vulnerabilities affect the software | ||
| component or neither do. And, consequently, a potential patch that addresses one |
There was a problem hiding this comment.
Grammar nit: don't start sentences with a conjunction.
Suggested change
| component or neither do. And, consequently, a potential patch that addresses one | |
| component or neither do. Consequently, a potential patch that addresses one |
There was a problem hiding this comment.
Or more invasively,
"A subsequent patch addresses both of the vulnerabilities (and no others), and vice versa."
There was a problem hiding this comment.
Adjusted in f84a635
oliverchang
reviewed
Jul 11, 2024
Signed-off-by: Dan Luhring <[email protected]>
Signed-off-by: Dan Luhring <[email protected]>
oliverchang
approved these changes
Jul 15, 2024
|
CC @chrisbloom7 and @rsc in case you have thoughts! |
michaelkedar
approved these changes
Jul 15, 2024
oliverchang
approved these changes
Jul 22, 2024
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.
Coming out of google/osv.dev#2374 (comment), wanted to suggest some potential wording improvements to help the next Linux distro that comes along better understand how the
aliasesfield should and should not be used.I welcome any feedback, and I'm not sure I've captured the sentiment perfectly.
One particular callout: this PR removes an existing sentence (below) that we struggled to wrap our heads around. If there's something that this was trying to convey that's lost in my PR, I'd love to better understand it.
cc: @michaelkedar @andrewpollock @cpanato