[CPP-370] Non-const format strings: Add change note for the 1.22 release. #1533
Conversation
This file contains hidden or 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
jbj
reviewed
Jul 2, 2019
change-notes/1.22/analysis-cpp.md
Outdated
| |----------------------------|------------------------|------------------------------------------------------------------| | ||
| | Expression has no effect (`cpp/useless-expression`) | Fewer false positive results | Calls to functions with the `weak` attribute are no longer considered to be side effect free, because they could be overridden with a different implementation at link time. | | ||
| | Suspicious pointer scaling (`cpp/suspicious-pointer-scaling`) | Lower precision | The precision of this query has been reduced to "medium". This coding pattern is used intentionally and safely in a number of real-world projects. Results are no longer displayed on LGTM unless you choose to display them. | | ||
| | Non-constant format string (`cpp/non-constant-format`) | Higher precision | Rewritten using the taint-tracking library; should also improve performance in batched runs. | |
Contributor
There was a problem hiding this comment.
Please change "Higher precision" to "Fewer false positive results" for consistency.
Somebody (me?) has written "Lower precision" above to mean "Lower @precision", which is something very different. I'm open to changing "Lower precision" to something less ambiguous.
change-notes/1.22/analysis-cpp.md
Outdated
| |----------------------------|------------------------|------------------------------------------------------------------| | ||
| | Expression has no effect (`cpp/useless-expression`) | Fewer false positive results | Calls to functions with the `weak` attribute are no longer considered to be side effect free, because they could be overridden with a different implementation at link time. | | ||
| | Suspicious pointer scaling (`cpp/suspicious-pointer-scaling`) | Lower precision | The precision of this query has been reduced to "medium". This coding pattern is used intentionally and safely in a number of real-world projects. Results are no longer displayed on LGTM unless you choose to display them. | | ||
| | Non-constant format string (`cpp/non-constant-format`) | Higher precision | Rewritten using the taint-tracking library; should also improve performance in batched runs. | |
Contributor
There was a problem hiding this comment.
Did you actually measure a performance improvement on the last stage? Otherwise let's drop the claim about improved performance.
jbj
approved these changes
Jul 3, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR is a companion to #1251 and deals strictly with the changelog entry for the 1.22 release. I've added a note about the increased precision of the new
cpp/non-constant-formatquery.Please let me know if the wording is incorrect or if this PR is unnecessary altogether.