[all-commits] [llvm/llvm-project] f702a6: Thread safety analysis: Improve documentation for ...

[Russell Yanofsky via All-commits]

  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: f702a6fa7c9e4c0e2871b3d6657ce4dfa525ce52
      https://github.com/llvm/llvm-project/commit/f702a6fa7c9e4c0e2871b3d6657ce4dfa525ce52
  Author: Russell Yanofsky <russ at yanofsky.org>
  Date:   2020-09-26 (Sat, 26 Sep 2020)

  Changed paths:
    M clang/docs/ThreadSafetyAnalysis.rst

  Log Message:
  -----------
  Thread safety analysis: Improve documentation for ASSERT_CAPABILITY

Previous description didn't actually state the effect the attribute has on
thread safety analysis (causing analysis to assume the capability is held).

Previous description was also ambiguous about (or slightly overstated) the
noreturn assumption made by thread safety analysis, implying the assumption had
to be true about the function's behavior in general, and not just its behavior
in places where it's used. Stating the assumption specifically should avoid a
perceived need to disable thread safety analysis in places where only asserting
that a specific capability is held would be better.

Reviewed By: aaronpuchert, vasild

Differential Revision: https://reviews.llvm.org/D87629