Page MenuHomePhabricator

(Urgent!) [release][docs][analyzer] Add 11.0.0. release notes
ClosedPublic

Authored by Szelethus on Aug 25 2020, 5:18 AM.

Details

Summary

Late as always, but it seems like not too late :) I tried to add everyone who contributed to the static analyzer in a meaningful way, but if you did and don't find yourself on the reviewer list, please add yourself! I compiled these notes from the following list:

git log llvmorg-11-init..llvmorg-11.0.0-rc2 --oneline -- clang/lib/StaticAnalyzer/ clang/include/clang/StaticAnalyzer/

Seems like this is a release to be proud of!

Diff Detail

Event Timeline

Szelethus created this revision.Aug 25 2020, 5:18 AM
Szelethus added a comment.EditedAug 25 2020, 5:23 AM

@vsavchenko I just realized a significant portion of your work for this release is the following list:

git log llvmorg-11-init..llvmorg-11.0.0-rc2 --oneline -- clang/utils/analyzer/

Is it a correct guess that while your primary audience are the analyzer developers, it wouldn't hurt to mention it in the release notes?

martong added inline comments.Aug 25 2020, 5:35 AM
clang/docs/ReleaseNotes.rst
473

Umm, this is still an alpha command line option, plus we improved only the pre-condition checks.
So, I'd rather say something like:

Improve the pre-condition modeling of several functions defined in the POSIX standard. This is in alpha currently. To enable, one must explicitly set the ``ModelPOSIX`` argument of the ``apiModeling.StdCLibraryFunctions`` checker.

Some grammatical fixes and suggestions, inline. I might have absolutely butchered 80-col in the suggestions (thanks Phab for not showing any indication of line length...), so make sure you manually reformat the document before going forward!

clang/docs/ReleaseNotes.rst
448–449
452–453
460–461

The phrasing is incredibly convoluted here, let's put the positive part of the rule that is enforced first.

466

This is a core change, right? How is this list ordered? Perhaps there should be a sort by category, first the core changes, then the individual checkers' improvements.

473–474

Maybe it's worth mentioning the checker here too, akin to the other list elements?

482

Typo.

482–483
483

Typo.

489–490
492–493

What's the proper way of naming this feature, @martong @dkrupp @xazax.hun? Is it like this, or should it be in capitals, or should it be cross-translation unit?

whisperity added inline comments.Aug 25 2020, 5:46 AM
clang/docs/ReleaseNotes.rst
439–441

... here.

512

@Szelethus Speaking of labels in the dependency patch D86532, there is no label for the CSA changeset...

martong added inline comments.Aug 25 2020, 5:58 AM
clang/docs/ReleaseNotes.rst
492–493

I suppose cross-translation is the grammatically correct (?). We tend to refer to the feature, however, with all capitals: Cross Translation Unit. This way the CTU abbreviation is immediate.
Perhaps we should write then Cross Translation Unit (CTU) analysis to be the most precise.

@vsavchenko I just realized a significant portion of your work for this release is the following list:

git log llvmorg-11-init..llvmorg-11.0.0-rc2 --oneline -- clang/utils/analyzer/

Is it a correct guess that while your primary audience are the analyzer developers, it wouldn't hurt to mention it in the release notes?

Sure, I think that we can mention that there is a beta-version of the dockerized testing system.

On the other note, a huge portion of my work is related to the solver, like b13d9878b8dc and e63b488f2755. I think it can be mentioned in the notes.
Also, 239c53b72b18 might be pretty important for our Obj-C users.

Szelethus updated this revision to Diff 287930.Aug 26 2020, 4:59 AM
Szelethus marked 14 inline comments as done.

Fixes according to reviewer comments!

clang/docs/ReleaseNotes.rst
473

I don't believe in advertising development only options much, especially that we don't expect, nor want non-developers to interact with apiModeling stuff often. :/ I ended up removing the entry as such, if you don't mind.

473–474

We don't want users to tinker with developer-only checkers.

512

It is only important if you want to use that label -- in fact, this is the only one in the entire file :^)

martong accepted this revision.Aug 26 2020, 5:08 AM

LGTM! (At least those changes that involved me, perhaps it is better to wait for more LGs.)

clang/docs/ReleaseNotes.rst
473

OK, fair enough.

This revision is now accepted and ready to land.Aug 26 2020, 5:08 AM
whisperity added inline comments.Aug 26 2020, 5:25 AM
clang/docs/ReleaseNotes.rst
509

Let's put this into monospace font too. Otherwise LGTM from a readability standpoint.

steakhal added inline comments.Aug 26 2020, 5:30 AM
clang/docs/ReleaseNotes.rst
487

Unfortunately, my taint related patched not upstreamed yet. So you should not mention that IMO.

I'd prefer to have a couple more green lights. In particular, another look on the constraint manager and Objective C stuff would be great.

clang/docs/ReleaseNotes.rst
487

I definitely saw some patches that did land.

vsavchenko accepted this revision.Tue, Sep 1, 1:37 AM

I'd prefer to have a couple more green lights. In particular, another look on the constraint manager and Objective C stuff would be great.

Those parts are good IMO.

Szelethus edited the summary of this revision. (Show Details)Tue, Sep 1, 1:49 AM
ASDenysPetrov added inline comments.Tue, Sep 1, 7:54 AM
clang/docs/ReleaseNotes.rst
453

I've added the patch "Reasoning about comparison expressions in RangeConstraintManager". You can mention that as well.

Szelethus updated this revision to Diff 290280.Mon, Sep 7, 6:46 AM
Szelethus marked 4 inline comments as done.

Added a line about D78933.

clang/docs/ReleaseNotes.rst
453

I added the line you mentioned -- do you like how the notes look now?

hans accepted this revision.Tue, Sep 15, 6:49 AM

This has probably had enough time for review. Please commit.

Sorry for the slack (which is kind of ironic with my attention grabbing title :) ). Landed in rG791b7e9f73e0064153a7c3db8045a7333a8c390c. Thanks everyone!

Szelethus closed this revision.Tue, Sep 15, 7:52 AM
hans added a comment.Tue, Sep 15, 7:53 AM

No worries :) Thanks for the notes!