[all-commits] [llvm/llvm-project] d2e4aa: [clang][dataflow][NFC] Fix comments related to wid...

[Yitzhak Mandelbaum via All-commits]

  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: d2e4aaf6ac3bc7c72a81f050512afa17a9ceb54b
      https://github.com/llvm/llvm-project/commit/d2e4aaf6ac3bc7c72a81f050512afa17a9ceb54b
  Author: Yitzhak Mandelbaum <yitzhakm at google.com>
  Date:   2022-12-19 (Mon, 19 Dec 2022)

  Changed paths:
    M clang/include/clang/Analysis/FlowSensitive/DataflowEnvironment.h
    M clang/lib/Analysis/FlowSensitive/DataflowEnvironment.cpp

  Log Message:
  -----------
  [clang][dataflow][NFC] Fix comments related to widening.

The comments describing the API for analysis `widen` and the environment `widen`
were overly strict in the preconditions they assumed for the operation. In
particular, both assumed that the previous value preceded the current value in
the relevant ordering. However, that's not generally how widen operators work
and widening itself can violate this property. That is, when the previous value
is the result of a widening, it can easily be "greater" than the current value.

This patch updates the comments to accurately reflect the expectations.

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